Class BasicAuthEvent

java.lang.Object

org.refcodes.web.BasicAuthRequest

org.refcodes.rest.BasicAuthEvent

All Implemented Interfaces:

ActionAccessor<HttpMethod>, SourceAccessor<RestServer>, WildcardSubstitutes, ActionEvent<HttpMethod, RestServer>, Event<RestServer>, BasicAuthCredentialsAccessor, HttpMethodAccessor, LocalAddressAccessor, RealmAccessor, RemoteAddressAccessor, UrlAccessor

public class BasicAuthEvent
extends BasicAuthRequest
implements ActionEvent<HttpMethod, RestServer>, WildcardSubstitutes, RealmAccessor, LocalAddressAccessor, RemoteAddressAccessor

The BasicAuthEvent describes a BasicAuthRequest being the request as consumed by a RestEndpoint. Usually you will use RestServer.onRequest(HttpMethod, String, RestRequestConsumer) for registering a RestRequestConsumer to the RestServer ( HttpRestServer).

Nested Class Summary

Nested classes/interfaces inherited from interface ActionAccessor

ActionAccessor.ActionBuilder<A,B>, ActionAccessor.ActionMutator<A>, ActionAccessor.ActionProperty<A>

Nested classes/interfaces inherited from interface BasicAuthCredentialsAccessor

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

Nested classes/interfaces inherited from interface HttpMethodAccessor

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

Nested classes/interfaces inherited from interface LocalAddressAccessor

LocalAddressAccessor.LocalAddressBuilder<B>, LocalAddressAccessor.LocalAddressMutator, LocalAddressAccessor.LocalAddressProperty

Nested classes/interfaces inherited from interface RealmAccessor

RealmAccessor.RealmBuilder<B>, RealmAccessor.RealmMutator, RealmAccessor.RealmProperty

Nested classes/interfaces inherited from interface RemoteAddressAccessor

RemoteAddressAccessor.RemoteAddressBuilder<B>, RemoteAddressAccessor.RemoteAddressMutator, RemoteAddressAccessor.RemoteAddressProperty

Nested classes/interfaces inherited from interface SourceAccessor

SourceAccessor.SourceBuilder<SRC,B>, SourceAccessor.SourceMutator<SRC>, SourceAccessor.SourceProperty<SRC>

Nested classes/interfaces inherited from interface UrlAccessor

UrlAccessor.UrlBuilder, UrlAccessor.UrlMutator, UrlAccessor.UrlProperty

Constructor Summary

Constructors

Constructor	Description
BasicAuthEvent(InetSocketAddress aLocalAddress, InetSocketAddress aRemoteAddress, HttpMethod aHttpMethod, Url aUrl, WildcardSubstitutes aWildcardSubstitutes, BasicAuthCredentials aCredentials, String aRealm, RestServer aRestServer)	Instantiates a new basic auth event.

Method Summary

Modifier and Type	Method	Description
HttpMethod	getAction()
InetSocketAddress	getLocalAddress()
String	getRealm()
InetSocketAddress	getRemoteAddress()
RestServer	getSource()
String[]	getWildcardNames()
String	getWildcardReplacement(String aWildcardName)
String	getWildcardReplacementAt(int aIndex)
String[]	getWildcardReplacements()
String[]	getWildcardReplacements(String... aWildcardNames)
String[]	getWildcardReplacementsAt(int... aIndexes)

Methods inherited from class BasicAuthRequest

getBasicAuthCredentials, getHttpMethod, getUrl

Methods inherited from class Object

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

Constructor Details

BasicAuthEvent

public BasicAuthEvent(InetSocketAddress aLocalAddress,
 InetSocketAddress aRemoteAddress,
 HttpMethod aHttpMethod,
 Url aUrl,
 WildcardSubstitutes aWildcardSubstitutes,
 BasicAuthCredentials aCredentials,
 String aRealm,
 RestServer aRestServer)

Instantiates a new basic auth event.

Parameters:

aLocalAddress - The local address where the event is being received.

aRemoteAddress - The remote address from which the request originates.

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

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

aWildcardSubstitutes - The text being substituted by the wildcard of the RestEndpoint's Locator-Pattern.

aCredentials - The credentials retrieved from the request.

aRealm - The realm to which this request is being addressed.

aRestServer - The system firing the event.

Method Details

getAction

public HttpMethod getAction()

Specified by:

getAction in interface ActionAccessor<HttpMethod>

getWildcardReplacements

public String[] getWildcardReplacements()

Specified by:

getWildcardReplacements in interface WildcardSubstitutes

getWildcardReplacementAt

public String getWildcardReplacementAt(int aIndex)

Specified by:

getWildcardReplacementAt in interface WildcardSubstitutes

getWildcardReplacement

public String getWildcardReplacement(String aWildcardName)

Specified by:

getWildcardReplacement in interface WildcardSubstitutes

getWildcardReplacements

public String[] getWildcardReplacements(String... aWildcardNames)

Specified by:

getWildcardReplacements in interface WildcardSubstitutes

getWildcardReplacementsAt

public String[] getWildcardReplacementsAt(int... aIndexes)

Specified by:

getWildcardReplacementsAt in interface WildcardSubstitutes

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface RemoteAddressAccessor

getLocalAddress

public InetSocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface LocalAddressAccessor

getRealm

public String getRealm()

Specified by:

getRealm in interface RealmAccessor

getSource

public RestServer getSource()

Specified by:

getSource in interface SourceAccessor<RestServer>

getWildcardNames

public String[] getWildcardNames()

Specified by:

getWildcardNames in interface WildcardSubstitutes