Grizzly NIO 5.0.2 · org.glassfish.grizzly.http.server.HttpHandler

Modifier and Type	Field and Description
private boolean	allowCustomStatusMessage Are custom status messages (reason phrases) allowed?
private boolean	allowEncodedSlash Allow request that uses encoded slash.
private boolean	decodeURL Is the URL decoded
private static final RequestExecutorProvider	DEFAULT_REQUEST_EXECUTOR_PROVIDER
private static final Logger	LOGGER
private final String	name HttpHandler name
private Charset	requestURIEncoding Request URI encoding

Access	Constructor and Description
public	HttpHandler() Create `HttpHandler`.
public	HttpHandler(String name) Create `HttpHandler` with the specific name.

Method Summary

Modifier and Type	Method and Description
public void	destroy() Invoked when the `HttpServer` and may be overridden by custom implementations to perform implementation specific resource reclaimation tasks.
pack-priv boolean	Returns: `true` if the `Request` has already been processed in the current `Thread`, or `false` otherwise doHandle(final Request the `Request` request, final Response the `Response` response) Pre-processes `HttpHandler` `Request` and `Response`, checks the HTTP acknowledgment and decodes URL if required.
protected ErrorPageGenerator	Returns: the `ErrorPageGenerator`, that might be used (if an error occurs) during `Request` processing getErrorPageGenerator(final Request `Request` request) Returns the `ErrorPageGenerator`, that might be used (if an error occurs) during `Request` processing.
public String	Returns: the `HttpHandler` name. getName() Get the `HttpHandler` name.
public RequestExecutorProvider	getRequestExecutorProvider() Returns: the `RequestExecutorProvider` responsible for executing user's code in `HttpHandler#service(org.glassfish.grizzly.http.server.Request, org.glassfish.grizzly.http.server.Response)` and notifying `ReadHandler`, `WriteHandler` registered by the user.
public Charset	Returns: the request URI encoding used by this `HttpHandler`. getRequestURIEncoding() Get the request URI encoding used by this `HttpHandler`.
protected String	getSessionCookieName() Returns: session cookie name, if not set default JSESSIONID name will be used
protected SessionManager	getSessionManager(final Request `Request` request) Returns: the `SessionManager` to be used.
public boolean	Returns: `true` if custom status messages (reason phrases) are allowed for this response, or `false` otherwise. isAllowCustomStatusMessage() Returns `true` if custom status messages (reason phrases) are allowed for this response, or `false` otherwise.
public boolean	Returns: Is HTTP URL request allowed to contains encoded slash. isAllowEncodedSlash() Is HTTP URL request allowed to contains encoded slash.
private boolean	runService(final Request request, final Response response)
protected boolean	Returns: `true` if request processing should continue after acknowledgment of the expectation, otherwise return `false`. sendAcknowledgment(final Request the `Request`. request, final Response the `Response`. response) The default implementation will acknowledge an `Expect: 100-Continue` with a response line with the status 100 followed by the final response to this request.
public abstract void	service(Request The `Request` request, Response The `Response` response) This method should contain the logic for any HTTP extension to the Grizzly HTTP web server.
public void	setAllowCustomStatusMessage(boolean `true` if custom status messages (reason phrases) are allowed for this response, or `false otherwise.` `allowCustomStatusMessage)` `Sets if the custom status messages (reason phrases) are allowed for this response.`
public void	setAllowEncodedSlash(boolean true allowEncodedSlash) When true, URL that contains encoded slash will be allowed.
protected void	setDecodeUrl(boolean decodeURL) Should this class decode the URL
protected void	setDispatcherHelper(final DispatcherHelper dispatcherHelper)
public void	setRequestURIEncoding(final Charset the request URI encoding used by this `HttpHandler`. requestURIEncoding) Set the request URI encoding used by this `HttpHandler`.
public void	setRequestURIEncoding(final String the request URI encoding used by this `HttpHandler`. requestURIEncoding) Set the request URI encoding used by this `HttpHandler`.
public void	start() Called when the `HttpHandler`'s container is started by invoking `HttpServer#start`.
protected static void	updatePaths(final Request request, final MappingData mappingData) Utility method to update `Request` path values.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

allowCustomStatusMessage	back to summary
private boolean allowCustomStatusMessage Are custom status messages (reason phrases) allowed?

allowEncodedSlash	back to summary
private boolean allowEncodedSlash Allow request that uses encoded slash.

decodeURL	back to summary
private boolean decodeURL Is the URL decoded

DEFAULT_REQUEST_EXECUTOR_PROVIDER	back to summary
private static final RequestExecutorProvider DEFAULT_REQUEST_EXECUTOR_PROVIDER

LOGGER	back to summary
private static final Logger LOGGER

name	back to summary
private final String name HttpHandler name

requestURIEncoding	back to summary
private Charset requestURIEncoding Request URI encoding

HttpHandler	back to summary
public HttpHandler() Create `HttpHandler`.

HttpHandler	back to summary
public HttpHandler(String name) Create `HttpHandler` with the specific name.

Method Detail

destroy	back to summary
public void destroy() Invoked when the `HttpServer` and may be overridden by custom implementations to perform implementation specific resource reclaimation tasks. By default, this method does nothing.

doHandle back to summary

doHandle	back to summary
pack-priv boolean doHandle(final Request request, final Response response) throws Exception Pre-processes `HttpHandler` `Request` and `Response`, checks the HTTP acknowledgment and decodes URL if required. Then passes control to `service(Request, Response)`. Parameters request:Request the `Request` response:Response the `Response` Returns:boolean `true` if the `Request` has already been processed in the current `Thread`, or `false` otherwise Exceptions Exception: if an error occurs serving a static resource or from the invocation of `service(Request, Response)`

pack-priv boolean doHandle(final Request request, final Response response) throws Exception

Pre-processes HttpHandler Request and Response, checks the HTTP acknowledgment and decodes URL if required. Then passes control to service(Request, Response).

Parameters

request:Request: the Request
response:Response: the Response

Returns:boolean

true if the Request has already been processed in the current Thread, or false otherwise

Exceptions

Exception:: if an error occurs serving a static resource or from the invocation of service(Request, Response)

getErrorPageGenerator back to summary

getErrorPageGenerator	back to summary
protected ErrorPageGenerator getErrorPageGenerator(final Request request) Returns the `ErrorPageGenerator`, that might be used (if an error occurs) during `Request` processing. Parameters request:Request `Request` Returns:ErrorPageGenerator the `ErrorPageGenerator`, that might be used (if an error occurs) during `Request` processing

protected ErrorPageGenerator getErrorPageGenerator(final Request request)

Returns the ErrorPageGenerator, that might be used (if an error occurs) during Request processing.

Parameters

request:Request: Request

Returns:ErrorPageGenerator

the ErrorPageGenerator, that might be used (if an error occurs) during Request processing

getName back to summary

getName	back to summary
public String getName() Get the `HttpHandler` name. Returns:String the `HttpHandler` name.

public String getName()

Get the HttpHandler name.

Returns:String: the HttpHandler name.

getRequestExecutorProvider	back to summary
public RequestExecutorProvider getRequestExecutorProvider() Returns:RequestExecutorProvider the `RequestExecutorProvider` responsible for executing user's code in `HttpHandler#service(org.glassfish.grizzly.http.server.Request, org.glassfish.grizzly.http.server.Response)` and notifying `ReadHandler`, `WriteHandler` registered by the user.

getRequestURIEncoding back to summary

getRequestURIEncoding	back to summary
public Charset getRequestURIEncoding() Get the request URI encoding used by this `HttpHandler`. Returns:Charset the request URI encoding used by this `HttpHandler`.

public Charset getRequestURIEncoding()

Get the request URI encoding used by this HttpHandler.

Returns:Charset: the request URI encoding used by this HttpHandler.

getSessionCookieName	back to summary
protected String getSessionCookieName() Returns:String session cookie name, if not set default JSESSIONID name will be used

getSessionManager	back to summary
protected SessionManager getSessionManager(final Request request) Parameters request:Request `Request` Returns:SessionManager the `SessionManager` to be used. `null` value implies `DefaultSessionManager`

isAllowCustomStatusMessage back to summary

isAllowCustomStatusMessage	back to summary
public boolean isAllowCustomStatusMessage() Returns `true` if custom status messages (reason phrases) are allowed for this response, or `false` otherwise. Returns:boolean `true` if custom status messages (reason phrases) are allowed for this response, or `false` otherwise.

public boolean isAllowCustomStatusMessage()

Returns true if custom status messages (reason phrases) are allowed for this response, or false otherwise.

Returns:boolean: true if custom status messages (reason phrases) are allowed for this response, or false otherwise.

isAllowEncodedSlash	back to summary
public boolean isAllowEncodedSlash() Is HTTP URL request allowed to contains encoded slash. Returns:boolean Is HTTP URL request allowed to contains encoded slash.

isAllowEncodedSlash

back to summary

public boolean isAllowEncodedSlash()

Is HTTP URL request allowed to contains encoded slash.

Returns:boolean: Is HTTP URL request allowed to contains encoded slash.

runService	back to summary
private boolean runService(final Request request, final Response response) throws Exception

sendAcknowledgment back to summary

sendAcknowledgment	back to summary
protected boolean sendAcknowledgment(final Request request, final Response response) throws IOException The default implementation will acknowledge an `Expect: 100-Continue` with a response line with the status 100 followed by the final response to this request. Parameters request:Request the `Request`. response:Response the `Response`. Returns:boolean `true` if request processing should continue after acknowledgment of the expectation, otherwise return `false`. Exceptions IOException: if an error occurs sending the acknowledgment.

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

The default implementation will acknowledge an Expect: 100-Continue with a response line with the status 100 followed by the final response to this request.

Parameters

request:Request: the Request.
response:Response: the Response.

Returns:boolean

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

Exceptions

IOException:: if an error occurs sending the acknowledgment.

service back to summary

service	back to summary
public abstract void service(Request request, Response response) throws Exception This method should contain the logic for any HTTP extension to the Grizzly HTTP web server. Parameters request:Request The `Request` response:Response The `Response`

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

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

Parameters

request:Request: The Request
response:Response: The Response

setAllowCustomStatusMessage back to summary

setAllowCustomStatusMessage	back to summary
public void setAllowCustomStatusMessage(boolean allowCustomStatusMessage) Sets if the custom status messages (reason phrases) are allowed for this response. Parameters allowCustomStatusMessage:boolean `true` if custom status messages (reason phrases) are allowed for this response, or `false otherwise.`

public void setAllowCustomStatusMessage(boolean allowCustomStatusMessage)

Sets if the custom status messages (reason phrases) are allowed for this response.

Parameters

allowCustomStatusMessage:boolean: true if custom status messages (reason phrases) are allowed for this response, or false otherwise.

setAllowEncodedSlash	back to summary
public void setAllowEncodedSlash(boolean allowEncodedSlash) When true, URL that contains encoded slash will be allowed. When false, the URL will be rejected and considered as an invalid one. Parameters allowEncodedSlash:boolean true

setAllowEncodedSlash

back to summary

public void setAllowEncodedSlash(boolean allowEncodedSlash)

When true, URL that contains encoded slash will be allowed. When false, the URL will be rejected and considered as an invalid one.

Parameters

allowEncodedSlash:boolean: true

setDecodeUrl	back to summary
protected void setDecodeUrl(boolean decodeURL) Should this class decode the URL

setDispatcherHelper	back to summary
protected void setDispatcherHelper(final DispatcherHelper dispatcherHelper)

setRequestURIEncoding back to summary

setRequestURIEncoding	back to summary
public void setRequestURIEncoding(final Charset requestURIEncoding) Set the request URI encoding used by this `HttpHandler`. Parameters requestURIEncoding:Charset the request URI encoding used by this `HttpHandler`.

public void setRequestURIEncoding(final Charset requestURIEncoding)

Set the request URI encoding used by this HttpHandler.

Parameters

requestURIEncoding:Charset: the request URI encoding used by this HttpHandler.

setRequestURIEncoding back to summary

setRequestURIEncoding	back to summary
public void setRequestURIEncoding(final String requestURIEncoding) Set the request URI encoding used by this `HttpHandler`. Parameters requestURIEncoding:String the request URI encoding used by this `HttpHandler`.

public void setRequestURIEncoding(final String requestURIEncoding)

Set the request URI encoding used by this HttpHandler.

Parameters

requestURIEncoding:String: the request URI encoding used by this HttpHandler.

start	back to summary
public void start() Called when the `HttpHandler`'s container is started by invoking `HttpServer#start`. By default, it does nothing.

updatePaths	back to summary
protected static void updatePaths(final Request request, final MappingData mappingData) Utility method to update `Request` path values.

public abstract Class HttpHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail