org.w3c.jigsaw.filters
Class HeaderFilter
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.HeaderFilter
- public class HeaderFilter
- extends ResourceFilter
Enforces a specific header value on all replies.
Usefull for testing.
Field Summary |
protected static int |
ATTR_CONNECTION
Attribute index - Should we use connection on that header. |
protected static int |
ATTR_HEADER_NAME
Attribute index - The header name to add to replies. |
protected static int |
ATTR_HEADER_VALUE
Attribute index - The header value. |
protected static int |
ATTR_NOCACHE
Attribute index - SHould we use no-cache on that header. |
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,
initialize,
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,
updateAttributes |
Methods inherited from class org.w3c.tools.resources.AttributeHolder |
definesAttribute,
definesAttribute,
getAttributes,
getBoolean,
getChar,
getClone,
getClone,
getDouble,
getFloat,
getInt,
getLong,
getString,
getValue,
initialize,
lookupAttribute,
pickleValues,
print,
setBoolean,
setChar,
setDouble,
setFloat,
setInt,
setLong,
setString,
setValue |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
ATTR_HEADER_NAME
protected static int ATTR_HEADER_NAME
- Attribute index - The header name to add to replies.
ATTR_HEADER_VALUE
protected static int ATTR_HEADER_VALUE
- Attribute index - The header value.
ATTR_NOCACHE
protected static int ATTR_NOCACHE
- Attribute index - SHould we use no-cache on that header.
ATTR_CONNECTION
protected static int ATTR_CONNECTION
- Attribute index - Should we use connection on that header.
HeaderFilter
public HeaderFilter()
getHeaderName
public java.lang.String getHeaderName()
- Get the header to set, if any.
- Returns:
- A String encoded header name, or null.
getHeaderValue
public java.lang.String getHeaderValue()
- Get the header value to set, if any.
- Returns:
- A String encoded value for the header to set, or
null.
checkNoCache
public boolean checkNoCache()
- Should we add this header's name to the
no-cache
directive.
- Returns:
- A boolean.
checkConnection
public boolean checkConnection()
- Should we add this header to the connection header.
- Returns:
- A boolean.
ingoingFilter
public ReplyInterface ingoingFilter(RequestInterface request)
throws ProtocolException
- Description copied from class: ResourceFilter
- Simplified ingoingFilter API.
This is a default, simplified API to the ingoing filter method.
- Overrides:
- ingoingFilter in class ResourceFilter
- 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)
throws ProtocolException
- The outgoing filter decorates the reply appropriately.
- Overrides:
- outgoingFilter in class ResourceFilter
- Parameters:
request
- The original request.reply
- The originial reply.- Returns:
- Always null.
- Throws:
- ProtocolException - If processing should be interrupted,
because an abnormal situation occured.