Package org.forgerock.http.servlet

Class HttpFrameworkServlet

  • All Implemented Interfaces:
    Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
    public final class HttpFrameworkServlet
extends javax.servlet.http.HttpServlet

    An HTTP servlet implementation which provides integration between the Servlet API and the common HTTP Framework.

    A HttpApplication implementation must be registered in the ServiceLoader framework

    See Also:
    HttpApplication, Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String ROUTING_BASE_INIT_PARAM_NAME
      Servlet init-param for configuring the routing base for the HttpApplication.

    • Constructor Summary

      Constructors 
      Constructor Description
      HttpFrameworkServlet()
      Default constructor for use via web.xml declaration.
      HttpFrameworkServlet​(org.forgerock.http.HttpApplication application)
      Creates a new HttpFrameworkServlet programmatically using the specified HttpApplication.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void destroy()  
      void init()  
      protected void service​(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)  

      • 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

    • Field Detail

      • ROUTING_BASE_INIT_PARAM_NAME

        public static final String ROUTING_BASE_INIT_PARAM_NAME
        Servlet init-param for configuring the routing base for the HttpApplication.
        See Also:
        ServletRoutingBase, Constant Field Values

    • Constructor Detail

      • HttpFrameworkServlet

        public HttpFrameworkServlet()
        Default constructor for use via web.xml declaration.

      • HttpFrameworkServlet

        public HttpFrameworkServlet​(org.forgerock.http.HttpApplication application)
        Creates a new HttpFrameworkServlet programmatically using the specified HttpApplication.
        Parameters:
        application - The HttpApplication instance.

    • Method Detail

      • init

        public void init()
          throws javax.servlet.ServletException
        Overrides:
        init in class javax.servlet.GenericServlet
        Throws:
        javax.servlet.ServletException

      • 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

      • destroy

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