org.attribyte.api.http

Class AuthScheme

java.lang.Object

org.attribyte.api.http.AuthScheme

Direct Known Subclasses:

BasicAuthScheme

public abstract class AuthScheme
extends java.lang.Object

Defines a HTTP authentication scheme.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHENTICATE_RESPONSE_HEADER The authenticate response header name ('WWW-Authenticate').
java.lang.String	authenticateResponseHeader
static java.lang.String	DEFAULT_UNAUTHORIZED_MESSAGE The default message sent when unauthorized ('Authorization Required').
java.lang.String	realm
java.lang.String	scheme

Method Summary

Modifier and Type	Method and Description
abstract Request	addAuth(Request request, java.lang.String userId, java.lang.String secret) Adds authentication credentials to a request.
abstract Response	authenticate(Request request, java.lang.String userId, java.lang.String secret) Authenticates the request.
boolean	equals(java.lang.Object o)
java.lang.String	getAuthenticateResponseHeader() Gets the value for the WWW-Authenticate header.
java.lang.String	getRealm() Gets the realm.
java.lang.String	getScheme() Gets the scheme.
Response	getUnauthorizedResponse(java.lang.String message) Creates a challenge response.
abstract java.lang.String	getUserId(Request request) Gets the user id from the request, if possible.
abstract boolean	hasCredentials(Request request) Determines if the request has any (invalid or valid) credentials for this scheme.
int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_UNAUTHORIZED_MESSAGE

public static final java.lang.String DEFAULT_UNAUTHORIZED_MESSAGE

The default message sent when unauthorized ('Authorization Required').

See Also:

Constant Field Values

AUTHENTICATE_RESPONSE_HEADER

public static final java.lang.String AUTHENTICATE_RESPONSE_HEADER

The authenticate response header name ('WWW-Authenticate').

See Also:

Constant Field Values

scheme

public final java.lang.String scheme

realm

public final java.lang.String realm

authenticateResponseHeader

public final java.lang.String authenticateResponseHeader

Method Detail

hasCredentials

public abstract boolean hasCredentials(Request request)

Determines if the request has any (invalid or valid) credentials for this scheme.

Parameters:

request - The request.

Returns:

Does the request appear to have appropriate credentials?

addAuth

public abstract Request addAuth(Request request,
                                java.lang.String userId,
                                java.lang.String secret)
                         throws java.security.GeneralSecurityException

Adds authentication credentials to a request.

Parameters:

request - The request to which credentials are added.

userId - An id that uniquely identifies the user (e.g. 'username').

secret - The authentication secret for the username.

Returns:

The request with authentication credentials added.

Throws:

java.security.GeneralSecurityException

getUserId

public abstract java.lang.String getUserId(Request request)
                                    throws java.security.GeneralSecurityException

Gets the user id from the request, if possible.

Parameters:

request - The request.

Returns:

The user id, or null if none.

Throws:

java.security.GeneralSecurityException

authenticate

public abstract Response authenticate(Request request,
                                      java.lang.String userId,
                                      java.lang.String secret)
                               throws java.security.GeneralSecurityException

Authenticates the request.

Parameters:

request - The request.

userId - The user id for the secret.

secret - The secret data.

Returns:

The HTTP "Unauthorized" response if request is not authorized, otherwise null.

Throws:

java.security.GeneralSecurityException

getUnauthorizedResponse

public Response getUnauthorizedResponse(java.lang.String message)

Creates a challenge response.

By default, returns the standard HTTP challenge response.

Parameters:

message - A message returned with the response. If null, a standard message is returned.

Returns:

The response.

getScheme

public java.lang.String getScheme()

Gets the scheme.

Returns:

The scheme.

getRealm

public java.lang.String getRealm()

Gets the realm.

Returns:

The realm.

getAuthenticateResponseHeader

public java.lang.String getAuthenticateResponseHeader()

Gets the value for the WWW-Authenticate header.

Returns:

The header value.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object