org.w3c.jigsaw.auth
Class AuthFilter
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.auth.AuthFilter
- Direct Known Subclasses:
- DigestAuthFilter, GenericAuthFilter
- public class AuthFilter
- extends ResourceFilter
General authentication filters.
Field Summary |
protected static int |
ATTR_METHODS
Attribute index - The methods protected by the filter. |
protected static int |
ATTR_PRIVATE_CACHABILITY
Attribute index - Is caching allowed in private cache ? |
protected static int |
ATTR_PUBLIC_CACHABILITY
Attribute index - Is public caching of protected documents allowed ? |
protected static int |
ATTR_REALM
Attribute index - The realm name for this filter. |
protected static int |
ATTR_SHARED_CACHABILITY
Attribute index - Is caching allowed by a shared cache ? |
static java.lang.String |
STATE_AUTHCONTEXT
The authentication context used to authenticate the above user
FIXME |
static java.lang.String |
STATE_AUTHTYPE
The authentication method used to authenticate above user. |
static java.lang.String |
STATE_AUTHUSER
The user as authentified from the request. |
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,
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,
pickle,
print,
setBoolean,
setChar,
setDouble,
setFloat,
setInt,
setLong,
setString,
setValue,
unpickle,
unpickle,
unpickle,
unpickleInstance,
unpickleInstance |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
STATE_AUTHUSER
public static final java.lang.String STATE_AUTHUSER
- The user as authentified from the request.
FIXME
STATE_AUTHTYPE
public static final java.lang.String STATE_AUTHTYPE
- The authentication method used to authenticate above user.
FIXME
STATE_AUTHCONTEXT
public static final java.lang.String STATE_AUTHCONTEXT
- The authentication context used to authenticate the above user
FIXME
ATTR_METHODS
protected static int ATTR_METHODS
- Attribute index - The methods protected by the filter.
ATTR_REALM
protected static int ATTR_REALM
- Attribute index - The realm name for this filter.
ATTR_SHARED_CACHABILITY
protected static int ATTR_SHARED_CACHABILITY
- Attribute index - Is caching allowed by a shared cache ?
ATTR_PRIVATE_CACHABILITY
protected static int ATTR_PRIVATE_CACHABILITY
- Attribute index - Is caching allowed in private cache ?
ATTR_PUBLIC_CACHABILITY
protected static int ATTR_PUBLIC_CACHABILITY
- Attribute index - Is public caching of protected documents allowed ?
AuthFilter
public AuthFilter()
getMethods
public java.lang.String[] getMethods()
- Get the list of methods that this filter protect
- Returns:
- An array of String giving the name of the protected methods,
or null, in wich case all methods are
to be protected.
getRealm
public java.lang.String getRealm()
- Get the realm of this filter.
getPublicCachability
public boolean getPublicCachability()
- Is this document publicly cachable ?
- Returns:
- A boolean.
getPrivateCachability
public boolean getPrivateCachability()
- Is this document cachable in private caches ?
- Returns:
- A boolean.
getSharedCachability
public boolean getSharedCachability()
- Is this document cachable in shared caches ?
- Returns:
- A boolean.
authenticate
public void authenticate(Request request)
throws ProtocolException
- Authenticate the request from the given client.
An authentication filter should only override this method.
- Parameters:
request
- The request to be handled.- Throws:
- ProtocolException - If authentication failed.
lookup
public boolean lookup(LookupState ls,
LookupResult lr)
throws ProtocolException
- Authenticate the given request for the given client.
This method is invoked prior to any request handling on its target
entity. If the used authentication method allows so, AuthFilters
should set the authuser attribute of the request.
- Parameters:
request
- The request.- Throws:
- ProtocolException - If authentication failed.
- Overrides:
- lookup in class ResourceFilter
outgoingFilter
public ReplyInterface outgoingFilter(RequestInterface request,
ReplyInterface reply)
- Add the appropriate cache control directives on the way back.
- Parameters:
request
- The request that has been processed.reply
- The original reply.- Returns:
- Always null.
- Overrides:
- outgoingFilter in class ResourceFilter