Class CounterFilter

  extended by
      extended by
          extended by
              extended by
                  extended by
                      extended by org.w3c.jigsaw.filters.CounterFilter
All Implemented Interfaces:
java.lang.Cloneable, java.util.EventListener, AttributeChangedListener, FrameEventListener, FilterInterface

public class CounterFilter
extends ResourceFilter

Count the number of hits to the target. This resource maintains the number of hits to some target resource, as one of its persistent attribute. It will decorate the request on the way in with a fake field org.w3c.jigsaw.filters.CounterFilter.count, that will hold the current hit counts for the target resource to use.

Field Summary
protected static int ATTR_COUNTER
          Attribute index - The counter attribute.
static java.lang.String STATE_COUNT
          The name of the piece if state that receives the hit count value.
Fields inherited from class
filterClass, frameListener, resource
Fields inherited from class
ATTR_OID, attrListener, debugEvent, event_disabled, framesRef, structListener
Fields inherited from class
Fields inherited from class
attributes, values
Constructor Summary
Method Summary
 ReplyInterface ingoingFilter(RequestInterface req)
          We count all accesses, even the one that failed.
Methods inherited from class
exceptionFilter, getTargetResource, ingoingFilter, initialize, lookup, outgoingFilter, outgoingFilter, outputFilter, pickleValues
Methods inherited from class
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
addAttributeChangedListener, addStructureChangedListener, collectFramesReference, delete, disableEvent, displayEvent, enableEvent, fireAttributeChangeEvent, fireStructureChangedEvent, fireStructureChangedEvent, frameAdded, frameRemoved, getClone, getFrame, getFrame, getFrameReference, getFrameReference, getFramesReference, getOid, initialize, markModified, notifyUnload, performFrames, postAttributeChangeEvent, postEvent, postStructureChangedEvent, postStructureChangedEvent, registerFrame, registerFrameIfNone, removeAttributeChangedListener, removeStructureChangedListener, setSilentValue, setSilentValue, unregisterFrame
Methods inherited from class
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
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


public static final java.lang.String STATE_COUNT
The name of the piece if state that receives the hit count value. To get to the hit-count, use the getState method of Request, with the following key.

See Also:
Constant Field Values


protected static int ATTR_COUNTER
Attribute index - The counter attribute.

Constructor Detail


public CounterFilter()
Method Detail


public ReplyInterface ingoingFilter(RequestInterface req)
We count all accesses, even the one that failed. We also define the org.w3c.jigsaw.filters.CounterFilter.count request state as the number of hits on that resource (stored as an Integer instance).

ingoingFilter in class ResourceFilter
request - The request being processed.
Always null.