Package org.glassfish.grizzly.http.server

Class StaticHttpHandlerBase

java.lang.Object

org.glassfish.grizzly.http.server.HttpHandler

org.glassfish.grizzly.http.server.StaticHttpHandlerBase

Direct Known Subclasses:

CLStaticHttpHandler, StaticHttpHandler

public abstract class StaticHttpHandlerBase
extends HttpHandler

The basic class for HttpHandler implementations, which processes requests to a static resources.

Author:

Jeanfrancois Arcand, Alexey Stashok

Constructor Summary

Constructors

Constructor	Description
StaticHttpHandlerBase()

Method Summary

Modifier and Type	Method	Description
protected static void	addCachingHeaders(Response response, File file)
final boolean	addToFileCache(Request req, Response res, File resource)
protected String	getRelativeURI(Request request)
protected abstract boolean	handle(String uri, Request request, Response response)	Lookup a resource based on the request URI, and process it.
boolean	isFileCacheEnabled()	Returns true if this StaticHttpHandler has been configured to use file cache to serve static resources, or false otherwise.
protected FileCacheFilter	lookupFileCache(FilterChainContext fcContext)
protected void	onMissingResource(Request request, Response response)	The method will be called, if the static resource requested by the Request wasn't found, so StaticHttpHandler implementation may try to workaround this situation.
protected static void	pickupContentType(Response response, String path)
static void	sendFile(Response response, File file)
void	service(Request request, Response response)	Based on the Request URI, try to map the file from the #getDocRoots(), and send it back to a client.
void	setFileCacheEnabled(boolean isFileCacheEnabled)	Set true to configure this StaticHttpHandler to use file cache to serve static resources, or false otherwise.

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

destroy, getErrorPageGenerator, getName, getRequestExecutorProvider, getRequestURIEncoding, getSessionCookieName, getSessionManager, isAllowCustomStatusMessage, isAllowEncodedSlash, sendAcknowledgment, setAllowCustomStatusMessage, setAllowEncodedSlash, setDecodeUrl, setDispatcherHelper, setRequestURIEncoding, setRequestURIEncoding, start, updatePaths

Methods inherited from class java.lang.Object

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

Constructor Details

StaticHttpHandlerBase

public StaticHttpHandlerBase()

Method Details

isFileCacheEnabled

public boolean isFileCacheEnabled()

Returns true if this StaticHttpHandler has been configured to use file cache to serve static resources, or false otherwise. Please note, even though this StaticHttpHandler might be configured to use file cache, file cache itself might be disabled FileCache.isEnabled(). In this case StaticHttpHandler will operate as if file cache was disabled.

Returns:

true if this StaticHttpHandler has been configured to use file cache to serve static resources, or false otherwise.

setFileCacheEnabled

public void setFileCacheEnabled(boolean isFileCacheEnabled)

Set true to configure this StaticHttpHandler to use file cache to serve static resources, or false otherwise. Please note, even though this StaticHttpHandler might be configured to use file cache, file cache itself might be disabled FileCache.isEnabled(). In this case StaticHttpHandler will operate as if file cache was disabled.

Parameters:

isFileCacheEnabled - true to configure this StaticHttpHandler to use file cache to serve static resources, or false otherwise.

sendFile

public static void sendFile(Response response,
 File file)
                     throws IOException

Throws:

IOException

addToFileCache

public final boolean addToFileCache(Request req,
 Response res,
 File resource)

service

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

Based on the Request URI, try to map the file from the #getDocRoots(), and send it back to a client.

Specified by:

service in class HttpHandler

Parameters:

request - the Request

response - the Response

Throws:

Exception

getRelativeURI

protected String getRelativeURI(Request request)
                         throws Exception

Throws:

Exception

onMissingResource

protected void onMissingResource(Request request,
 Response response)
                          throws Exception

The method will be called, if the static resource requested by the Request wasn't found, so StaticHttpHandler implementation may try to workaround this situation. The default implementation - sends a 404 response page by calling #customizedErrorPage(Request, Response).

Parameters:

request - the Request

response - the Response

Throws:

Exception

handle

protected abstract boolean handle(String uri,
 Request request,
 Response response)
                           throws Exception

Lookup a resource based on the request URI, and process it.

Parameters:

uri - The request URI

request - the Request

response - the Response

Returns:

true, if the static resource has been found and processed, or false, if the static resource hasn't been found

Throws:

Exception

lookupFileCache

protected FileCacheFilter lookupFileCache(FilterChainContext fcContext)

pickupContentType

protected static void pickupContentType(Response response,
 String path)

addCachingHeaders

protected static void addCachingHeaders(Response response,
 File file)