net.officefloor.plugin.web.http.resource

Class AbstractHttpResourceFactory

java.lang.Object

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

All Implemented Interfaces:

HttpResourceFactory

Direct Known Subclasses:

ClasspathHttpResourceFactory, WarHttpResourceFactory

public abstract class AbstractHttpResourceFactory
extends Object
implements HttpResourceFactory

Abstract HttpResourceFactory.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
AbstractHttpResourceFactory()

Method Summary

Modifier and Type	Method and Description
void	addHttpFileDescriber(HttpFileDescriber httpFileDescriber) Adds a HttpFileDescriber to describe the HttpFile instances.
protected void	describeFile(HttpFileDescription fileDescription) Describes the HttpFile.
static ByteBuffer	getHttpResourceContents(InputStream content, String path) Obtains the contents of the HttpResource for the InputStream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.plugin.web.http.resource.HttpResourceFactory

createHttpResource

Constructor Detail

AbstractHttpResourceFactory

public AbstractHttpResourceFactory()

Method Detail

getHttpResourceContents

public static ByteBuffer getHttpResourceContents(InputStream content,
                                                 String path)

Obtains the contents of the HttpResource for the InputStream.

Parameters:

content - InputStream containing contents of HttpResource.

path - Path for logging potential issue in obtaining content.

Returns:

InputStream for the HttpResource. May be null.

describeFile

protected void describeFile(HttpFileDescription fileDescription)

Describes the HttpFile.

Only registered HttpFileDescriber instances are used therefore it is possible that the HttpFile may not be able to be described.

Parameters:

fileDescription - HttpFileDescription.

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.