org.attribyte.api.http.impl

Class BasicAuthScheme

java.lang.Object

org.attribyte.api.http.AuthScheme

org.attribyte.api.http.impl.BasicAuthScheme

public class BasicAuthScheme
extends AuthScheme

The Standard (insecure) "Basic" scheme.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTH_HEADER

Fields inherited from class org.attribyte.api.http.AuthScheme

AUTHENTICATE_RESPONSE_HEADER, authenticateResponseHeader, DEFAULT_UNAUTHORIZED_MESSAGE, realm, scheme

Constructor Summary

Constructors

Constructor and Description
BasicAuthScheme() Create a scheme with no realm.
BasicAuthScheme(java.lang.String realm) Create a scheme with a realm.

Method Summary

Modifier and Type	Method and Description
Request	addAuth(Request request, java.lang.String id, java.lang.String secret) Adds authentication credentials to a request.
Response	authenticate(Request request, java.lang.String userId, java.lang.String secret) Authenticates the request.
static java.lang.String	buildAuthHeaderValue(java.lang.String username, java.lang.String password) Builds an auth header.
java.lang.String	getUserId(Request request) Gets the user id from the request, if possible.
boolean	hasCredentials(Request request) Determines if the request has any (invalid or valid) credentials for this scheme.

Methods inherited from class org.attribyte.api.http.AuthScheme

equals, getAuthenticateResponseHeader, getRealm, getScheme, getUnauthorizedResponse, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

AUTH_HEADER

public static final java.lang.String AUTH_HEADER

See Also:

Constant Field Values

Constructor Detail

BasicAuthScheme

public BasicAuthScheme()

Create a scheme with no realm.

BasicAuthScheme

public BasicAuthScheme(java.lang.String realm)

Create a scheme with a realm.

Parameters:

realm - The realm.

Method Detail

addAuth

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

Description copied from class: AuthScheme

Adds authentication credentials to a request.

Specified by:

addAuth in class AuthScheme

Parameters:

request - The request to which credentials are added.

id - 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

hasCredentials

public boolean hasCredentials(Request request)

Description copied from class: AuthScheme

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

Specified by:

hasCredentials in class AuthScheme

Parameters:

request - The request.

Returns:

Does the request appear to have appropriate credentials?

getUserId

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

Description copied from class: AuthScheme

Gets the user id from the request, if possible.

Specified by:

getUserId in class AuthScheme

Parameters:

request - The request.

Returns:

The user id, or null if none.

Throws:

java.security.GeneralSecurityException

authenticate

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

Description copied from class: AuthScheme

Authenticates the request.

Specified by:

authenticate in class AuthScheme

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

buildAuthHeaderValue

public static final java.lang.String buildAuthHeaderValue(java.lang.String username,
                                                          java.lang.String password)

Builds an auth header.

Parameters:

username - The username.

password - The password.

Returns:

The auth header value.