Modifier and Type	Class and Description
private static class	StaticHttpHandlerBase.NonBlockingDownloadHandler

Modifier and Type	Field and Description
private volatile int	fileCacheFilterIdx
private volatile boolean	isFileCacheEnabled
private static final Logger	LOGGER Hides org.glassfish.grizzly.http.server.HttpHandler.LOGGER.

Access	Constructor and Description
public	StaticHttpHandlerBase()

Method Summary

Modifier and Type	Method and Description
protected static void	addCachingHeaders(final Response response, final File file)
public final boolean	addToFileCache(final Request req, final Response res, final File resource)
protected String	getRelativeURI(final Request request)
protected abstract boolean	Returns: `true`, if the static resource has been found and processed, or `false`, if the static resource hasn't been found handle(final String The request URI uri, final Request the `Request` request, final Response the `Response` response) Lookup a resource based on the request URI, and process it.
public boolean	Returns: `true` if this `StaticHttpHandler` has been configured to use file cache to serve static resources, or `false` otherwise. isFileCacheEnabled() Returns `true` if this `StaticHttpHandler` has been configured to use file cache to serve static resources, or `false` otherwise.
protected FileCacheFilter	lookupFileCache(final FilterChainContext fcContext)
protected void	onMissingResource(final Request the `Request` request, final Response the `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(final Response response, final String path)
public static void	sendFile(final Response response, final File file)
private static void	sendUsingBuffers(final Response response, final File file)
private static void	sendZeroCopy(final Response response, final File file)
public void	service(final Request the `Request` request, final Response the `Response` response) Implements abstract org.glassfish.grizzly.http.server.HttpHandler.service. Based on the `Request` URI, try to map the file from the `getDocRoots()`, and send it back to a client.
public void	setFileCacheEnabled(boolean `true` to configure this `StaticHttpHandler` to use file cache to serve static resources, or `false` otherwise. isFileCacheEnabled) Set `true` to configure this `StaticHttpHandler` to use file cache to serve static resources, or `false` otherwise.

Field Detail

fileCacheFilterIdx	back to summary
private volatile int fileCacheFilterIdx

isFileCacheEnabled	back to summary
private volatile boolean isFileCacheEnabled

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

Constructor Detail

StaticHttpHandlerBase	back to summary
public StaticHttpHandlerBase()

Method Detail

addCachingHeaders	back to summary
protected static void addCachingHeaders(final Response response, final File file)

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

getRelativeURI	back to summary
protected String getRelativeURI(final Request request) throws Exception

handle back to summary

handle	back to summary
protected abstract boolean handle(final String uri, final Request request, final Response response) throws Exception Lookup a resource based on the request URI, and process it. Parameters uri:String The request URI request:Request the `Request` response:Response the `Response` Returns:boolean `true`, if the static resource has been found and processed, or `false`, if the static resource hasn't been found

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

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

Parameters

uri:String: The request URI
request:Request: the Request
response:Response: the Response

Returns:boolean

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

isFileCacheEnabled back to summary

isFileCacheEnabled	back to summary
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:boolean `true` if this `StaticHttpHandler` has been configured to use file cache to serve static resources, or `false` otherwise. Annotations @SuppressWarnings:UnusedDeclaration

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:boolean

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

Annotations

@SuppressWarnings:UnusedDeclaration

lookupFileCache	back to summary
protected FileCacheFilter lookupFileCache(final FilterChainContext fcContext)

onMissingResource back to summary

onMissingResource	back to summary
protected void onMissingResource(final Request request, final 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:Request the `Request` response:Response the `Response`

protected void onMissingResource(final Request request, final 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:Request: the Request
response:Response: the Response

pickupContentType	back to summary
protected static void pickupContentType(final Response response, final String path)

sendFile	back to summary
public static void sendFile(final Response response, final File file) throws IOException

sendUsingBuffers	back to summary
private static void sendUsingBuffers(final Response response, final File file) throws FileNotFoundException, IOException

sendZeroCopy	back to summary
private static void sendZeroCopy(final Response response, final File file) throws IOException

service back to summary

service	back to summary
public void service(final Request request, final Response response) throws Exception Implements abstract org.glassfish.grizzly.http.server.HttpHandler.service. Based on the `Request` URI, try to map the file from the `getDocRoots()`, and send it back to a client. Parameters request:Request the `Request` response:Response the `Response` Annotations @Override

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

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

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

Parameters

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

Annotations

@Override

setFileCacheEnabled back to summary

setFileCacheEnabled	back to summary
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:boolean `true` to configure this `StaticHttpHandler` to use file cache to serve static resources, or `false` otherwise. Annotations @SuppressWarnings:UnusedDeclaration

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:boolean: true to configure this StaticHttpHandler to use file cache to serve static resources, or false otherwise.

Annotations

@SuppressWarnings:UnusedDeclaration

org.glassfish.grizzly.http.server back to summary

private Class StaticHttpHandlerBase.NonBlockingDownloadHandler

Class Inheritance

extends Object
implements WriteHandler

java.lang.Object
org.glassfish.grizzly.http.server.StaticHttpHandlerBase.NonBlockingDownloadHandler

All Implemented Interfaces

org.glassfish.grizzly.WriteHandler

Field Summary

Modifier and Type	Field and Description
private final int	chunkSize
private final FileChannel	fileChannel
private final MemoryManager<E extends Buffer>	mm
private final NIOOutputStream	outputStream
private final Response	response
private volatile long	size

Constructor Summary

Access	Constructor and Description
pack-priv	NonBlockingDownloadHandler(final Response response, final NIOOutputStream outputStream, final File file, final int chunkSize)

Method Summary

Modifier and Type	Method and Description
private void	complete(final boolean isError) Complete the download
public void	onError(Throwable t) Implements org.glassfish.grizzly.WriteHandler.onError. Invoked when an error occurs processing the request asynchronously.
public void	onWritePossible() Implements org.glassfish.grizzly.WriteHandler.onWritePossible. This callback will be invoked when the requirements as dictated by writer are met.
private boolean	sendChunk() Send next CHUNK_SIZE of file

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

Field Detail

chunkSize	back to summary
private final int chunkSize

fileChannel	back to summary
private final FileChannel fileChannel

mm	back to summary
private final MemoryManager<E extends Buffer> mm

outputStream	back to summary
private final NIOOutputStream outputStream

response	back to summary
private final Response response

size	back to summary
private volatile long size

Constructor Detail

NonBlockingDownloadHandler	back to summary
pack-priv NonBlockingDownloadHandler(final Response response, final NIOOutputStream outputStream, final File file, final int chunkSize)

Method Detail

complete	back to summary
private void complete(final boolean isError) Complete the download

onError	back to summary
public void onError(Throwable t) Implements org.glassfish.grizzly.WriteHandler.onError. Doc from org.glassfish.grizzly.WriteHandler.onError. Invoked when an error occurs processing the request asynchronously. Annotations @Override

onError

back to summary

public void onError(Throwable t)

Implements org.glassfish.grizzly.WriteHandler.onError.

Doc from org.glassfish.grizzly.WriteHandler.onError.

Invoked when an error occurs processing the request asynchronously.

Annotations

@Override

onWritePossible back to summary

onWritePossible	back to summary
public void onWritePossible() throws Exception Implements org.glassfish.grizzly.WriteHandler.onWritePossible. Doc from org.glassfish.grizzly.WriteHandler.onWritePossible. This callback will be invoked when the requirements as dictated by writer are met. Annotations @Override Exceptions Exception: `Exception` might be thrown by the custom handler code. This exception will be delegated for processing to `onError(java.lang.Throwable)`.

public void onWritePossible() throws Exception

Implements org.glassfish.grizzly.WriteHandler.onWritePossible.

Doc from org.glassfish.grizzly.WriteHandler.onWritePossible.

This callback will be invoked when the requirements as dictated by writer are met.

Annotations

@Override

Exceptions

Exception:: Exception might be thrown by the custom handler code. This exception will be delegated for processing to onError(java.lang.Throwable).

sendChunk	back to summary
private boolean sendChunk() throws IOException Send next CHUNK_SIZE of file

public abstract Class StaticHttpHandlerBase

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class StaticHttpHandlerBase.NonBlockingDownloadHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail