Module org.refcodes.web

Package org.refcodes.web

Class BasicAuthCredentials

java.lang.Object

org.refcodes.web.BasicCredentials

org.refcodes.web.BasicAuthCredentials

All Implemented Interfaces:

org.refcodes.mixin.CredentialsAccessor, org.refcodes.mixin.IdentityAccessor, org.refcodes.mixin.SecretAccessor, org.refcodes.mixin.Validatable<BasicCredentials>, AuthTypeAccessor, AuthTypeCredentials<BasicAuthCredentials,BasicCredentials>

Direct Known Subclasses:

BasicAuthCredentialsBuilder

public class BasicAuthCredentials
extends BasicCredentials
implements AuthTypeCredentials<BasicAuthCredentials,BasicCredentials>

The BasicAuthCredentials defines a type for representing a Basic-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 BasicAuthCredentials 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.CredentialsAccessor

org.refcodes.mixin.CredentialsAccessor.CredentialsBuilder<B extends org.refcodes.mixin.CredentialsAccessor.CredentialsBuilder<B>>, org.refcodes.mixin.CredentialsAccessor.CredentialsMutator, org.refcodes.mixin.CredentialsAccessor.CredentialsProperty

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

org.refcodes.mixin.IdentityAccessor.IdentityBuilder<B extends org.refcodes.mixin.IdentityAccessor.IdentityBuilder<B>>, org.refcodes.mixin.IdentityAccessor.IdentityMutator, org.refcodes.mixin.IdentityAccessor.IdentityProperty

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

org.refcodes.mixin.SecretAccessor.SecretBuilder<B extends org.refcodes.mixin.SecretAccessor.SecretBuilder<B>>, org.refcodes.mixin.SecretAccessor.SecretMutator, org.refcodes.mixin.SecretAccessor.SecretProperty

Field Summary

Fields

Modifier and Type	Field	Description
static char	DELIMITER_BASIC_AUTH
static char	DELIMITER_CREDENTIALS

Fields inherited from class org.refcodes.web.BasicCredentials

_identity, _secret

Constructor Summary

Constructors

Constructor	Description
BasicAuthCredentials()	Instantiates a new BasicAuthCredentials instance.
BasicAuthCredentials(String aIdentity, String aSecret)	Instantiates a new BasicAuthCredentials instance.

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	getIdentity()
String	getSecret()
int	hashCode()
String	toHttpAuthorization()	Creates a HeaderField.AUTHORIZATION HTTP Header-Field value from the AuthTypeCredentials instance.
String	toString()
void	validate(String aUserName, String aSecret)	Validates the provided user-name and secret with this BasicAuthCredentials via BasicCredentials.isValid(String, String).
void	validate(BasicCredentials aCredentials)	Validates the provided BasicCredentials with this BasicAuthCredentials via BasicCredentials.isValid(BasicCredentials).
BasicAuthCredentials	withHttpAuthorization(String aHttpAuthorization)	Initializes this AuthTypeCredentials instance from the HeaderField.AUTHORIZATION Header-Fields's value.

Methods inherited from class org.refcodes.web.BasicCredentials

isValid, isValid

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.Validatable

isValid

Field Detail

DELIMITER_BASIC_AUTH

public static final char DELIMITER_BASIC_AUTH

See Also:

Constant Field Values

DELIMITER_CREDENTIALS

public static final char DELIMITER_CREDENTIALS

See Also:

Constant Field Values

Constructor Detail

BasicAuthCredentials

public BasicAuthCredentials()

Instantiates a new BasicAuthCredentials instance.

BasicAuthCredentials

public BasicAuthCredentials(String aIdentity,
                            String aSecret)

Instantiates a new BasicAuthCredentials instance.

Parameters:

aIdentity - the user name

aSecret - the secret

Method Detail

validate

public void validate(BasicCredentials aCredentials)
              throws ForbiddenException

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

Specified by:

validate in interface AuthTypeCredentials<BasicAuthCredentials,BasicCredentials>

Parameters:

aCredentials - The BasicCredentials to be verified.

Throws:

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

validate

public void validate(String aUserName,
                     String aSecret)
              throws ForbiddenException

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

Parameters:

aUserName - The user-name part to be tested if it fits with the this BasicCredentials instance.

aSecret - The secret part to be tested if it fits with the this BasicCredentials instance.

Throws:

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

withHttpAuthorization

public BasicAuthCredentials withHttpAuthorization(String aHttpAuthorization)
                                           throws IllegalArgumentException

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

Specified by:

withHttpAuthorization in interface AuthTypeCredentials<BasicAuthCredentials,BasicCredentials>

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).

getIdentity

public String getIdentity()

Specified by:

getIdentity in interface org.refcodes.mixin.IdentityAccessor

Overrides:

getIdentity in class BasicCredentials

getSecret

public String getSecret()

Specified by:

getSecret in interface org.refcodes.mixin.SecretAccessor

Overrides:

getSecret in class BasicCredentials

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<BasicAuthCredentials,BasicCredentials>

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<BasicAuthCredentials,BasicCredentials>

Returns:

The according HTTP Header-Field's value.