org.w3c.jigsaw.filters
Class SimpleCacheFilter

java.lang.Object
  org.w3c.tools.resources.AttributeHolder
      org.w3c.tools.resources.Resource
          org.w3c.tools.resources.FramedResource
              org.w3c.tools.resources.ResourceFrame
                  org.w3c.tools.resources.ResourceFilter
                      org.w3c.jigsaw.filters.SimpleCacheFilter

All Implemented Interfaces:

java.lang.Cloneable, java.util.EventListener, AttributeChangedListener, FrameEventListener, FilterInterface

public class SimpleCacheFilter
extends ResourceFilter

Field Summary

protected static int	ATTR_DEFAULT_MAX_AGE
protected static int	ATTR_FLUSH
protected static int	ATTR_MAX_ENTRIES
protected static int	ATTR_MAX_SIZE
protected org.w3c.jigsaw.filters.SimpleCache	cache
protected static java.lang.String	STATE_TAG

Fields inherited from class org.w3c.tools.resources.ResourceFrame

filterClass, frameListener, resource

Fields inherited from class org.w3c.tools.resources.FramedResource

ATTR_OID, attrListener, debugEvent, event_disabled, framesRef, structListener

Fields inherited from class org.w3c.tools.resources.Resource

ATTR_CONTEXT, ATTR_HELP_URL, ATTR_IDENTIFIER, ATTR_LAST_MODIFIED, ATTR_PARENT, ATTR_RESOURCE_FRAMES, ATTR_STORE_ENTRY, ATTR_URL, co, id

Fields inherited from class org.w3c.tools.resources.AttributeHolder

attributes, values

Constructor Summary

SimpleCacheFilter()

Method Summary

int	getDefaultMaxAge()
boolean	getFlushFlag()
int	getMaxEntries()
int	getMaxSize()
ReplyInterface	ingoingFilter(RequestInterface req, FilterInterface[] filters, int fidx) The ingoingFilter method.
void	initialize(java.lang.Object[] values) Initialize the frames of that framed resource.
ReplyInterface	outgoingFilter(RequestInterface req, ReplyInterface rep, FilterInterface[] filters, int fidx) The outgoingFilter method.

Methods inherited from class org.w3c.tools.resources.ResourceFilter

exceptionFilter, getTargetResource, ingoingFilter, initialize, lookup, outgoingFilter, outputFilter, pickleValues

Methods inherited from class org.w3c.tools.resources.ResourceFrame

addFrameEventListener, attributeChanged, checkRequest, eventDisabled, fireFrameEvent, frameModified, getFilters, getFilters, getFrameReference, getResource, getResourceReference, getSpaceEntry, getURLPath, lookupFilters, lookupFrames, perform, postFrameEvent, processEvent, registerResource, removeFrameEventListener, setValue, unregisterResource, updateDefaultChildAttributes

Methods inherited from class org.w3c.tools.resources.FramedResource

addAttributeChangedListener, addStructureChangedListener, collectFramesReference, delete, disableEvent, displayEvent, enableEvent, fireAttributeChangeEvent, fireStructureChangedEvent, fireStructureChangedEvent, frameAdded, frameRemoved, getClone, getFrame, getFrame, getFrameReference, getFrameReference, getFramesReference, getOid, markModified, notifyUnload, performFrames, postAttributeChangeEvent, postEvent, postStructureChangedEvent, postStructureChangedEvent, registerFrame, registerFrameIfNone, removeAttributeChangedListener, removeStructureChangedListener, setSilentValue, setSilentValue, unregisterFrame

Methods inherited from class org.w3c.tools.resources.Resource

acceptUnload, checkMultipleLock, collectFrames, getContext, getFrame, getFrames, getHelpURL, getHelpURL, getIdentifier, getLastModified, getParent, getServer, getSpace, getStoreEntry, getValue, getValue, isInitialized, isUnloaded, setContext, setContext, setValue, unsafeGetContext, unsafeGetFrame, unsafeGetFrames, unsafeGetIdentifier, unsafeGetResourceReference, unsafeGetURLPath, unsafeGetValue, updateAttributes

Methods inherited from class org.w3c.tools.resources.AttributeHolder

definesAttribute, definesAttribute, getAttributes, getBoolean, getChar, getClone, getClone, getDouble, getFloat, getInt, getLong, getString, getValue, lookupAttribute, print, setBoolean, setChar, setDouble, setFloat, setInt, setLong, setString, setValue, unsafeDefinesAttribute, unsafeGetDouble, unsafeGetString

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected org.w3c.jigsaw.filters.SimpleCache cache

STATE_TAG

protected static final java.lang.String STATE_TAG

See Also:

Constant Field Values

ATTR_MAX_SIZE

protected static int ATTR_MAX_SIZE

ATTR_MAX_ENTRIES

protected static int ATTR_MAX_ENTRIES

ATTR_DEFAULT_MAX_AGE

protected static int ATTR_DEFAULT_MAX_AGE

ATTR_FLUSH

protected static int ATTR_FLUSH

Constructor Detail

SimpleCacheFilter

public SimpleCacheFilter()

Method Detail

getMaxSize

public int getMaxSize()

getMaxEntries

public int getMaxEntries()

getDefaultMaxAge

public int getDefaultMaxAge()

getFlushFlag

public boolean getFlushFlag()

ingoingFilter

public ReplyInterface ingoingFilter(RequestInterface req,
                                    FilterInterface[] filters,
                                    int fidx)
                             throws ProtocolException

Description copied from class: ResourceFilter

The ingoingFilter method. This is the method that really gets called by Jigsaw core. By default it will invoke the simpler ingoingFilter method, taking only the request has a parameter.

Specified by:

ingoingFilter in interface FilterInterface

Overrides:

ingoingFilter in class ResourceFilter

Parameters:

req - The request that is about to be handled.

filters - The whole filter list to be applied to the resource.

fidx - A pointer into the above array, indicating which filters have already been triggered (the one whose index are lower than i), and what filters have to be triggered (the one whose index are greater or equal to i+1).

Returns:

A Reply instance, if the filter did know how to answer the request without further processing, null otherwise.

Throws:

ProtocolException - If processing should be interrupted, because an abnormal situation occured.

outgoingFilter

public ReplyInterface outgoingFilter(RequestInterface req,
                                     ReplyInterface rep,
                                     FilterInterface[] filters,
                                     int fidx)
                              throws ProtocolException

Description copied from class: ResourceFilter

The outgoingFilter method. This method is the one that gets called by Jigsaw core. By default it will call the simpler outgoingFilter method that takes only the request and the reply as parameters.

Specified by:

outgoingFilter in interface FilterInterface

Overrides:

outgoingFilter in class ResourceFilter

Parameters:

request - The original request.

reply - It's original reply.

Returns:

A Reply instance, or null if processing should continue normally.

Throws:

ProtocolException - If processing should be interrupted, because an abnormal situation occured.

initialize

public void initialize(java.lang.Object[] values)

Description copied from class: FramedResource

Initialize the frames of that framed resource.

Overrides:

initialize in class FramedResource

Parameters:

values - Default attribute values.