org.everit.osgi.webresource.internal

Class WebResourceImpl

java.lang.Object

org.everit.osgi.webresource.internal.WebResourceImpl

All Implemented Interfaces:

WebResource

public class WebResourceImpl
extends Object
implements WebResource

Implementation of WebResource interface.

Constructor Summary

Constructors

Constructor and Description
WebResourceImpl(org.osgi.framework.Bundle bundle, String library, String fileName, URL resourceURL, org.osgi.framework.Version version, String contentType) Constructor.

Method Summary

Modifier and Type	Method and Description
void	destroy()
boolean	equals(Object obj)
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 WebResource.getLastModified().
String	getLibrary() The name of the library of the WebResource.
int	getRawLength()
org.osgi.framework.Version	getVersion() The exact version of the WebResource.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebResourceImpl

public WebResourceImpl(org.osgi.framework.Bundle bundle,
                       String library,
                       String fileName,
                       URL resourceURL,
                       org.osgi.framework.Version version,
                       String contentType)

Constructor.

Parameters:

bundle - The bundle that holds the WebResource.

library - The library name of the WebResource.

fileName - The name of the WebResource.

resourceURL - The URL where the raw content of the WebResource is available.

version - Version of the WebResource.

contentType - The content type of the WebResource.

Method Detail

destroy

public void destroy()

equals

@Generated(value="eclipse")
public boolean equals(Object obj)

Overrides:

equals in class Object

getBundle

public org.osgi.framework.Bundle getBundle()

Description copied from interface: WebResource

The bundle that offers the WebResource.

Specified by:

getBundle in interface WebResource

getCacheState

public Map<ContentEncoding,Integer> getCacheState()

Description copied from interface: WebResource

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

Specified by:

getCacheState in interface WebResource

Returns:

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

getContentLength

public long getContentLength(ContentEncoding contentEncoding)

Description copied from interface: WebResource

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

Specified by:

getContentLength in interface WebResource

Parameters:

contentEncoding - The ContentEncoding of the WebResource.

Returns:

the length of the content in bytes.

getContentType

public String getContentType()

Description copied from interface: WebResource

The content type of the WebResource.

Specified by:

getContentType in interface WebResource

getETag

public String getETag()

Description copied from interface: WebResource

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

Specified by:

getETag in interface WebResource

getFileName

public String getFileName()

Description copied from interface: WebResource

The fileName of the WebResource.

Specified by:

getFileName in interface WebResource

getInputStream

public InputStream getInputStream(ContentEncoding contentEncoding,
                                  int beginIndex)
                           throws IOException

Description copied from interface: WebResource

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

Specified by:

getInputStream in interface 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

public long getLastModified()

Description copied from interface: WebResource

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

Specified by:

getLastModified in interface WebResource

getLastModifiedRFC1123GMT

public String getLastModifiedRFC1123GMT()

Description copied from interface: WebResource

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

Specified by:

getLastModifiedRFC1123GMT in interface WebResource

getLibrary

public String getLibrary()

Description copied from interface: WebResource

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

Specified by:

getLibrary in interface WebResource

getRawLength

public int getRawLength()

getVersion

public org.osgi.framework.Version getVersion()

Description copied from interface: WebResource

The exact version of the WebResource.

Specified by:

getVersion in interface WebResource

hashCode

@Generated(value="eclipse")
public int hashCode()

Overrides:

hashCode in class Object