org.refcodes.net

Interface BasicAuthCredentials

All Superinterfaces:

org.refcodes.mixin.LoginAccessor, org.refcodes.mixin.SecretAccessor, org.refcodes.mixin.UserNameAccessor

All Known Implementing Classes:

BasicAuthCredentialsImpl

public interface BasicAuthCredentials
extends org.refcodes.mixin.LoginAccessor

Property containing basic authentication credentials.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.LoginAccessor

org.refcodes.mixin.LoginAccessor.LoginBuilder<B extends org.refcodes.mixin.LoginAccessor.LoginBuilder<B>>, org.refcodes.mixin.LoginAccessor.LoginMutator, org.refcodes.mixin.LoginAccessor.LoginProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.UserNameAccessor

org.refcodes.mixin.UserNameAccessor.UserNameBuilder<B extends org.refcodes.mixin.UserNameAccessor.UserNameBuilder<B>>, org.refcodes.mixin.UserNameAccessor.UserNameMutator, org.refcodes.mixin.UserNameAccessor.UserNameProperty

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 and Description
static String	BASIC_AUTH
static char	DELIMITER_BASIC_AUTH
static char	DELIMITER_CREDENTIALS

Method Summary

Modifier and Type	Method and Description
void	fromHttpAuthorization(String aHttpAuthorization) Initializes this BasicAuthCredentials instance from the HeaderField.AUTHORIZATION header fields's value.
default String	toHttpAuthorization() Creates a HeaderField.AUTHORIZATION HTTP header field value from the BasicAuthCredentials instance.

Methods inherited from interface org.refcodes.mixin.UserNameAccessor

getUserName

Methods inherited from interface org.refcodes.mixin.SecretAccessor

getSecret

Field Detail

BASIC_AUTH

static final String BASIC_AUTH

See Also:

Constant Field Values

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 Detail

toHttpAuthorization

default String toHttpAuthorization()

Creates a HeaderField.AUTHORIZATION HTTP header field value from the BasicAuthCredentials instance.

Returns:

The according HTTP header field's value.

fromHttpAuthorization

void fromHttpAuthorization(String aHttpAuthorization)
                    throws IllegalArgumentException

Initializes this BasicAuthCredentials 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.