org.forgerock.http.servlet

Class HttpFrameworkServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.forgerock.http.servlet.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 and Description
DescribableHandler	handler
static String	ROUTING_BASE_INIT_PARAM_NAME Servlet init-param for configuring the routing base for the HttpApplication.

Constructor Summary

Constructors

Constructor and Description
HttpFrameworkServlet() Default constructor for use via web.xml declaration.
HttpFrameworkServlet(HttpApplication application) Creates a new HttpFrameworkServlet programmatically using the specified HttpApplication.

Method Summary

Modifier and Type	Method and Description
static ClientContext	createClientContext(Context parent, javax.servlet.http.HttpServletRequest req)
Request	createRequest(javax.servlet.http.HttpServletRequest req)
UriRouterContext	createRouterContext(Context parent, javax.servlet.http.HttpServletRequest req, Request request)
void	destroy()
static HttpFrameworkServlet	getGatewayHttpFrameworkServlet()
static DescribableHandler	getRootHandler()
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

Methods inherited from class java.lang.Object

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

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

handler

public DescribableHandler handler

Constructor Detail

HttpFrameworkServlet

public HttpFrameworkServlet()

Default constructor for use via web.xml declaration.

HttpFrameworkServlet

public HttpFrameworkServlet(HttpApplication application)

Creates a new HttpFrameworkServlet programmatically using the specified HttpApplication.

Parameters:

application - The HttpApplication instance.

Method Detail

getGatewayHttpFrameworkServlet

public static HttpFrameworkServlet getGatewayHttpFrameworkServlet()

getRootHandler

public static DescribableHandler getRootHandler()

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

createRequest

public Request createRequest(javax.servlet.http.HttpServletRequest req)
                      throws IOException,
                             URISyntaxException

Throws:

IOException

URISyntaxException

createClientContext

public static ClientContext createClientContext(Context parent,
                                                javax.servlet.http.HttpServletRequest req)

createRouterContext

public UriRouterContext createRouterContext(Context parent,
                                            javax.servlet.http.HttpServletRequest req,
                                            Request request)
                                     throws URISyntaxException

Throws:

URISyntaxException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet