Package org.codice.ui.admin.docs

Class SparkServlet

java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
org.codice.ui.admin.docs.SparkServlet
All Implemented Interfaces:
Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
public class SparkServlet extends javax.servlet.http.HttpServlet
Servlet that can be configured through a web.xml to serve SparkApplications. Needs to be initialized with the applicationName init parameter (or through a direct call to setSparkApplications(List)) to the list of application classes defining routes. An optional wrapperSupplierName parameter can be provided (or directly set through the setRequestSupplier(BiFunction) method) to provide added path flexibility.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    SparkServlet()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    destroy()
     
    void
    init(javax.servlet.ServletConfig config)
     
    protected void
    service(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
     
    void
    setFilterMappingPattern(String filterMappingPattern)
     
    void
    setRequestSupplier(BiFunction<javax.servlet.http.HttpServletRequest,String,javax.servlet.http.HttpServletRequestWrapper> requestSupplier)
     
    void
    setSparkApplications(List<spark.servlet.SparkApplication> sparkApplications)
     

    Methods inherited from class javax.servlet.http.HttpServlet

    doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

    Methods inherited from class javax.servlet.GenericServlet

    getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SparkServlet

      public SparkServlet()

  • Method Details

    • setRequestSupplier

      public void setRequestSupplier(BiFunction<javax.servlet.http.HttpServletRequest,String,javax.servlet.http.HttpServletRequestWrapper> requestSupplier)

    • setSparkApplications

      public void setSparkApplications(List<spark.servlet.SparkApplication> sparkApplications)

    • setFilterMappingPattern

      public void setFilterMappingPattern(String filterMappingPattern)

    • init

      public void init(javax.servlet.ServletConfig config) throws javax.servlet.ServletException
      Specified by:
      init in interface javax.servlet.Servlet
      Overrides:
      init in class javax.servlet.GenericServlet
      Throws:
      javax.servlet.ServletException

    • destroy

      public void destroy()
      Specified by:
      destroy in interface javax.servlet.Servlet
      Overrides:
      destroy in class javax.servlet.GenericServlet

    • service

      protected void service(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) throws javax.servlet.ServletException, IOException
      Overrides:
      service in class javax.servlet.http.HttpServlet
      Throws:
      javax.servlet.ServletException
      IOException