Class BasicCredentials

java.lang.Object

org.refcodes.web.BasicCredentials

All Implemented Interfaces:

CredentialsAccessor, IdentityAccessor, SecretAccessor, Validatable<BasicCredentials>

Direct Known Subclasses:

BasicAuthCredentials

public class BasicCredentials
extends Object
implements CredentialsAccessor, Validatable<BasicCredentials>

The BasicCredentials describes the attributes required by a Basic-Auth authentication over HTTP(S).

Nested Class Summary

Nested classes/interfaces inherited from interface CredentialsAccessor

CredentialsAccessor.CredentialsBuilder<B>, CredentialsAccessor.CredentialsMutator, CredentialsAccessor.CredentialsProperty

Nested classes/interfaces inherited from interface IdentityAccessor

IdentityAccessor.IdentityBuilder<B>, IdentityAccessor.IdentityMutator, IdentityAccessor.IdentityProperty

Nested classes/interfaces inherited from interface SecretAccessor

SecretAccessor.SecretBuilder<B>, SecretAccessor.SecretMutator, SecretAccessor.SecretProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_identity
protected String	_secret

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasicCredentials()	Instantiates a new basic credentials impl.
	BasicCredentials(String aIdentity, String aSecret)	Instantiates a new basic credentials impl.

Method Summary

Modifier and Type	Method	Description
String	getIdentity()
String	getSecret()
boolean	isValid(String aUserName, String aSecret)	Validates the provided user-name and secret against this BasicCredentials user-name and secret.
boolean	isValid(BasicCredentials aCredentials)	Validates the provided BasicCredentials against this BasicCredentials user-name and secret.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_identity

protected String _identity

_secret

protected String _secret

Constructor Details

BasicCredentials

protected BasicCredentials()

Instantiates a new basic credentials impl.

BasicCredentials

public BasicCredentials(String aIdentity,
 String aSecret)

Instantiates a new basic credentials impl.

Parameters:

aIdentity - the user name

aSecret - the secret

Method Details

isValid

public boolean isValid(BasicCredentials aCredentials)

Validates the provided BasicCredentials against this BasicCredentials user-name and secret. If this BasicCredentials instance's user-name or password are null, then false is returned.

Specified by:

isValid in interface Validatable<BasicCredentials>

Parameters:

aCredentials - The BasicCredentials to be tested if them fit with the this BasicCredentials instance.

Returns:

True if the BasicCredentials match with the this BasicCredentials instance and this BasicAuthCredentials instance's user-name and secret are not null.

isValid

public boolean isValid(String aUserName,
 String aSecret)

Validates the provided user-name and secret against this BasicCredentials user-name and secret. If this BasicCredentials instance's user-name or password are null, then false is returned.

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.

Returns:

True if the user-name and secret match with the this BasicCredentials instance and this BasicAuthCredentials instance's user-name and secret are not null.

getIdentity

public String getIdentity()

Specified by:

getIdentity in interface IdentityAccessor

getSecret

public String getSecret()

Specified by:

getSecret in interface SecretAccessor