Module org.refcodes.web

Package org.refcodes.web

Interface BasicAuthCredentials

All Superinterfaces:

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

All Known Subinterfaces:

BasicAuthCredentials.BasicAuthCredentialsBuilder

All Known Implementing Classes:

BasicAuthCredentialsBuilderImpl, BasicAuthCredentialsImpl

public interface BasicAuthCredentials
extends BasicCredentials, AuthTypeCredentials<BasicAuthCredentials,BasicCredentials>

This interface defines a type for representing a Basic-Authentication credentials Header-Field. Parse the Header-Field via AuthTypeCredentials.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 AuthTypeCredentials.toHttpAuthorization().

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BasicAuthCredentials.BasicAuthCredentialsBuilder	Builder type for the BasicAuthCredentials type.

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

Method Summary

Modifier and Type	Method	Description
default AuthType	getAuthType()	Retrieves the AuthType from the Authorization-Type property (or null if there are none such credentials).
default void	validate(String aUserName, String aSecret)	Validates the provided user-name and secret with this BasicAuthCredentials via BasicCredentials.isValid(String, String).
default void	validate(BasicCredentials aCredentials)	Validates the provided BasicCredentials with this BasicAuthCredentials via BasicCredentials.isValid(BasicCredentials).
default BasicAuthCredentials	withHttpAuthorization(String aHttpAuthorization)	Initializes this AuthTypeCredentials instance from the HeaderField.AUTHORIZATION Header-Fields's value.

Methods inherited from interface org.refcodes.web.AuthTypeCredentials

fromHttpAuthorization, toHttpAuthorization

Methods inherited from interface org.refcodes.web.BasicCredentials

isValid, isValid

Methods inherited from interface org.refcodes.mixin.IdentityAccessor

getIdentity

Methods inherited from interface org.refcodes.mixin.SecretAccessor

getSecret

Field Details

DELIMITER_BASIC_AUTH

static final char DELIMITER_BASIC_AUTH

See Also:

Constant Field Values

DELIMITER_CREDENTIALS

static final char DELIMITER_CREDENTIALS

See Also:

Constant Field Values

Method Details

validate

default 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

default 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

default 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

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