org.openqa.jetty.util

Class CachedResource

java.lang.Object

org.openqa.jetty.util.Resource

org.openqa.jetty.util.CachedResource

All Implemented Interfaces:

Serializable

public class CachedResource
extends Resource

Cached resource class. This resource caches in memory the contents of another resource. The update() method must be called to check if the real resource has been modified.

Version:

$Id: CachedResource.java,v 1.6 2004/05/09 20:32:49 gregwilkins Exp $

Author:

Greg Wilkins (gregw)

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
Resource	addPath(String path) Returns the resource contained inside the current resource with the given name
void	clear()
boolean	delete() Deletes the given resource
boolean	equals(Object o)
boolean	exists() Returns true if the respresened resource exists.
byte[]	getCachedData()
File	getFile() Returns an File representing the given resource or NULL if this is not possible.
InputStream	getInputStream() Returns an input stream to the resource
String	getName() Returns the name of the resource
OutputStream	getOutputStream() Returns an output stream to the resource
URL	getURL() Returns an URL representing the given resource
int	hashCode()
boolean	isDirectory() Returns true if the respresenetd resource is a container/directory.
boolean	isUptoDate()
long	lastModified() Returns the last modified time
long	length() Return the length of the resource
String[]	list() Returns a list of resource names contained in the given resource
void	release() Release any resources held by the resource.
boolean	renameTo(Resource dest) Rename the given resource
void	setCachedData(byte[] buf)
String	toString()
boolean	update()
void	writeTo(OutputStream os, long startByte, long count)

Methods inherited from class org.openqa.jetty.util.Resource

cache, encode, finalize, getAlias, getAssociate, getListHTML, newResource, newResource, newSystemResource, setAssociate

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Method Detail

isUptoDate

public boolean isUptoDate()
                   throws IOException

Throws:

IOException

update

public boolean update()
               throws IOException

Throws:

IOException

clear

public void clear()

release

public void release()

Release any resources held by the resource.

Specified by:

release in class Resource

exists

public boolean exists()

Returns true if the respresened resource exists.

Specified by:

exists in class Resource

isDirectory

public boolean isDirectory()

Description copied from class: Resource

Returns true if the respresenetd resource is a container/directory. If the resource is not a file, resources ending with "/" are considered directories.

Specified by:

isDirectory in class Resource

lastModified

public long lastModified()

Description copied from class: Resource

Returns the last modified time

Specified by:

lastModified in class Resource

length

public long length()

Description copied from class: Resource

Return the length of the resource

Specified by:

length in class Resource

getURL

public URL getURL()

Description copied from class: Resource

Returns an URL representing the given resource

Specified by:

getURL in class Resource

getFile

public File getFile()
             throws IOException

Description copied from class: Resource

Returns an File representing the given resource or NULL if this is not possible.

Specified by:

getFile in class Resource

Throws:

IOException

getName

public String getName()

Returns the name of the resource

Specified by:

getName in class Resource

getInputStream

public InputStream getInputStream()
                           throws IOException

Returns an input stream to the resource

Specified by:

getInputStream in class Resource

Throws:

IOException

getOutputStream

public OutputStream getOutputStream()
                             throws IOException,
                                    SecurityException

Returns an output stream to the resource

Specified by:

getOutputStream in class Resource

Throws:

IOException

SecurityException

delete

public boolean delete()
               throws SecurityException

Deletes the given resource

Specified by:

delete in class Resource

Throws:

SecurityException

renameTo

public boolean renameTo(Resource dest)
                 throws SecurityException

Rename the given resource

Specified by:

renameTo in class Resource

Throws:

SecurityException

list

public String[] list()

Returns a list of resource names contained in the given resource

Specified by:

list in class Resource

addPath

public Resource addPath(String path)
                 throws IOException,
                        MalformedURLException

Returns the resource contained inside the current resource with the given name

Specified by:

addPath in class Resource

Parameters:

path - The path segment to add, which should be encoded by the encode method.

Throws:

IOException

MalformedURLException

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

writeTo

public void writeTo(OutputStream os,
           long startByte,
           long count)
             throws IOException

Overrides:

writeTo in class Resource

startByte - First byte to write

count - Bytes to write or -1 for all of them.

Throws:

IOException

getCachedData

public byte[] getCachedData()

setCachedData

public void setCachedData(byte[] buf)