    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class org.w3c.jigsaw.auth.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

public class AuthFilter
extends ResourceFilter

General authentication filters.

##

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

##

AuthFilter()

##

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

##

STATE_AUTHUSER

     public static final String STATE_AUTHUSER

  The user as authentified from the request. FIXME

STATE_AUTHTYPE

     public static final String STATE_AUTHTYPE

  The authentication method used to authenticate 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 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 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

    All Packages  Class Hierarchy  This Package  Previous  Next  Index