Modifier and Type	Class and Description
pack-priv static class	CLStaticHttpHandler.JarURLInputStream
private static class	CLStaticHttpHandler.NonBlockingDownloadHandler

Field Summary

Modifier and Type	Field and Description
private static final boolean	CHECK_NON_SLASH_TERMINATED_FOLDERS `true` (default) if we want to double-check the resource requests, that don't have terminating slash if they represent a folder and try to retrieve a welcome resource from the folder.
protected static final String	CHECK_NON_SLASH_TERMINATED_FOLDERS_PROP
private final ClassLoader	classLoader
private final ArraySet<String>	docRoots
private static final String	EMPTY_STR
private static final Logger	LOGGER Hides org.glassfish.grizzly.http.server.StaticHttpHandlerBase.LOGGER.
private static final String	SLASH_STR

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	CLStaticHttpHandler(final ClassLoader `ClassLoader` to be used to resolve the resources classLoader, final String... the doc roots (path prefixes), which will be used to find resources. Effectively each docRoot will be prepended to a resource path before passing it to `ClassLoader#getResource(java.lang.String)`. If no `docRoots` are set - the resources will be searched starting from `ClassLoader`'s root. docRoots) Create `HttpHandler`, which will handle requests to the static resources resolved by the given class loader.

public

CLStaticHttpHandler(final ClassLoader

ClassLoader to be used to resolve the resources

classLoader, final String...

the doc roots (path prefixes), which will be used to find resources. Effectively each docRoot will be prepended to a resource path before passing it to ClassLoader#getResource(java.lang.String). If no docRoots are set - the resources will be searched starting from ClassLoader's root.

docRoots)

Create HttpHandler, which will handle requests to the static resources resolved by the given class loader.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if this docroot hasn't been registered before, or `false` otherwise. addDocRoot(final String docRoot) Adds doc root (path prefix), which will be used to look up resources.
private boolean	addTimeStampEntryToFileCache(final Request req, final Response res, final File archive)
private static void	closeJarFileIfNeeded(final JarURLConnection jarConnection, final JarFile jarFile)
public ClassLoader	getClassLoader() Returns the `ClassLoader` used to resolve the requested HTTP resources.
private File	getJarFile(final String path)
protected boolean	handle(String resourcePath, final Request request, final Response response) Implements abstract org.glassfish.grizzly.http.server.StaticHttpHandlerBase.handle. Lookup a resource based on the request URI, and process it.
private URL	lookupResource(String resourcePath)
public boolean	Returns: `true` if this docroot was found and removed from the list, or or `false` if this docroot was not found in the list. removeDocRoot(final String docRoot) Removes docRoot from the doc root list.
private static void	sendResource(final Response response, final InputStream input)

Inherited from org.glassfish.grizzly.http.server.StaticHttpHandlerBase:: addCachingHeaders addToFileCache getRelativeURI isFileCacheEnabled lookupFileCache onMissingResource pickupContentType sendFile service setFileCacheEnabled

Field Detail

CHECK_NON_SLASH_TERMINATED_FOLDERS	back to summary
private static final boolean CHECK_NON_SLASH_TERMINATED_FOLDERS `true` (default) if we want to double-check the resource requests, that don't have terminating slash if they represent a folder and try to retrieve a welcome resource from the folder.

CHECK_NON_SLASH_TERMINATED_FOLDERS_PROP	back to summary
protected static final String CHECK_NON_SLASH_TERMINATED_FOLDERS_PROP

classLoader	back to summary
private final ClassLoader classLoader

docRoots	back to summary
private final ArraySet<String> docRoots

EMPTY_STR	back to summary
private static final String EMPTY_STR

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

SLASH_STR	back to summary
private static final String SLASH_STR

Constructor Detail

CLStaticHttpHandler back to summary

CLStaticHttpHandler	back to summary
public CLStaticHttpHandler(final ClassLoader classLoader, final String... docRoots) Create `HttpHandler`, which will handle requests to the static resources resolved by the given class loader. Parameters classLoader:ClassLoader `ClassLoader` to be used to resolve the resources docRoots:String[] the doc roots (path prefixes), which will be used to find resources. Effectively each docRoot will be prepended to a resource path before passing it to `ClassLoader#getResource(java.lang.String)`. If no `docRoots` are set - the resources will be searched starting from `ClassLoader`'s root. Exceptions IllegalArgumentException: if one of the docRoots doesn't end with slash ('/')

public CLStaticHttpHandler(final ClassLoader classLoader, final String... docRoots)

Create HttpHandler, which will handle requests to the static resources resolved by the given class loader.

Parameters

classLoader:ClassLoader: ClassLoader to be used to resolve the resources
docRoots:String[]: the doc roots (path prefixes), which will be used to find resources. Effectively each docRoot will be prepended to a resource path before passing it to ClassLoader#getResource(java.lang.String). If no docRoots are set - the resources will be searched starting from ClassLoader's root.

Exceptions

IllegalArgumentException:: if one of the docRoots doesn't end with slash ('/')

Method Detail

addDocRoot back to summary

addDocRoot	back to summary
public boolean addDocRoot(final String docRoot) Adds doc root (path prefix), which will be used to look up resources. Effectively each registered docRoot will be prepended to a resource path before passing it to `ClassLoader#getResource(java.lang.String)`. Returns:boolean `true` if this docroot hasn't been registered before, or `false` otherwise. Exceptions IllegalArgumentException: if one of the docRoots doesn't end with slash ('/')

public boolean addDocRoot(final String docRoot)

Adds doc root (path prefix), which will be used to look up resources. Effectively each registered docRoot will be prepended to a resource path before passing it to ClassLoader#getResource(java.lang.String).

Returns:boolean

true if this docroot hasn't been registered before, or false otherwise.

Exceptions

IllegalArgumentException:: if one of the docRoots doesn't end with slash ('/')

addTimeStampEntryToFileCache	back to summary
private boolean addTimeStampEntryToFileCache(final Request req, final Response res, final File archive)

closeJarFileIfNeeded	back to summary
private static void closeJarFileIfNeeded(final JarURLConnection jarConnection, final JarFile jarFile) throws IOException

getClassLoader	back to summary
public ClassLoader getClassLoader() Returns the `ClassLoader` used to resolve the requested HTTP resources.

getJarFile	back to summary
private File getJarFile(final String path) throws MalformedURLException, FileNotFoundException

handle	back to summary
protected boolean handle(String resourcePath, final Request request, final Response response) throws Exception Implements abstract org.glassfish.grizzly.http.server.StaticHttpHandlerBase.handle. Doc from org.glassfish.grizzly.http.server.StaticHttpHandlerBase.handle. Lookup a resource based on the request URI, and process it. Annotations @Override

handle

back to summary

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

Implements abstract org.glassfish.grizzly.http.server.StaticHttpHandlerBase.handle.

Doc from org.glassfish.grizzly.http.server.StaticHttpHandlerBase.handle.

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

Annotations

@Override

lookupResource	back to summary
private URL lookupResource(String resourcePath)

removeDocRoot back to summary

removeDocRoot	back to summary
public boolean removeDocRoot(final String docRoot) Removes docRoot from the doc root list. Returns:boolean `true` if this docroot was found and removed from the list, or or `false` if this docroot was not found in the list.

public boolean removeDocRoot(final String docRoot)

Removes docRoot from the doc root list.

Returns:boolean: true if this docroot was found and removed from the list, or or false if this docroot was not found in the list.

sendResource	back to summary
private static void sendResource(final Response response, final InputStream input) throws IOException

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

pack-priv Class CLStaticHttpHandler.JarURLInputStream

Class Inheritance

extends FilterInputStream

java.lang.Object
java.io.InputStream
java.io.FilterInputStream
org.glassfish.grizzly.http.server.CLStaticHttpHandler.JarURLInputStream

Field Summary

Modifier and Type	Field and Description
private final JarURLConnection	jarConnection
private final JarFile	jarFile

Inherited from java.io.FilterInputStream:: in

Constructor Summary

Access	Constructor and Description
pack-priv	JarURLInputStream(final JarURLConnection jarConnection, final JarFile jarFile, final InputStream src)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.FilterInputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.

Inherited from java.io.FilterInputStream:: available mark markSupported read read read reset skip

Field Detail

jarConnection	back to summary
private final JarURLConnection jarConnection

jarFile	back to summary
private final JarFile jarFile

Constructor Detail

JarURLInputStream	back to summary
pack-priv JarURLInputStream(final JarURLConnection jarConnection, final JarFile jarFile, final InputStream src)

Method Detail

close	back to summary
public void close() throws IOException Overrides java.io.FilterInputStream.close. Implements java.io.Closeable.close. Doc from java.io.FilterInputStream.close. Closes this input stream and releases any system resources associated with the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.FilterInputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.FilterInputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

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

private Class CLStaticHttpHandler.NonBlockingDownloadHandler

Class Inheritance

extends Object
implements WriteHandler

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

All Implemented Interfaces

org.glassfish.grizzly.WriteHandler

Field Summary

Modifier and Type	Field and Description
private final int	chunkSize
private final InputStream	inputStream
private final MemoryManager<E extends Buffer>	mm
private final NIOOutputStream	outputStream
private final Response	response

Constructor Summary

Access	Constructor and Description
pack-priv	NonBlockingDownloadHandler(final Response response, final NIOOutputStream outputStream, final InputStream inputStream, 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

inputStream	back to summary
private final InputStream inputStream

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

Constructor Detail

NonBlockingDownloadHandler	back to summary
pack-priv NonBlockingDownloadHandler(final Response response, final NIOOutputStream outputStream, final InputStream inputStream, 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 Class CLStaticHttpHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class CLStaticHttpHandler.JarURLInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CLStaticHttpHandler.NonBlockingDownloadHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail