net.officefloor.plugin.web.http.resource.source

Class SourceHttpResourceFactory

java.lang.Object

net.officefloor.plugin.web.http.resource.source.SourceHttpResourceFactory

All Implemented Interfaces:

HttpResourceFactory

public class SourceHttpResourceFactory
extends Object
implements HttpResourceFactory

HttpResourceFactory initialised from SourceProperties.

It incorporates other HttpResourceFactory implementations configured from the SourceProperties to achieve its functionality. This provides reusable HttpResourceFactory capabilities for the various HTTP Web ManagedObjectSource and WorkSource implementations.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_CLASS_PATH_PREFIX Property to specify the class path prefix.
static String	PROPERTY_DEFAULT_DIRECTORY_FILE_NAMES Property to specify the listing of default directory file names.
static String	PROPERTY_DIRECT_STATIC_CONTENT Property to specify that all HttpFile and HttpDirectory instances are stored in memory with direct ByteBuffer content for performance.
static String	PROPERTY_RESOURCE_DIRECTORIES Property to specify the resource directories.

Method Summary

Modifier and Type	Method and Description
void	addHttpFileDescriber(HttpFileDescriber httpFileDescriber) Adds a HttpFileDescriber to describe the HttpFile instances.
static void	clearHttpResourceFactories() Clears the HttpResourceFactory instances.
static void	copyProperties(SourceProperties source, PropertyConfigurable target) Copies the Property values of interest.
HttpResource	createHttpResource(String applicationCanonicalPath) Creates the HttpResponse.
static HttpResourceFactory	createHttpResourceFactory(SourceContext context) Creates the HttpResourceFactory.
static void	loadProperties(String classPathPrefix, File[] resourceDirectories, String[] defaultDirectoryFileNames, Boolean isDirect, PropertyConfigurable target) Convenience method for programmatically loading configuration properties.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_CLASS_PATH_PREFIX

public static String PROPERTY_CLASS_PATH_PREFIX

Property to specify the class path prefix.

PROPERTY_RESOURCE_DIRECTORIES

public static String PROPERTY_RESOURCE_DIRECTORIES

Property to specify the resource directories.

PROPERTY_DEFAULT_DIRECTORY_FILE_NAMES

public static String PROPERTY_DEFAULT_DIRECTORY_FILE_NAMES

Property to specify the listing of default directory file names.

PROPERTY_DIRECT_STATIC_CONTENT

public static String PROPERTY_DIRECT_STATIC_CONTENT

Property to specify that all HttpFile and HttpDirectory instances are stored in memory with direct ByteBuffer content for performance.

Should there be changing static content then this should be set to false. Typically this is only during development as in production content is fixed.

Method Detail

copyProperties

public static void copyProperties(SourceProperties source,
                                  PropertyConfigurable target)

Copies the Property values of interest.

This is to aid configuration within the OfficeFloorDeployer to be provided down to this.

Parameters:

source - SourceProperties.

target - PropertyConfigurable.

loadProperties

public static void loadProperties(String classPathPrefix,
                                  File[] resourceDirectories,
                                  String[] defaultDirectoryFileNames,
                                  Boolean isDirect,
                                  PropertyConfigurable target)

Convenience method for programmatically loading configuration properties.

This handles converting to the necessary configuration Property values.

Parameters:

classPathPrefix - Class path prefix. May be null to use default.

resourceDirectories - Resource directories. May be null or empty array to not specify.

defaultDirectoryFileNames - Default directory file names. May be null or empty array to use default.

isDirect - Indicates if HttpResource content is kept in memory (direct ByteBuffer instances). May be null to use default.

target - PropertyConfigurable.

createHttpResourceFactory

public static HttpResourceFactory createHttpResourceFactory(SourceContext context)
                                                     throws IOException

Creates the HttpResourceFactory.

Parameters:

context - SourceContext to configure the HttpResourceFactory (and its delegates).

Returns:

HttpResourceFactory.

Throws:

IOException - Should the configured resources not be accessible or not exist.

clearHttpResourceFactories

public static void clearHttpResourceFactories()

Clears the HttpResourceFactory instances. This is useful for testing to have a fresh HttpResourceFactory.

addHttpFileDescriber

public void addHttpFileDescriber(HttpFileDescriber httpFileDescriber)

Description copied from interface: HttpResourceFactory

Adds a HttpFileDescriber to describe the HttpFile instances.

The HttpFileDescriber instances are to be used in the order added. Once a HttpFileDescription is provided, the remaining HttpFileDescriber instances will not be used.

Specified by:

addHttpFileDescriber in interface HttpResourceFactory

Parameters:

httpFileDescriber - HttpFileDescriber to describe the HttpFile.

createHttpResource

public HttpResource createHttpResource(String applicationCanonicalPath)
                                throws IOException

Description copied from interface: HttpResourceFactory

Creates the HttpResponse.

Specified by:

createHttpResource in interface HttpResourceFactory

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.