All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class w3c.jigsaw.auth.AuthFilter 

java.lang.Object
   |
   +----w3c.tools.store.AttributeHolder
           |
           +----w3c.tools.store.Resource
                   |
                   +----w3c.tools.store.ResourceFrame
                           |
                           +----w3c.jigsaw.resources.ResourceFilter
                                   |
                                   +----w3c.jigsaw.auth.AuthFilter
public class AuthFilter
extends ResourceFilter
General authentication filters.

Variable Index

o ATTR_METHODS
Attribute index - The methods protected by the filter.
o ATTR_PRIVATE_CACHABILITY
Attribute index - Is caching allowed in private cache ?
o ATTR_PUBLIC_CACHABILITY
Attribute index - Is public caching of protected documents allowed ?
o ATTR_REALM
Attribute index - The realm name for this filter.
o ATTR_SHARED_CACHABILITY
Attribute index - Is caching allowed by a shared cache ?
o STATE_AUTHTYPE
The authentication method used to authenticate above user.
o STATE_AUTHUSER
The user as authentified from the request.

Constructor Index

o AuthFilter()

Method Index

o authenticate(Request)
Authenticate the request from the given client.
o getMethods()
Get the list of methods that this filter protect
o getPrivateCachability()
Is this document cachable in private caches ?
o getPublicCachability()
Is this document publicly cachable ?
o getRealm()
Get the realm of this filter.
o getSharedCachability()
Is this document cachable in shared caches ?
o lookup(LookupState, LookupResult)
Authenticate the given request for the given client.
o outgoingFilter(Request, Reply)
Add the appropriate cache control directives on the way back.

Variables

o STATE_AUTHUSER 
 public static final String STATE_AUTHUSER
The user as authentified from the request. FIXME

o STATE_AUTHTYPE 
 public static final String STATE_AUTHTYPE
The authentication method used to authenticate above user. FIXME

o ATTR_METHODS 
 protected static int ATTR_METHODS
Attribute index - The methods protected by the filter.

o ATTR_REALM 
 protected static int ATTR_REALM
Attribute index - The realm name for this filter.

o ATTR_SHARED_CACHABILITY 
 protected static int ATTR_SHARED_CACHABILITY
Attribute index - Is caching allowed by a shared cache ?

o ATTR_PRIVATE_CACHABILITY 
 protected static int ATTR_PRIVATE_CACHABILITY
Attribute index - Is caching allowed in private cache ?

o ATTR_PUBLIC_CACHABILITY 
 protected static int ATTR_PUBLIC_CACHABILITY
Attribute index - Is public caching of protected documents allowed ?

Constructors

o AuthFilter 
 public AuthFilter()

Methods

o getMethods 
 public 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.
o getRealm 
 public String getRealm()
Get the realm of this filter.

o getPublicCachability 
 public boolean getPublicCachability()
Is this document publicly cachable ?

Returns:
A boolean.
o getPrivateCachability 
 public boolean getPrivateCachability()
Is this document cachable in private caches ?

Returns:
A boolean.
o getSharedCachability 
 public boolean getSharedCachability()
Is this document cachable in shared caches ?

Returns:
A boolean.
o authenticate 
 public void authenticate(Request request) throws HTTPException
Authenticate the request from the given client. An authentication filter should only override this method.

Parameters:
request - The request to be handled.
Throws: HTTPException
If authentication failed.
o lookup 
 public boolean lookup(LookupState ls,
                       LookupResult lr) throws HTTPException
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: HTTPException
If authentication failed.
Overrides:
lookup in class ResourceFilter
o outgoingFilter 
 public Reply outgoingFilter(Request request,
                             Reply reply) throws HTTPException
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 
All Packages  Class Hierarchy  This Package  Previous  Next  Index