com.bradmcevoy.http
Interface AuthenticationHandler

All Known Implementing Classes:

BasicAuthHandler, DigestAuthenticationHandler, SecurityManagerBasicAuthHandler, SecurityManagerDigestAuthenticationHandler

public interface AuthenticationHandler

Implementations of this interface are authentication methods for use with HTTP. These include basic, digest, ntlm etc

Author:

brad

Method Summary

java.lang.Object	authenticate(Resource resource, Request request) Authenticate the details in the request for access to the given resource.
java.lang.String	getChallenge(Resource resource, Request request) Create a challenge for this authentication method.
boolean	isCompatible(Resource resource) Returns true if this authentication handler is compatible with the given resource This is used when authorisation has failed, in generating challenge responses If you don't want to add a challenge response, return false
boolean	supports(Resource r, Request request) Returns true if this supports authenticating with the given Auth data on the given resource.

Method Detail

supports

boolean supports(Resource r,
                 Request request)

Returns true if this supports authenticating with the given Auth data on the given resource. Only the first AuthenticationHandler which returns true for supports will be used for authentication. Ie supports implementations should be mutually exclusive

Parameters:

r -

auth -

Returns:

authenticate

java.lang.Object authenticate(Resource resource,
                              Request request)

Authenticate the details in the request for access to the given resource.

Parameters:

resource -

request -

Returns:

getChallenge

java.lang.String getChallenge(Resource resource,
                              Request request)

Create a challenge for this authentication method. This should be completely formatted as per http://tools.ietf.org/html/rfc2617

Parameters:

resource -

request -

Returns:

isCompatible

boolean isCompatible(Resource resource)

Returns true if this authentication handler is compatible with the given resource This is used when authorisation has failed, in generating challenge responses If you don't want to add a challenge response, return false

Parameters:

resource -

Returns:

- true if this can authenticate the resource, and it should issue a http challenge