net.officefloor.plugin.web.http.resource

Class AbstractHttpFile

java.lang.Object

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

net.officefloor.plugin.web.http.resource.AbstractHttpFile

All Implemented Interfaces:

Serializable, HttpFile, HttpResource

Direct Known Subclasses:

ClasspathHttpFile, WarHttpFile

public abstract class AbstractHttpFile
extends AbstractHttpResource
implements HttpFile

Abstract HttpFile implementation.

Author:

Daniel Sagenschneider

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Charset	charset Charset.
protected String	contentEncoding Content-Encoding.
protected String	contentType Content-Type.

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

resourcePath

Constructor Summary

Constructors

Constructor and Description
AbstractHttpFile(String resourcePath, AbstractHttpFileDescription description) Initiate an existing HttpFile.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Charset	getCharset() Obtains the Charset for the contents.
String	getContentEncoding() Obtains the Content-Encoding for this HttpFile.
String	getContentType() Obtains the Content-Type for this HttpFile.
int	hashCode()
boolean	isExist() Indicates if this HttpResource exists.
static void	writeHttpFile(HttpFile file, HttpResponse response) Writes the HttpFile to the HttpResponse.

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

getPath

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.HttpFile

getContents

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

getPath

Field Detail

contentEncoding

protected String contentEncoding

Content-Encoding.

contentType

protected String contentType

Content-Type.

charset

protected transient Charset charset

Charset.

Constructor Detail

AbstractHttpFile

public AbstractHttpFile(String resourcePath,
                        AbstractHttpFileDescription description)

Initiate an existing HttpFile.

Parameters:

resourcePath - Resource path.

description - AbstractHttpFileDescription.

Method Detail

writeHttpFile

public static void writeHttpFile(HttpFile file,
                                 HttpResponse response)
                          throws IOException

Writes the HttpFile to the HttpResponse.

Parameters:

file - HttpFile to write to the HttpResponse.

response - HttpResponse

Throws:

IOException - If fails to write the HttpFile.

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.

getContentEncoding

public String getContentEncoding()

Description copied from interface: HttpFile

Obtains the Content-Encoding for this HttpFile.

Specified by:

getContentEncoding in interface HttpFile

Returns:

Content-Encoding for this HttpFile.

getContentType

public String getContentType()

Description copied from interface: HttpFile

Obtains the Content-Type for this HttpFile.

The value should omit the charset attribute.

Specified by:

getContentType in interface HttpFile

Returns:

Content-Type for this HttpFile.

getCharset

public Charset getCharset()

Description copied from interface: HttpFile

Obtains the Charset for the contents.

Specified by:

getCharset in interface HttpFile

Returns:

Charset or null if contents are not text or the Charset is unknown.

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractHttpResource

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractHttpResource