Module org.refcodes.web

Package org.refcodes.web

Class BasicAuthRequest

java.lang.Object

org.refcodes.web.BasicAuthRequest

All Implemented Interfaces:

org.refcodes.mixin.Dumpable, BasicAuthCredentialsAccessor, HttpMethodAccessor, UrlAccessor

public class BasicAuthRequest
extends Object
implements BasicAuthCredentialsAccessor, HttpMethodAccessor, UrlAccessor, org.refcodes.mixin.Dumpable

Defines a BasicAuthRequest describes a Baisc-Auth request as of HTTP. See also "https://en.wikipedia.org/wiki/Basic_access_authentication".

Nested Class Summary

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

BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<B extends BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<B>>, BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator, BasicAuthCredentialsAccessor.BasicAuthCredentialsProperty

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

HttpMethodAccessor.HttpMethodBuilder<B extends HttpMethodAccessor.HttpMethodBuilder<B>>, HttpMethodAccessor.HttpMethodMutator, HttpMethodAccessor.HttpMethodProperty

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

UrlAccessor.UrlBuilder, UrlAccessor.UrlMutator, UrlAccessor.UrlProperty

Constructor Summary

Constructors

Constructor	Description
BasicAuthRequest(HttpMethod aHttpMethod, Url aUrl, BasicAuthCredentials aCredentials)	Constructs a BasicAuthRequest instance with required attributes.

Method Summary

Modifier and Type	Method	Description
BasicAuthCredentials	getBasicAuthCredentials()	Retrieves the BasicAuthCredentials from the Basic-Authentication credentials property (or null if there are none such credentials).
HttpMethod	getHttpMethod()	Retrieves the HTTP-Method from the HTTP-Method property.
Url	getUrl()	Retrieves the Url from the Url property.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump, toDump, toPrintable

Constructor Detail

BasicAuthRequest

public BasicAuthRequest(HttpMethod aHttpMethod,
                        Url aUrl,
                        BasicAuthCredentials aCredentials)

Constructs a BasicAuthRequest instance with required attributes.

Parameters:

aHttpMethod - The HttpMethod with which the request has been sent.

aUrl - The Url from which to take the URL specific data.

aCredentials - The credentials retrieved from the request.

Method Detail

getBasicAuthCredentials

public BasicAuthCredentials getBasicAuthCredentials()

Retrieves the BasicAuthCredentials from the Basic-Authentication credentials property (or null if there are none such credentials).

Specified by:

getBasicAuthCredentials in interface BasicAuthCredentialsAccessor

Returns:

The BasicAuthCredentials stored by the basic authentication credentials property (or null if there are none such credentials).

getHttpMethod

public HttpMethod getHttpMethod()

Retrieves the HTTP-Method from the HTTP-Method property.

Specified by:

getHttpMethod in interface HttpMethodAccessor

Returns:

The HTTP-Method stored by the HTTP-Method property.

getUrl

public Url getUrl()

Retrieves the Url from the Url property.

Specified by:

getUrl in interface UrlAccessor

Returns:

The Url stored by the Url property.