net.officefloor.plugin.web.http.resource.classpath

Class ClasspathHttpResourceFactory

java.lang.Object

net.officefloor.plugin.web.http.resource.AbstractHttpResourceFactory

net.officefloor.plugin.web.http.resource.classpath.ClasspathHttpResourceFactory

All Implemented Interfaces:

HttpResourceFactory

public class ClasspathHttpResourceFactory
extends AbstractHttpResourceFactory

Locates a HttpFile from a ClassLoader.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
static void	clearHttpResourceFactories() Allows clearing the HttpResourceFactory instances.
HttpResource	createHttpResource(ClassPathHttpResourceNode node) Creates the HttpResource.
HttpResource	createHttpResource(String applicationCanonicalPath) Creates the HttpResponse.
static ByteBuffer	getHttpResourceContents(String classpathPrefix, String classPath) Obtains the contents of the HttpResource for the class path.
static ClasspathHttpResourceFactory	getHttpResourceFactory(String classPathPrefix, ClassLoader classLoader, String... defaultDirectoryFileNames) Obtains the ClasspathHttpResourceFactory for the class path prefix.
ClassPathHttpResourceNode	getNode(String resourcePath) Obtains the ClassPathHttpResourceNode for resource path.

Methods inherited from class net.officefloor.plugin.web.http.resource.AbstractHttpResourceFactory

addHttpFileDescriber, describeFile, getHttpResourceContents

Methods inherited from class java.lang.Object

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

Method Detail

getHttpResourceFactory

public static ClasspathHttpResourceFactory getHttpResourceFactory(String classPathPrefix,
                                                                  ClassLoader classLoader,
                                                                  String... defaultDirectoryFileNames)

Obtains the ClasspathHttpResourceFactory for the class path prefix.

Parameters:

classPathPrefix - Class path prefix.

classLoader - ClassLoader to use to obtain the HttpResource instances.

defaultDirectoryFileNames - Default directory file names. Should the ClasspathHttpResourceFactory already be created for the class path prefix, these values are ignored.

Returns:

ClasspathHttpResourceFactory for the class path prefix.

clearHttpResourceFactories

public static void clearHttpResourceFactories()

Allows clearing the HttpResourceFactory instances.

getHttpResourceContents

public static ByteBuffer getHttpResourceContents(String classpathPrefix,
                                                 String classPath)

Obtains the contents of the HttpResource for the class path.

Parameters:

classpathPrefix - Class path prefix to identify the HttpResourceFactory.

classPath - Class path to the HttpResource.

Returns:

ByteBuffer containing the contents of the HttpResource.

getNode

public ClassPathHttpResourceNode getNode(String resourcePath)

Obtains the ClassPathHttpResourceNode for resource path.

Parameters:

resourcePath - Resource path.

Returns:

ClassPathHttpResourceNode for resource path or null if no resource.

createHttpResource

public HttpResource createHttpResource(ClassPathHttpResourceNode node)

Creates the HttpResource.

Parameters:

node - ClassPathHttpResourceNode for the created HttpResource.

Returns:

HttpResource.

createHttpResource

public HttpResource createHttpResource(String applicationCanonicalPath)
                                throws IOException

Description copied from interface: HttpResourceFactory

Creates the HttpResponse.

Parameters:

applicationCanonicalPath - Application canonical path to the HttpResource. See the HttpApplicationLocation for obtaining this path from the HttpRequest request URI.

Returns:

HttpResource.

Throws:

IOException - If failure in finding the HttpResource.