Module org.refcodes.web

Package org.refcodes.web

Class BearerAuthCredentials

java.lang.Object

org.refcodes.web.BearerAuthCredentials

All Implemented Interfaces:

org.refcodes.mixin.TokenAccessor, org.refcodes.mixin.Validatable<TokenCredentials>, AuthTypeAccessor, AuthTypeCredentials<BearerAuthCredentials,TokenCredentials>, TokenCredentials

public class BearerAuthCredentials
extends Object
implements TokenCredentials, AuthTypeCredentials<BearerAuthCredentials,TokenCredentials>

The BearerAuthCredentials defines a type for representing a Bearer-Authentication credentials Header-Field. Parse the Header-Field via fromHttpAuthorization(String) and feed it with the header's HeaderField.AUTHORIZATION field's value. To create the according Header-Field's value from the BearerAuthCredentials type, call toHttpAuthorization().

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.web.AuthTypeAccessor

AuthTypeAccessor.AuthTypeBuilder<B extends AuthTypeAccessor.AuthTypeBuilder<B>>, AuthTypeAccessor.AuthTypeMutator, AuthTypeAccessor.AuthTypeProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.TokenAccessor

org.refcodes.mixin.TokenAccessor.TokenBuilder<B extends org.refcodes.mixin.TokenAccessor.TokenBuilder<B>>, org.refcodes.mixin.TokenAccessor.TokenMutator, org.refcodes.mixin.TokenAccessor.TokenProperty

Field Summary

Fields

Modifier and Type	Field	Description
static char	DELIMITER_AUTH_TYPE

Constructor Summary

Constructors

Constructor	Description
BearerAuthCredentials()	Instantiates a new bearer auth credentials impl.
BearerAuthCredentials(String aToken)	Instantiates a new bearer auth credentials impl.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
void	fromHttpAuthorization(String aHttpAuthorization)	Initializes this AuthTypeCredentials instance from the HeaderField.AUTHORIZATION Header-Fields's value.
AuthType	getAuthType()	Retrieves the AuthType from the Authorization-Type property (or null if there are none such credentials).
String	getToken()
int	hashCode()
String	toHttpAuthorization()	Creates a HeaderField.AUTHORIZATION HTTP Header-Field value from the AuthTypeCredentials instance.
String	toString()
void	validate(String aToken)	Validates the provided user-name and secret with this BearerAuthCredentials via TokenCredentials.isValid(String).
void	validate(TokenCredentials aCredentials)	Validates the provided TokenCredentials with this BearerAuthCredentials via TokenCredentials.isValid(TokenCredentials).
BearerAuthCredentials	withHttpAuthorization(String aHttpAuthorization)	Initializes this AuthTypeCredentials instance from the HeaderField.AUTHORIZATION Header-Fields's value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.refcodes.web.TokenCredentials

isValid, isValid

Field Detail

DELIMITER_AUTH_TYPE

public static final char DELIMITER_AUTH_TYPE

See Also:

Constant Field Values

Constructor Detail

BearerAuthCredentials

public BearerAuthCredentials()

Instantiates a new bearer auth credentials impl.

BearerAuthCredentials

public BearerAuthCredentials(String aToken)

Instantiates a new bearer auth credentials impl.

Parameters:

aToken - the secret

Method Detail

validate

public void validate(TokenCredentials aCredentials)
              throws ForbiddenException

Validates the provided TokenCredentials with this BearerAuthCredentials via TokenCredentials.isValid(TokenCredentials). In case the provided TokenCredentials are not valid, then a ForbiddenException is thrown.

Specified by:

validate in interface AuthTypeCredentials<BearerAuthCredentials,TokenCredentials>

Parameters:

aCredentials - The TokenCredentials to be verified.

Throws:

ForbiddenException - thrown in case the provided TokenCredentials do not match.

validate

public void validate(String aToken)
              throws ForbiddenException

Validates the provided user-name and secret with this BearerAuthCredentials via TokenCredentials.isValid(String). In case the provided credentials are not valid, then a ForbiddenException is thrown.

Parameters:

aToken - The secret part to be tested if it fits with the this TokenCredentials instance.

Throws:

ForbiddenException - thrown in case the provided TokenCredentials do not match.

withHttpAuthorization

public BearerAuthCredentials withHttpAuthorization(String aHttpAuthorization)
                                            throws IllegalArgumentException

Initializes this AuthTypeCredentials instance from the HeaderField.AUTHORIZATION Header-Fields's value.

Specified by:

withHttpAuthorization in interface AuthTypeCredentials<BearerAuthCredentials,TokenCredentials>

Parameters:

aHttpAuthorization - The HeaderField.AUTHORIZATION header field's value

Returns:

the t

Throws:

IllegalArgumentException - The value does not conform the the HTTP Authorization Header-Field's Basic-Authentication format.

getAuthType

public AuthType getAuthType()

Retrieves the AuthType from the Authorization-Type property (or null if there are none such credentials).

Specified by:

getAuthType in interface AuthTypeAccessor

Returns:

The AuthType stored by the Basic-Authentication credentials property (or null if there are none such credentials).

getToken

public String getToken()

Specified by:

getToken in interface org.refcodes.mixin.TokenAccessor

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

fromHttpAuthorization

public void fromHttpAuthorization(String aHttpAuthorization)

Initializes this AuthTypeCredentials instance from the HeaderField.AUTHORIZATION Header-Fields's value.

Specified by:

fromHttpAuthorization in interface AuthTypeCredentials<BearerAuthCredentials,TokenCredentials>

Parameters:

aHttpAuthorization - The HeaderField.AUTHORIZATION header field's value

toHttpAuthorization

public String toHttpAuthorization()

Creates a HeaderField.AUTHORIZATION HTTP Header-Field value from the AuthTypeCredentials instance.

Specified by:

toHttpAuthorization in interface AuthTypeCredentials<BearerAuthCredentials,TokenCredentials>

Returns:

The according HTTP Header-Field's value.