Module org.refcodes.web

Package org.refcodes.web

Interface BearerAuthCredentials

All Superinterfaces:

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

All Known Implementing Classes:

BeararAuthCredentialsImpl

public interface BearerAuthCredentials
extends TokenCredentials, AuthTypeCredentials<BearerAuthCredentials,TokenCredentials>

This interface defines a type for representing a Bearer-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 BearerAuthCredentials type, call AuthTypeCredentials.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

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 aToken)	Validates the provided user-name and secret with this BearerAuthCredentials via TokenCredentials.isValid(String).
default void	validate(TokenCredentials aCredentials)	Validates the provided TokenCredentials with this BearerAuthCredentials via TokenCredentials.isValid(TokenCredentials).
default BearerAuthCredentials	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.mixin.TokenAccessor

getToken

Methods inherited from interface org.refcodes.web.TokenCredentials

isValid, isValid

Field Detail

DELIMITER_AUTH_TYPE

static final char DELIMITER_AUTH_TYPE

See Also:

Constant Field Values

Method Detail

validate

default 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

default 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

default 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

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