Package org.glassfish.grizzly.servlet

Class ServletHandler

java.lang.Object

org.glassfish.grizzly.http.server.HttpHandler

org.glassfish.grizzly.servlet.ServletHandler

public class ServletHandler
extends HttpHandler

HttpHandler implementation that provides an entry point for processing a Servlet request.

Author:

Jeanfrancois Arcand

Field Summary

Fields

Modifier and Type	Field	Description
protected ClassLoader	classLoader
protected ExpectationHandler	expectationHandler
protected FilterChainFactory	filterChainFactory
protected boolean	initialize	Initialize the ServletContext
protected final Map<String,Object>	properties	Holder for our configured properties.
protected Class<? extends Servlet>	servletClass
protected String	servletClassName
protected Servlet	servletInstance

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServletHandler(ServletConfigImpl servletConfig)

Method Summary

Modifier and Type	Method	Description
protected void	configureServletEnv()	Configure the WebappContext and ServletConfigImpl
void	customizeErrorPage(Response response, String message, int errorCode, Throwable t)	Customize the error page returned to the client.
void	destroy()	Destroy this Servlet and its associated ServletContextListener
protected void	doServletService(Request request, Response response)
ClassLoader	getClassLoader()
String	getContextPath()	Returns the portion of the request URI that indicates the context of the request.
ExpectationHandler	getExpectationHandler()	Get the ExpectationHandler responsible for processing Expect: header (for example "Expect: 100-Continue").
protected FilterChainInvoker	getFilterChain(Request request)
String	getName()	Get the HttpHandler name.
ServletConfigImpl	getServletConfig()
protected WebappContext	getServletCtx()
Servlet	getServletInstance()	Return the Servlet instance used by this ServletHandler
protected String	getSessionCookieName()	Overrides default (JSESSIONID) session cookie name.
protected SessionManager	getSessionManager(Request request)
protected void	loadServlet()	Load a Servlet instance.
protected boolean	sendAcknowledgment(Request request, Response response)	Override parent's HttpHandler.sendAcknowledgment(org.glassfish.grizzly.http.server.Request, org.glassfish.grizzly.http.server.Response) to let ExpectationHandler (if one is registered) process the expectation.
void	service(Request request, Response response)	This method should contain the logic for any HTTP extension to the Grizzly HTTP web server.
void	setClassLoader(ClassLoader classLoader)
void	setContextPath(String contextPath)	Programmatically set the context path of the Servlet.
protected void	setDispatcherHelper(DispatcherHelper dispatcherHelper)
void	setExpectationHandler(ExpectationHandler expectationHandler)	Set the ExpectationHandler responsible for processing Expect: header (for example "Expect: 100-Continue").
protected void	setFilterChainFactory(FilterChainFactory filterChainFactory)
protected void	setPathData(Request from, HttpServletRequestImpl to)
protected void	setServletClass(Class<? extends Servlet> servletClass)
protected void	setServletClassName(String servletClassName)
protected void	setServletInstance(Servlet servletInstance)	Set the Servlet instance used by this ServletHandler
protected void	setSessionManager(SessionManager sessionManager)	Set the SessionManager instance used by this ServletHandler
void	start()	Called when the HttpHandler's container is started by invoking HttpServer.start().

Methods inherited from class org.glassfish.grizzly.http.server.HttpHandler

getErrorPageGenerator, getRequestExecutorProvider, getRequestURIEncoding, isAllowCustomStatusMessage, isAllowEncodedSlash, setAllowCustomStatusMessage, setAllowEncodedSlash, setDecodeUrl, setRequestURIEncoding, setRequestURIEncoding, updatePaths

Methods inherited from class java.lang.Object

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

Field Details

servletClassName

protected String servletClassName

servletClass

protected Class<? extends Servlet> servletClass

servletInstance

protected volatile Servlet servletInstance

properties

protected final Map<String,Object> properties

Holder for our configured properties.

initialize

protected boolean initialize

Initialize the ServletContext

classLoader

protected ClassLoader classLoader

expectationHandler

protected ExpectationHandler expectationHandler

filterChainFactory

protected FilterChainFactory filterChainFactory

Constructor Details

ServletHandler

protected ServletHandler(ServletConfigImpl servletConfig)

Method Details

start

public void start()

Called when the HttpHandler's container is started by invoking HttpServer.start(). By default, it does nothing.

Overrides:

start in class HttpHandler

sendAcknowledgment

protected boolean sendAcknowledgment(Request request,
 Response response)
                              throws IOException

Override parent's HttpHandler.sendAcknowledgment(org.glassfish.grizzly.http.server.Request, org.glassfish.grizzly.http.server.Response) to let ExpectationHandler (if one is registered) process the expectation.

Overrides:

sendAcknowledgment in class HttpHandler

Parameters:

request - the Request.

response - the Response.

Returns:

true if request processing should continue after acknowledgment of the expectation, otherwise return false.

Throws:

IOException - if an error occurs sending the acknowledgment.

service

public void service(Request request,
 Response response)
             throws Exception

This method should contain the logic for any HTTP extension to the Grizzly HTTP web server.

Specified by:

service in class HttpHandler

Parameters:

request - The Request

response - The Response

Throws:

Exception

doServletService

protected void doServletService(Request request,
 Response response)

getFilterChain

protected FilterChainInvoker getFilterChain(Request request)

setPathData

protected void setPathData(Request from,
 HttpServletRequestImpl to)

customizeErrorPage

public void customizeErrorPage(Response response,
 String message,
 int errorCode,
 Throwable t)

Customize the error page returned to the client.

Parameters:

response - the Response

message - the HTTP error message

errorCode - the error code.

loadServlet

protected void loadServlet()
                    throws ServletException

Load a Servlet instance.

Throws:

ServletException - If failed to Servlet.init(jakarta.servlet.ServletConfig).

configureServletEnv

protected void configureServletEnv()
                            throws ServletException

Configure the WebappContext and ServletConfigImpl

Throws:

ServletException - Error while configuring Servlet.

getServletInstance

public Servlet getServletInstance()

Return the Servlet instance used by this ServletHandler

Returns:

Servlet instance.

setServletInstance

protected void setServletInstance(Servlet servletInstance)

Set the Servlet instance used by this ServletHandler

Parameters:

servletInstance - an instance of Servlet.

setServletClassName

protected void setServletClassName(String servletClassName)

setServletClass

protected void setServletClass(Class<? extends Servlet> servletClass)

setSessionManager

protected void setSessionManager(SessionManager sessionManager)

Set the SessionManager instance used by this ServletHandler

Parameters:

sessionManager - an implementation of SessionManager.

getContextPath

public String getContextPath()

Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string.

It is possible that a servlet container may match a context by more than one context path. In such cases this method will return the actual context path used by the request and it may differ from the path returned by the ServletContext.getContextPath() method. The context path returned by ServletContext.getContextPath() should be considered as the prime or preferred context path of the application.

Returns:

a String specifying the portion of the request URI that indicates the context of the request

See Also:

• ServletContext.getContextPath()

setContextPath

public void setContextPath(String contextPath)

Programmatically set the context path of the Servlet.

Parameters:

contextPath - Context path.

destroy

public void destroy()

Destroy this Servlet and its associated ServletContextListener

Overrides:

destroy in class HttpHandler

getServletCtx

protected WebappContext getServletCtx()

getClassLoader

public ClassLoader getClassLoader()

setClassLoader

public void setClassLoader(ClassLoader classLoader)

getServletConfig

public ServletConfigImpl getServletConfig()

getName

public String getName()

Description copied from class: HttpHandler

Get the HttpHandler name.

Overrides:

getName in class HttpHandler

Returns:

the HttpHandler name.

getExpectationHandler

public ExpectationHandler getExpectationHandler()

Get the ExpectationHandler responsible for processing Expect: header (for example "Expect: 100-Continue").

Returns:

the ExpectationHandler responsible for processing Expect: header (for example "Expect: 100-Continue").

setExpectationHandler

public void setExpectationHandler(ExpectationHandler expectationHandler)

Set the ExpectationHandler responsible for processing Expect: header (for example "Expect: 100-Continue").

Parameters:

expectationHandler - the ExpectationHandler responsible for processing Expect: header (for example "Expect: 100-Continue").

setDispatcherHelper

protected void setDispatcherHelper(DispatcherHelper dispatcherHelper)

Overrides:

setDispatcherHelper in class HttpHandler

setFilterChainFactory

protected void setFilterChainFactory(FilterChainFactory filterChainFactory)

getSessionCookieName

protected String getSessionCookieName()

Overrides default (JSESSIONID) session cookie name.

Overrides:

getSessionCookieName in class HttpHandler

Returns:

the session cookie name

getSessionManager

protected SessionManager getSessionManager(Request request)

Overrides:

getSessionManager in class HttpHandler

Parameters:

request - Request

Returns:

Servlet-aware SessionManager