Module org.refcodes.web

Package org.refcodes.web

Interface AuthTypeCredentials<T extends AuthTypeCredentials<T,V>,V extends org.refcodes.mixin.Validatable<V>>

Type Parameters:

T - The implementing type to be e.g. returned by according builder methods and Super-Type of V.

V - The lest common super-type of T which can be used to validate credentials.

All Superinterfaces:

AuthTypeAccessor, org.refcodes.mixin.Validatable<V>

All Known Implementing Classes:

BasicAuthCredentials, BasicAuthCredentialsBuilder, BearerAuthCredentials

public interface AuthTypeCredentials<T extends AuthTypeCredentials<T,V>,V extends org.refcodes.mixin.Validatable<V>>
extends org.refcodes.mixin.Validatable<V>, AuthTypeAccessor

The Interface AuthTypeCredentials.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.web.AuthTypeAccessor

AuthTypeAccessor.AuthTypeBuilder<B extends AuthTypeAccessor.AuthTypeBuilder<B>>, AuthTypeAccessor.AuthTypeMutator, AuthTypeAccessor.AuthTypeProperty

Method Summary

Modifier and Type	Method	Description
void	fromHttpAuthorization(String aHttpAuthorization)	Initializes this AuthTypeCredentials instance from the HeaderField.AUTHORIZATION Header-Fields's value.
String	toHttpAuthorization()	Creates a HeaderField.AUTHORIZATION HTTP Header-Field value from the AuthTypeCredentials instance.
void	validate(V aCredentials)	Validates the provided BasicCredentials with this BasicAuthCredentials via Validatable.isValid(Object).
T	withHttpAuthorization(String aHttpAuthorization)	Initializes this AuthTypeCredentials instance from the HeaderField.AUTHORIZATION Header-Fields's value.

Methods inherited from interface org.refcodes.web.AuthTypeAccessor

getAuthType

Methods inherited from interface org.refcodes.mixin.Validatable

isValid

Method Detail

toHttpAuthorization

String toHttpAuthorization()

Creates a HeaderField.AUTHORIZATION HTTP Header-Field value from the AuthTypeCredentials instance.

Returns:

The according HTTP Header-Field's value.

fromHttpAuthorization

void fromHttpAuthorization(String aHttpAuthorization)
                    throws IllegalArgumentException

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

Parameters:

aHttpAuthorization - The HeaderField.AUTHORIZATION header field's value

Throws:

IllegalArgumentException - The value does not conform the the HTTP Authorization Header-Field's Basic-Authentication format.

withHttpAuthorization

T withHttpAuthorization(String aHttpAuthorization)
                 throws IllegalArgumentException

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

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.

validate

void validate(V aCredentials)
       throws ForbiddenException

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

Parameters:

aCredentials - The BasicCredentials to be verified.

Throws:

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