Class w3c.jigsaw.auth.AuthFilter
All Packages Class Hierarchy This Package Previous Next Index
Class w3c.jigsaw.auth.AuthFilter
java.lang.Object
|
+----w3c.jigsaw.resources.AttributeHolder
|
+----w3c.jigsaw.resources.Resource
|
+----w3c.jigsaw.resources.ResourceFilter
|
+----w3c.jigsaw.auth.AuthFilter
- public class AuthFilter
- extends ResourceFilter
General authentication filters.
-
ATTR_METHODS
- Attribute index - The methods protected by the filter.
-
ATTR_REALM
- Attribute index - The realm name for this filter.
-
AuthFilter()
-
-
authenticate(Request)
- Authenticate the request from the given client.
-
getMethods()
- Get the list of methods that this filter protect
-
getRealm()
- Get the realm of this filter.
-
ingoingFilter(Request)
- Authenticate the given request for the given client.
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.
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.
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.
ingoingFilter
public int ingoingFilter(Request request) 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:
- ingoingFilter in class ResourceFilter
All Packages Class Hierarchy This Package Previous Next Index