net.officefloor.plugin.web.http.resource

Interface HttpResource

All Superinterfaces:

Serializable

All Known Subinterfaces:

HttpDirectory, HttpFile

All Known Implementing Classes:

AbstractHttpFile, AbstractHttpFileDescription, AbstractHttpResource, ClasspathHttpDirectory, ClasspathHttpFile, NotExistHttpResource, WarHttpDirectory, WarHttpFile

public interface HttpResource
extends Serializable

HTTP resource.

All HttpResource implementations must be Serializable to enable them to be serialised into caches.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
String	getPath() Obtains the Request URI path to this HttpResource.
boolean	isExist() Indicates if this HttpResource exists.

Method Detail

getPath

String getPath()

Obtains the Request URI path to this HttpResource.

The path is canonical to allow using it as a key for caching this HttpResource.

Returns:

Canonical request URI path to this HttpResource.

isExist

boolean isExist()

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.

Returns:

true if this HttpResource exists.