Package dev.getelements.elements.security

Class AuthorizationHeader

java.lang.Object

dev.getelements.elements.security.AuthorizationHeader

public class AuthorizationHeader
extends Object

Created by patricktwohig on 6/26/17.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTH_HEADER	Constant for the Authorization header.
static final String	AUTH_TYPE_BASIC	Used in conjunction with the standard Authorization header.
static final String	AUTH_TYPE_BEARER	Used in conjunction with the standard Authorization header.

Constructor Summary

Constructors

Constructor	Description
AuthorizationHeader(String header)	Parses the supplied header string, throwing an instance of AuthorizationHeaderParseException if the header does not correctly parse.

Method Summary

Modifier and Type	Method	Description
BasicAuthorizationHeader	asBasicHeader(String encoding)	Returns the credentials as a basic authorization header.
BearerAuthorizationHeader	asBearerHeader()	Returns the credentials as a bearer token authorization header.
String	getType()
static <T> Optional<AuthorizationHeader>	withOptionalValueSupplier(HeaderOptionalSupplier<T> headerOptionalSupplier)	Constructs an instance of AuthorizationHeader with the supplied HeaderOptionalSupplier<T>.
static <T> Optional<AuthorizationHeader>	withValueSupplier(Function<String,T> valueSupplier)

Methods inherited from class java.lang.Object

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

Field Details

AUTH_HEADER

public static final String AUTH_HEADER

Constant for the Authorization header.

See Also:

• Constant Field Values

AUTH_TYPE_BASIC

public static final String AUTH_TYPE_BASIC

Used in conjunction with the standard Authorization header. This is used to trigger an attempt to authorize the user via HTTP Basic auth

See Also:

• Constant Field Values

AUTH_TYPE_BEARER

public static final String AUTH_TYPE_BEARER

Used in conjunction with the standard Authorization header. This is used to trigger an attempt to authorize the user via HTTP Basic auth

See Also:

• Constant Field Values

Constructor Details

AuthorizationHeader

public AuthorizationHeader(String header)

Parses the supplied header string, throwing an instance of AuthorizationHeaderParseException if the header does not correctly parse.

Parameters:

header - the header

Method Details

withValueSupplier

public static <T> Optional<AuthorizationHeader> withValueSupplier(Function<String,T> valueSupplier)

withOptionalValueSupplier

public static <T> Optional<AuthorizationHeader> withOptionalValueSupplier(HeaderOptionalSupplier<T> headerOptionalSupplier)

Constructs an instance of AuthorizationHeader with the supplied HeaderOptionalSupplier<T>. If the supplied HeaderOptionalSupplier<T> does not supply a header the returned Optional<AuthorizationHeader> will be empty.

Type Parameters:

T - the type of header result

Parameters:

headerOptionalSupplier - the HeaderOptionalSupplier<T> supplying the header values

getType

public String getType()

asBasicHeader

public BasicAuthorizationHeader asBasicHeader(String encoding)

Returns the credentials as a basic authorization header.

Parameters:

encoding - the encoding to use when parsing the header.

Returns:

the BasicAuthorizationHeader

Throws:

AuthorizationHeaderParseException - if it is not possible to construct the instance of BasicAuthorizationHeader

AuthorizationHeaderParseException - if it is not possible to construct the instance of BasicAuthorizationHeader

asBearerHeader

public BearerAuthorizationHeader asBearerHeader()

Returns the credentials as a bearer token authorization header.

Returns:

the BearerAuthorizationHeader

Throws:

AuthorizationHeaderParseException - if it is not possible to construct the instance of BearerAuthorizationHeader