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

Class WarHttpDirectory

java.lang.Object

net.officefloor.plugin.web.http.resource.AbstractHttpResource

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

All Implemented Interfaces:

Serializable, HttpDirectory, HttpResource

public class WarHttpDirectory
extends AbstractHttpResource
implements HttpDirectory

WAR HttpDirectory.

Author:

Daniel Sagenschneider

See Also:

Serialized Form

Field Summary

Fields inherited from class net.officefloor.plugin.web.http.resource.AbstractHttpResource

resourcePath

Constructor Summary

Constructors

Constructor and Description
WarHttpDirectory(String resourcePath, String warIdentifier, File directory, String... defaultFileNames) Initiate.

Method Summary

Modifier and Type	Method and Description
HttpFile	getDefaultFile() Obtains the default HttpFile for this directory.
boolean	isExist() Indicates if this HttpResource exists.
HttpResource[]	listResources() Obtain the HttpResource instances contained directly within this directory.

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

equals, getPath, hashCode

Methods inherited from class java.lang.Object

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

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

getPath

Constructor Detail

WarHttpDirectory

public WarHttpDirectory(String resourcePath,
                        String warIdentifier,
                        File directory,
                        String... defaultFileNames)

Initiate.

Parameters:

resourcePath - Resource path.

warIdentifier - WAR identifier to locate WarHttpResourceFactory.

directory - Directory File.

defaultFileNames - Names of the default HttpFile instances in order of searching for the default HttpFile.

Method Detail

isExist

public boolean isExist()

Description copied from interface: HttpResource

Indicates if this HttpResource exists. Should this HttpResource not exist, only the path will be available.

This allows for caching of HttpResource instances not existing.

It also enables implementations of ManagedObjectSource instances to provide the HttpResource from a HttpRequest dependency - can always provide an instance with this indicating if exists.

Specified by:

isExist in interface HttpResource

Returns:

true if this HttpResource exists.

getDefaultFile

public HttpFile getDefaultFile()

Description copied from interface: HttpDirectory

Obtains the default HttpFile for this directory.

Specified by:

getDefaultFile in interface HttpDirectory

Returns:

Default HttpFile. May be null if no default HttpFile available.

listResources

public HttpResource[] listResources()

Description copied from interface: HttpDirectory

Obtain the HttpResource instances contained directly within this directory.

Specified by:

listResources in interface HttpDirectory

Returns:

Child HttpResource instances.