Package org.refcodes.net

Interface BearerAuthCredentials

All Superinterfaces:

AuthCredentials<BearerAuthCredentials,BearerCredentials>, AuthTypeAccessor, BearerCredentials, org.refcodes.mixin.TokenAccessor, org.refcodes.mixin.Validatable<BearerCredentials>

All Known Implementing Classes:

BearerAuthCredentialsImpl

public interface BearerAuthCredentials
extends BearerCredentials, AuthCredentials<BearerAuthCredentials,BearerCredentials>

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.net.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_BEARER_AUTH

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 BearerCredentials.isValid(String).
default void	validate(BearerCredentials aCredentials)	Validates the provided BearerCredentials with this BearerAuthCredentials via BearerCredentials.isValid(BearerCredentials).
default BearerAuthCredentials	withHttpAuthorization(String aHttpAuthorization)	Initializes this AuthCredentials instance from the HeaderField.AUTHORIZATION Header-Fields's value.

Methods inherited from interface org.refcodes.net.AuthCredentials

fromHttpAuthorization, toHttpAuthorization

Methods inherited from interface org.refcodes.net.BearerCredentials

isValid, isValid

Methods inherited from interface org.refcodes.mixin.TokenAccessor

getToken

Field Detail

DELIMITER_BEARER_AUTH

static final char DELIMITER_BEARER_AUTH

See Also:

Constant Field Values

Method Detail

validate

default void validate(BearerCredentials aCredentials)
               throws ForbiddenException

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

Specified by:

validate in interface AuthCredentials<BearerAuthCredentials,BearerCredentials>

Parameters:

aCredentials - The BearerCredentials to be verified.

Throws:

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

validate

default void validate(String aToken)
               throws ForbiddenException

Validates the provided user-name and secret with this BearerAuthCredentials via BearerCredentials.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 BearerCredentials instance.

Throws:

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

withHttpAuthorization

default BearerAuthCredentials withHttpAuthorization(String aHttpAuthorization)
                                             throws IllegalArgumentException

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

Specified by:

withHttpAuthorization in interface AuthCredentials<BearerAuthCredentials,BearerCredentials>

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