org.everit.osgi.webresource

Interface WebResource

All Known Implementing Classes:

WebResourceImpl

public interface WebResource

A WebResource is a file that is accessible for everyone can access. E.g.: CSS, JS and image files.

Method Summary

Modifier and Type	Method and Description
org.osgi.framework.Bundle	getBundle() The bundle that offers the WebResource.
Map<ContentEncoding,Integer>	getCacheState() After a WebResource is requested with a ContentEncoding, the content is cached in the memory.
long	getContentLength(ContentEncoding contentEncoding) The length of the content of the WebResource in the specific ContentEncoding.
String	getContentType() The content type of the WebResource.
String	getETag() The calculated ETag of the WebResource that can be used to save bandwidth.
String	getFileName() The fileName of the WebResource.
InputStream	getInputStream(ContentEncoding contentEncoding, int beginIndex) Creates a new InputStream to read the content of the WebResource.
long	getLastModified() The date when the WebResource was last modified.
String	getLastModifiedRFC1123GMT() The RFC1123 GMT representation of the value of getLastModified().
String	getLibrary() The name of the library of the WebResource.
org.osgi.framework.Version	getVersion() The exact version of the WebResource.

Method Detail

getBundle

org.osgi.framework.Bundle getBundle()

The bundle that offers the WebResource.

getCacheState

Map<ContentEncoding,Integer> getCacheState()

After a WebResource is requested with a ContentEncoding, the content is cached in the memory.

Returns:

The size that is occupied by the WebResource in the cache for each ContentEncoding.

getContentLength

long getContentLength(ContentEncoding contentEncoding)

The length of the content of the WebResource in the specific ContentEncoding.

Parameters:

contentEncoding - The ContentEncoding of the WebResource.

Returns:

the length of the content in bytes.

getContentType

String getContentType()

The content type of the WebResource.

getETag

String getETag()

The calculated ETag of the WebResource that can be used to save bandwidth.

getFileName

String getFileName()

The fileName of the WebResource.

getInputStream

InputStream getInputStream(ContentEncoding contentEncoding,
                           int beginIndex)
                    throws IOException

Creates a new InputStream to read the content of the WebResource.

Parameters:

contentEncoding - The ContentEncoding that we should get the data with.

beginIndex - The beginning inded of the content.

Returns:

The generated InputStream.

Throws:

IOException - if a read error occures.

getLastModified

long getLastModified()

The date when the WebResource was last modified. This is normally the date of the resource within the bundle.

getLastModifiedRFC1123GMT

String getLastModifiedRFC1123GMT()

The RFC1123 GMT representation of the value of getLastModified(). This is normally used to pass the Last-Modified response header value.

getLibrary

String getLibrary()

The name of the library of the WebResource. E.g.: jquery.

getVersion

org.osgi.framework.Version getVersion()

The exact version of the WebResource.