net.officefloor.plugin.web.http.resource.war

Class WarHttpResourceFactory

java.lang.Object

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

net.officefloor.plugin.web.http.resource.war.WarHttpResourceFactory

All Implemented Interfaces:

HttpResourceFactory

public class WarHttpResourceFactory
extends AbstractHttpResourceFactory

Locates a HttpFile from a WAR directory or archive.

As per Servlet standards it will not provide access to files within the WEB-INF directory.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
static void	clearHttpResourceFactories() Allows clearing the HttpResourceFactory instances.
HttpResource	createHttpResource(File resource, String resourcePath) Creates the HttpResource.
HttpResource	createHttpResource(String applicationCanonicalPath) Creates the HttpResponse.
static ByteBuffer	getHttpResourceContents(File file) Obtains the contents of the HttpResource for the File.
static WarHttpResourceFactory	getHttpResourceFactory(File warDirectory, String... defaultDirectoryFileNames) Obtains the WarHttpResourceFactory for the WAR directory.

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 WarHttpResourceFactory getHttpResourceFactory(File warDirectory,
                                                            String... defaultDirectoryFileNames)
                                                     throws IOException

Obtains the WarHttpResourceFactory for the WAR directory.

Parameters:

warDirectory - WAR directory.

defaultDirectoryFileNames - Default directory file names. Should the WarHttpResourceFactory already be created for the WAR directory, these values are ignored.

Returns:

WarHttpResourceFactory for the WAR directory.

Throws:

IOException - If fails to obtain WarHttpResourceFactory.

clearHttpResourceFactories

public static void clearHttpResourceFactories()

Allows clearing the HttpResourceFactory instances.

getHttpResourceContents

public static ByteBuffer getHttpResourceContents(File file)

Obtains the contents of the HttpResource for the File.

Parameters:

file - File.

Returns:

Class path of the HttpResource.

createHttpResource

public HttpResource createHttpResource(File resource,
                                       String resourcePath)

Creates the HttpResource.

Parameters:

resource - File.

resourcePath - Resource path.

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.