Package org.apache.catalina.webresources

Class AbstractResource

java.lang.Object

org.apache.catalina.webresources.AbstractResource

All Implemented Interfaces:

WebResource

Direct Known Subclasses:

AbstractArchiveResource, FileResource, JarResourceRoot

public abstract class AbstractResource
extends java.lang.Object
implements WebResource

Field Summary

Fields

Modifier and Type	Field	Description
protected static StringManager	sm

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractResource(WebResourceRoot root, java.lang.String webAppPath)

Method Summary

Modifier and Type	Method	Description
protected abstract java.io.InputStream	doGetInputStream()	Returns the input stream for this resource.
java.lang.String	getETag()	Returns the weak ETag calculated from the content length and last modified.
java.io.InputStream	getInputStream()	Obtains an InputStream based on the contents of this resource.
java.lang.String	getLastModifiedHttp()	Returns the last modified time in HTTP format.
protected abstract Log	getLog()
java.lang.String	getMimeType()	Returns the MIME type for this Resource.
java.lang.String	getStrongETag()	Return the strong ETag if available else return the weak ETag calculated from the content length and last modified.
java.lang.String	getWebappPath()	Returns the webapp path of this resource.
WebResourceRoot	getWebResourceRoot()	Returns a reference to the WebResourceRoot of which this WebResource is a part.
void	setMimeType(java.lang.String mimeType)	Set the MIME type for this Resource.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.catalina.WebResource

canRead, delete, exists, getCanonicalPath, getCertificates, getCodeBase, getContent, getContentLength, getCreation, getLastModified, getManifest, getName, getURL, isDirectory, isFile, isVirtual

Field Detail

sm

protected static final StringManager sm

Constructor Detail

AbstractResource

protected AbstractResource(WebResourceRoot root,
                           java.lang.String webAppPath)

Method Detail

getWebResourceRoot

public final WebResourceRoot getWebResourceRoot()

Description copied from interface: WebResource

Returns a reference to the WebResourceRoot of which this WebResource is a part.

Specified by:

getWebResourceRoot in interface WebResource

Returns:

a reference to the WebResourceRoot of which this WebResource is a part.

getWebappPath

public final java.lang.String getWebappPath()

Description copied from interface: WebResource

Returns the webapp path of this resource.

Specified by:

getWebappPath in interface WebResource

Returns:

The path of this resource relative to the web application root. If the resource is a directory, the return value will end in '/'.

getLastModifiedHttp

public final java.lang.String getLastModifiedHttp()

Description copied from interface: WebResource

Returns the last modified time in HTTP format.

Specified by:

getLastModifiedHttp in interface WebResource

Returns:

the last modified time of this resource in the correct format for the HTTP Last-Modified header as specified by RFC 2616.

getETag

public final java.lang.String getETag()

Description copied from interface: WebResource

Returns the weak ETag calculated from the content length and last modified.

Specified by:

getETag in interface WebResource

Returns:

The ETag for this resource

getStrongETag

public final java.lang.String getStrongETag()

Description copied from interface: WebResource

Return the strong ETag if available else return the weak ETag calculated from the content length and last modified.

Specified by:

getStrongETag in interface WebResource

Returns:

The ETag for this resource

setMimeType

public final void setMimeType(java.lang.String mimeType)

Description copied from interface: WebResource

Set the MIME type for this Resource.

Specified by:

setMimeType in interface WebResource

Parameters:

mimeType - The mime type that will be associated with the resource

getMimeType

public final java.lang.String getMimeType()

Description copied from interface: WebResource

Returns the MIME type for this Resource.

Specified by:

getMimeType in interface WebResource

Returns:

the MIME type for this Resource.

getInputStream

public final java.io.InputStream getInputStream()

Description copied from interface: WebResource

Obtains an InputStream based on the contents of this resource.

Specified by:

getInputStream in interface WebResource

Returns:

An InputStream based on the contents of this resource or null if the resource does not exist or does not represent a file

doGetInputStream

protected abstract java.io.InputStream doGetInputStream()

Returns the input stream for this resource.

Returns:

the input stream for this resource

getLog

protected abstract Log getLog()