Modifier and Type	Class and Description
pack-priv static class	ServletHandler.AckActionImpl
pack-priv static class	ServletHandler.ServletAfterServiceListener AfterServiceListener, which is responsible for recycle servlet request and response objects.

Modifier and Type	Field and Description
protected ClassLoader	classLoader
private String	contextPath
protected ExpectationHandler	expectationHandler
protected FilterChainFactory	filterChainFactory
protected boolean	initialize Initialize the `ServletContext`
private final Object	lock
private static final Logger	LOGGER Hides org.glassfish.grizzly.http.server.HttpHandler.LOGGER.
private List<Runnable>	onDestroyListeners
protected final Map<String, Object>	properties Holder for our configured properties.
pack-priv static final Note<HttpServletRequestImpl>	SERVLET_REQUEST_NOTE
pack-priv static final Note<HttpServletResponseImpl>	SERVLET_RESPONSE_NOTE
pack-priv static final ServletHandler.ServletAfterServiceListener	servletAfterServiceListener
protected Class<? extends Servlet>	servletClass
protected String	servletClassName
private final ServletConfigImpl	servletConfig The `ServletConfigImpl`
private final WebappContext	servletCtx The `WebappContext`
protected volatile Servlet	servletInstance
private SessionManager	sessionManager The `SessionManager`

Access	Constructor and Description
protected	ServletHandler(final ServletConfigImpl servletConfig)

Method Summary

Modifier and Type	Method and Description
pack-priv void	addOnDestroyListener(final Runnable `Runnable`, which contains destroy listener logic. r) Adds the `Runnable`, which will be invoked when `destroy()` is called.
protected void	configureServletEnv() Configure the `WebappContext` and `ServletConfigImpl`
public void	customizeErrorPage(final Response the `Response` response, final String the HTTP error message message, final int the error code. errorCode, final Throwable t) Customize the error page returned to the client.
public void	destroy() Overrides org.glassfish.grizzly.http.server.HttpHandler.destroy. Destroy this Servlet and its associated `jakarta.servlet.ServletContextListener`
protected void	doServletService(final Request request, final Response response)
pack-priv void	doServletService(final ServletRequest servletRequest, final ServletResponse servletResponse, final DispatcherType dispatcherType)
public ClassLoader	getClassLoader()
private String	Returns: The combined path with pathInfo appended to servletInfo getCombinedPath(final HttpServletRequest request) Combines the servletPath and the pathInfo.
public String	Returns: a `String` specifying the portion of the request URI that indicates the context of the request getContextPath() Returns the portion of the request URI that indicates the context of the request.
public ExpectationHandler	Returns: the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue"). getExpectationHandler() Get the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue").
protected FilterChainInvoker	getFilterChain(Request request)
public String	getName() Overrides org.glassfish.grizzly.http.server.HttpHandler.getName. Get the `HttpHandler` name.
public ServletConfigImpl	getServletConfig()
protected WebappContext	getServletCtx()
public Servlet	Returns: `Servlet` instance. getServletInstance() Return the `Servlet` instance used by this `ServletHandler`
pack-priv static HttpServletRequestImpl	getServletRequest(final Request request)
pack-priv static HttpServletResponseImpl	getServletResponse(final Request request)
protected String	Returns: the session cookie name getSessionCookieName() Overrides org.glassfish.grizzly.http.server.HttpHandler.getSessionCookieName. Overrides default (JSESSIONID) session cookie name.
protected SessionManager	getSessionManager(Request request) Overrides org.glassfish.grizzly.http.server.HttpHandler.getSessionManager. Returns: Servlet-aware `SessionManager`
protected void	loadServlet() Load a `Servlet` instance.
protected boolean	sendAcknowledgment(Request request, Response response) Overrides org.glassfish.grizzly.http.server.HttpHandler.sendAcknowledgment. 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.
public void	service(Request request, Response response) Implements abstract org.glassfish.grizzly.http.server.HttpHandler.service. This method should contain the logic for any HTTP extension to the Grizzly HTTP web server.
public void	setClassLoader(ClassLoader classLoader)
public void	setContextPath(String Context path. contextPath) Programmatically set the context path of the Servlet.
protected void	setDispatcherHelper(final DispatcherHelper dispatcherHelper) Overrides org.glassfish.grizzly.http.server.HttpHandler.setDispatcherHelper.
private void	setDispatcherPath(final Request request, final String path)
public void	setExpectationHandler(ExpectationHandler the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue"). expectationHandler) Set the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue").
protected void	setFilterChainFactory(final FilterChainFactory filterChainFactory)
protected void	setPathData(final Request from, final HttpServletRequestImpl to)
protected void	setServletClass(final Class<? extends Servlet> servletClass)
protected void	setServletClassName(final String servletClassName)
protected void	setServletInstance(Servlet an instance of Servlet. servletInstance) Set the `Servlet` instance used by this `ServletHandler`
protected void	setSessionManager(SessionManager an implementation of SessionManager. sessionManager) Set the `SessionManager` instance used by this `ServletHandler`
public void	start() Overrides org.glassfish.grizzly.http.server.HttpHandler.start. Called when the `HttpHandler`'s container is started by invoking `HttpServer#start`.

Inherited from org.glassfish.grizzly.http.server.HttpHandler:: getErrorPageGenerator getRequestExecutorProvider getRequestURIEncoding isAllowCustomStatusMessage isAllowEncodedSlash setAllowCustomStatusMessage setAllowEncodedSlash setDecodeUrl setRequestURIEncoding setRequestURIEncoding updatePaths

Field Detail

classLoader	back to summary
protected ClassLoader classLoader

contextPath	back to summary
private String contextPath

expectationHandler	back to summary
protected ExpectationHandler expectationHandler

filterChainFactory	back to summary
protected FilterChainFactory filterChainFactory

initialize	back to summary
protected boolean initialize Initialize the `ServletContext`

lock	back to summary
private final Object lock

LOGGER	back to summary
private static final Logger LOGGER Hides org.glassfish.grizzly.http.server.HttpHandler.LOGGER.

onDestroyListeners	back to summary
private List<Runnable> onDestroyListeners

properties	back to summary
protected final Map<String, Object> properties Holder for our configured properties.

SERVLET_REQUEST_NOTE	back to summary
pack-priv static final Note<HttpServletRequestImpl> SERVLET_REQUEST_NOTE

SERVLET_RESPONSE_NOTE	back to summary
pack-priv static final Note<HttpServletResponseImpl> SERVLET_RESPONSE_NOTE

servletAfterServiceListener	back to summary
pack-priv static final ServletHandler.ServletAfterServiceListener servletAfterServiceListener

servletClass	back to summary
protected Class<? extends Servlet> servletClass

servletClassName	back to summary
protected String servletClassName

servletConfig	back to summary
private final ServletConfigImpl servletConfig The `ServletConfigImpl`

servletCtx	back to summary
private final WebappContext servletCtx The `WebappContext`

servletInstance	back to summary
protected volatile Servlet servletInstance

sessionManager	back to summary
private SessionManager sessionManager The `SessionManager`

Constructor Detail

ServletHandler	back to summary
protected ServletHandler(final ServletConfigImpl servletConfig)

Method Detail

addOnDestroyListener back to summary

addOnDestroyListener	back to summary
pack-priv void addOnDestroyListener(final Runnable r) Adds the `Runnable`, which will be invoked when `destroy()` is called. Parameters r:Runnable `Runnable`, which contains destroy listener logic.

pack-priv void addOnDestroyListener(final Runnable r)

Adds the Runnable, which will be invoked when destroy() is called.

Parameters

r:Runnable: Runnable, which contains destroy listener logic.

configureServletEnv back to summary

configureServletEnv	back to summary
protected void configureServletEnv() throws ServletException Configure the `WebappContext` and `ServletConfigImpl` Exceptions ServletException: Error while configuring `Servlet`.

protected void configureServletEnv() throws ServletException

Configure the WebappContext and ServletConfigImpl

Exceptions

ServletException:: Error while configuring Servlet.

customizeErrorPage back to summary

customizeErrorPage	back to summary
public void customizeErrorPage(final Response response, final String message, final int errorCode, final Throwable t) Customize the error page returned to the client. Parameters response:Response the `Response` message:String the HTTP error message errorCode:int the error code.

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

Customize the error page returned to the client.

Parameters

response:Response: the Response
message:String: the HTTP error message
errorCode:int: the error code.

destroy back to summary

destroy	back to summary
public void destroy() Overrides org.glassfish.grizzly.http.server.HttpHandler.destroy. Destroy this Servlet and its associated `jakarta.servlet.ServletContextListener` Annotations @Override

public void destroy()

Overrides org.glassfish.grizzly.http.server.HttpHandler.destroy.

Destroy this Servlet and its associated jakarta.servlet.ServletContextListener

Annotations

@Override

doServletService	back to summary
protected void doServletService(final Request request, final Response response)

doServletService	back to summary
pack-priv void doServletService(final ServletRequest servletRequest, final ServletResponse servletResponse, final DispatcherType dispatcherType) throws IOException, ServletException

getClassLoader	back to summary
public ClassLoader getClassLoader()

getCombinedPath back to summary

getCombinedPath	back to summary
private String getCombinedPath(final HttpServletRequest request) Combines the servletPath and the pathInfo. If pathInfo is `null`, it is ignored. If servletPath is `null`, then `null` is returned. Returns:String The combined path with pathInfo appended to servletInfo

private String getCombinedPath(final HttpServletRequest request)

Combines the servletPath and the pathInfo. If pathInfo is null, it is ignored. If servletPath is null, then null is returned.

Returns:String: The combined path with pathInfo appended to servletInfo

getContextPath back to summary

getContextPath	back to summary
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 `jakarta.servlet.ServletContext#getContextPath()` method. The context path returned by `jakarta.servlet.ServletContext#getContextPath()` should be considered as the prime or preferred context path of the application. Returns:String a `String` specifying the portion of the request URI that indicates the context of the request See Also `jakarta.servlet.ServletContext#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 jakarta.servlet.ServletContext#getContextPath() method. The context path returned by jakarta.servlet.ServletContext#getContextPath() should be considered as the prime or preferred context path of the application.

Returns:String: a String specifying the portion of the request URI that indicates the context of the request
See Also: jakarta.servlet.ServletContext#getContextPath()

getExpectationHandler back to summary

getExpectationHandler	back to summary
public ExpectationHandler getExpectationHandler() Get the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue"). Returns:ExpectationHandler the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue").

public ExpectationHandler getExpectationHandler()

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

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

getFilterChain	back to summary
protected FilterChainInvoker getFilterChain(Request request)

getName back to summary

getName	back to summary
public String getName() Overrides org.glassfish.grizzly.http.server.HttpHandler.getName. Doc from org.glassfish.grizzly.http.server.HttpHandler.getName. Get the `HttpHandler` name. Annotations @Override

public String getName()

Overrides org.glassfish.grizzly.http.server.HttpHandler.getName.

Doc from org.glassfish.grizzly.http.server.HttpHandler.getName.

Get the HttpHandler name.

Annotations

@Override

getServletConfig	back to summary
public ServletConfigImpl getServletConfig()

getServletCtx	back to summary
protected WebappContext getServletCtx()

getServletInstance back to summary

getServletInstance	back to summary
public Servlet getServletInstance() Return the `Servlet` instance used by this `ServletHandler` Returns:Servlet `Servlet` instance. Annotations @SuppressWarnings:UnusedDeclaration

public Servlet getServletInstance()

Return the Servlet instance used by this ServletHandler

Returns:Servlet

Servlet instance.

Annotations

@SuppressWarnings:UnusedDeclaration

getServletRequest	back to summary
pack-priv static HttpServletRequestImpl getServletRequest(final Request request)

getServletResponse	back to summary
pack-priv static HttpServletResponseImpl getServletResponse(final Request request)

getSessionCookieName

back to summary

protected String getSessionCookieName()

Overrides org.glassfish.grizzly.http.server.HttpHandler.getSessionCookieName.

Overrides default (JSESSIONID) session cookie name.

Returns:String

the session cookie name

Annotations

@Override

getSessionManager back to summary

getSessionManager	back to summary
protected SessionManager getSessionManager(Request request) Overrides org.glassfish.grizzly.http.server.HttpHandler.getSessionManager. Returns:SessionManager Servlet-aware `SessionManager` Annotations @Override

protected SessionManager getSessionManager(Request request)

Overrides org.glassfish.grizzly.http.server.HttpHandler.getSessionManager.

Returns:SessionManager

Servlet-aware SessionManager

Annotations

@Override

loadServlet back to summary

loadServlet	back to summary
protected void loadServlet() throws ServletException Load a `Servlet` instance. Exceptions ServletException: If failed to `Servlet#init(jakarta.servlet.ServletConfig)`.

protected void loadServlet() throws ServletException

Load a Servlet instance.

Exceptions

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

sendAcknowledgment back to summary

sendAcknowledgment	back to summary
protected boolean sendAcknowledgment(Request request, Response response) throws IOException Overrides org.glassfish.grizzly.http.server.HttpHandler.sendAcknowledgment. 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. Annotations @Override Exceptions IOException: Doc from org.glassfish.grizzly.http.server.HttpHandler.sendAcknowledgment. if an error occurs sending the acknowledgment.

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

Overrides org.glassfish.grizzly.http.server.HttpHandler.sendAcknowledgment.

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.

Annotations

@Override

Exceptions

IOException:

Doc from org.glassfish.grizzly.http.server.HttpHandler.sendAcknowledgment.

if an error occurs sending the acknowledgment.

service	back to summary
public void service(Request request, Response response) throws Exception Implements abstract org.glassfish.grizzly.http.server.HttpHandler.service. Doc from org.glassfish.grizzly.http.server.HttpHandler.service. This method should contain the logic for any HTTP extension to the Grizzly HTTP web server. Annotations @Override

service

back to summary

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

Implements abstract org.glassfish.grizzly.http.server.HttpHandler.service.

Doc from org.glassfish.grizzly.http.server.HttpHandler.service.

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

Annotations

@Override

setClassLoader	back to summary
public void setClassLoader(ClassLoader classLoader)

setContextPath	back to summary
public void setContextPath(String contextPath) Programmatically set the context path of the Servlet. Parameters contextPath:String Context path.

setContextPath

back to summary

public void setContextPath(String contextPath)

Programmatically set the context path of the Servlet.

Parameters

contextPath:String: Context path.

setDispatcherHelper	back to summary
protected void setDispatcherHelper(final DispatcherHelper dispatcherHelper) Overrides org.glassfish.grizzly.http.server.HttpHandler.setDispatcherHelper. Annotations @Override

setDispatcherHelper

back to summary

protected void setDispatcherHelper(final DispatcherHelper dispatcherHelper)

Overrides org.glassfish.grizzly.http.server.HttpHandler.setDispatcherHelper.

Annotations

@Override

setDispatcherPath	back to summary
private void setDispatcherPath(final Request request, final String path)

setExpectationHandler back to summary

setExpectationHandler	back to summary
public void setExpectationHandler(ExpectationHandler expectationHandler) Set the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue"). Parameters expectationHandler:ExpectationHandler the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue").

public void setExpectationHandler(ExpectationHandler expectationHandler)

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

Parameters

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

setFilterChainFactory	back to summary
protected void setFilterChainFactory(final FilterChainFactory filterChainFactory)

setPathData	back to summary
protected void setPathData(final Request from, final HttpServletRequestImpl to)

setServletClass	back to summary
protected void setServletClass(final Class<? extends Servlet> servletClass)

setServletClassName	back to summary
protected void setServletClassName(final String servletClassName)

setServletInstance back to summary

protected void setServletInstance(Servlet servletInstance)

Set the Servlet instance used by this ServletHandler

Parameters

servletInstance:Servlet: an instance of Servlet.

setSessionManager back to summary

protected void setSessionManager(SessionManager sessionManager)

Set the SessionManager instance used by this ServletHandler

Parameters

sessionManager:SessionManager: an implementation of SessionManager.

start back to summary

public void start()

Overrides org.glassfish.grizzly.http.server.HttpHandler.start.

Doc from org.glassfish.grizzly.http.server.HttpHandler.start.

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

Annotations

@Override

org.glassfish.grizzly.servlet back to summary

pack-priv final Class ServletHandler.AckActionImpl

Class Inheritance

extends Object
implements AckAction

java.lang.Object
org.glassfish.grizzly.servlet.ServletHandler.AckActionImpl

All Implemented Interfaces

org.glassfish.grizzly.servlet.ExpectationHandler.AckAction

Field Summary

Modifier and Type	Field and Description
private boolean	isAcknowledged
private boolean	isFailAcknowledgement
private final Response	response

Constructor Summary

Access	Constructor and Description
private	AckActionImpl(final Response response)

Method Summary

Modifier and Type	Method and Description
public void	acknowledge() Implements org.glassfish.grizzly.servlet.ExpectationHandler.AckAction.acknowledge. Acknowledges a client that server wants to receive payload.
public void	fail() Implements org.glassfish.grizzly.servlet.ExpectationHandler.AckAction.fail. Notifies a client that server doesn't want to process HTTP message payload.
public boolean	isAcknowledged()
public boolean	isFailAcknowledgement()