Module org.refcodes.rest

Package org.refcodes.rest

Class RestRequestEvent

java.lang.Object

org.refcodes.web.AbstractHttpRequest

org.refcodes.web.HttpServerRequest

org.refcodes.rest.RestRequestEvent

All Implemented Interfaces:

org.refcodes.mixin.ActionAccessor<org.refcodes.web.HttpMethod>, org.refcodes.mixin.Dumpable, org.refcodes.mixin.SourceAccessor<RestfulServer>, org.refcodes.mixin.WildcardSubstitutes, org.refcodes.observer.ActionEvent<org.refcodes.web.HttpMethod,RestfulServer>, org.refcodes.observer.Event<RestfulServer>, org.refcodes.web.HeaderFieldsAccessor<org.refcodes.web.RequestHeaderFields>, org.refcodes.web.HttpBodyAccessor, org.refcodes.web.HttpInputStreamAccessor, org.refcodes.web.HttpMethodAccessor, org.refcodes.web.HttpRequest, org.refcodes.web.LocalAddressAccessor, org.refcodes.web.RealmAccessor, org.refcodes.web.RemoteAddressAccessor, org.refcodes.web.UrlAccessor

public class RestRequestEvent
extends org.refcodes.web.HttpServerRequest
implements org.refcodes.observer.ActionEvent<org.refcodes.web.HttpMethod,RestfulServer>, org.refcodes.mixin.WildcardSubstitutes, org.refcodes.web.RemoteAddressAccessor, org.refcodes.web.LocalAddressAccessor, org.refcodes.web.RealmAccessor, org.refcodes.mixin.Dumpable

Defines a RestRequestEvent being the request as consumed by a RestEndpoint. Usually you will use RestfulServer.onRequest(HttpMethod, String, RestRequestConsumer) for registering a RestRequestConsumer to the RestfulServer ( RestfulHttpServer).

Nested Class Summary

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

org.refcodes.mixin.ActionAccessor.ActionBuilder<A,B extends org.refcodes.mixin.ActionAccessor.ActionBuilder<A,B>>, org.refcodes.mixin.ActionAccessor.ActionMutator<A>, org.refcodes.mixin.ActionAccessor.ActionProperty<A>

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

org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsBuilder<T extends org.refcodes.web.HeaderFields<?,?>,B extends org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsBuilder<T,B>>, org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsMutator<T extends org.refcodes.web.HeaderFields<?,?>>, org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsProperty<T extends org.refcodes.web.HeaderFields<?,?>>

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

org.refcodes.web.HttpBodyAccessor.HttpBodyBuilder<B extends org.refcodes.web.HttpBodyAccessor.HttpBodyBuilder<B>>, org.refcodes.web.HttpBodyAccessor.HttpBodyMutator, org.refcodes.web.HttpBodyAccessor.HttpBodyProperty, org.refcodes.web.HttpBodyAccessor.HttpBodyProvider<EXC extends Exception>

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

org.refcodes.web.HttpInputStreamAccessor.HttpInputStreamBuilder<B extends org.refcodes.web.HttpInputStreamAccessor.HttpInputStreamBuilder<B>>, org.refcodes.web.HttpInputStreamAccessor.HttpInputStreamMutator, org.refcodes.web.HttpInputStreamAccessor.HttpInputStreamProperty, org.refcodes.web.HttpInputStreamAccessor.HttpInputStreamProvider<EXC extends Exception>

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

org.refcodes.web.HttpMethodAccessor.HttpMethodBuilder<B extends org.refcodes.web.HttpMethodAccessor.HttpMethodBuilder<B>>, org.refcodes.web.HttpMethodAccessor.HttpMethodMutator, org.refcodes.web.HttpMethodAccessor.HttpMethodProperty

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

org.refcodes.web.LocalAddressAccessor.LocalAddressBuilder<B extends org.refcodes.web.LocalAddressAccessor.LocalAddressBuilder<B>>, org.refcodes.web.LocalAddressAccessor.LocalAddressMutator, org.refcodes.web.LocalAddressAccessor.LocalAddressProperty

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

org.refcodes.web.RealmAccessor.RealmBuilder<B extends org.refcodes.web.RealmAccessor.RealmBuilder<B>>, org.refcodes.web.RealmAccessor.RealmMutator, org.refcodes.web.RealmAccessor.RealmProperty

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

org.refcodes.web.RemoteAddressAccessor.RemoteAddressBuilder<B extends org.refcodes.web.RemoteAddressAccessor.RemoteAddressBuilder<B>>, org.refcodes.web.RemoteAddressAccessor.RemoteAddressMutator, org.refcodes.web.RemoteAddressAccessor.RemoteAddressProperty

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

org.refcodes.mixin.SourceAccessor.SourceBuilder<SRC,B extends org.refcodes.mixin.SourceAccessor.SourceBuilder<SRC,B>>, org.refcodes.mixin.SourceAccessor.SourceMutator<SRC>, org.refcodes.mixin.SourceAccessor.SourceProperty<SRC>

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

org.refcodes.web.UrlAccessor.UrlBuilder, org.refcodes.web.UrlAccessor.UrlMutator, org.refcodes.web.UrlAccessor.UrlProperty

Field Summary

Fields inherited from class org.refcodes.web.HttpServerRequest

_mediaTypeFactoryLookup

Fields inherited from class org.refcodes.web.AbstractHttpRequest

_headerFields, _httpMethod, _url

Constructor Summary

Constructors

Constructor	Description
RestRequestEvent(InetSocketAddress aLocalAddress, InetSocketAddress aRemoteAddress, org.refcodes.web.HttpMethod aHttpMethod, org.refcodes.web.Url aUrl, org.refcodes.mixin.WildcardSubstitutes aWildcardSubstitutes, org.refcodes.web.RequestHeaderFields aHeaderFields, InputStream aHttpInputStream, RestfulServer aRestfulServer)	Constructs a RestRequestEvent with all required attributes.

Method Summary

Modifier and Type	Method	Description
org.refcodes.web.HttpMethod	getAction()
InetSocketAddress	getLocalAddress()
String	getRealm()
InetSocketAddress	getRemoteAddress()
RestfulServer	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 org.refcodes.web.HttpServerRequest

getHttpBody, getHttpInputStream, getRequest, getRequest, toString

Methods inherited from class org.refcodes.web.AbstractHttpRequest

getHeaderFields, getHttpMethod, getUrl

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump, toDump

Constructor Details

RestRequestEvent

public RestRequestEvent(InetSocketAddress aLocalAddress,
 InetSocketAddress aRemoteAddress,
 org.refcodes.web.HttpMethod aHttpMethod,
 org.refcodes.web.Url aUrl,
 org.refcodes.mixin.WildcardSubstitutes aWildcardSubstitutes,
 org.refcodes.web.RequestHeaderFields aHeaderFields,
 InputStream aHttpInputStream,
 RestfulServer aRestfulServer)

Constructs a RestRequestEvent with all required attributes.

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.

aHeaderFields - The RequestHeaderFields sent by the request.

aHttpInputStream - The InputStream representing the request's HTTP body.

aRestfulServer - The system firing the event.

Method Details

getAction

public org.refcodes.web.HttpMethod getAction()

Specified by:

getAction in interface org.refcodes.mixin.ActionAccessor<org.refcodes.web.HttpMethod>

getSource

public RestfulServer getSource()

Specified by:

getSource in interface org.refcodes.mixin.SourceAccessor<RestfulServer>

getWildcardReplacements

public String[] getWildcardReplacements()

Specified by:

getWildcardReplacements in interface org.refcodes.mixin.WildcardSubstitutes

getWildcardReplacementAt

public String getWildcardReplacementAt(int aIndex)

Specified by:

getWildcardReplacementAt in interface org.refcodes.mixin.WildcardSubstitutes

getWildcardReplacement

public String getWildcardReplacement(String aWildcardName)

Specified by:

getWildcardReplacement in interface org.refcodes.mixin.WildcardSubstitutes

getWildcardReplacements

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

Specified by:

getWildcardReplacements in interface org.refcodes.mixin.WildcardSubstitutes

getWildcardReplacementsAt

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

Specified by:

getWildcardReplacementsAt in interface org.refcodes.mixin.WildcardSubstitutes

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface org.refcodes.web.RemoteAddressAccessor

getLocalAddress

public InetSocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface org.refcodes.web.LocalAddressAccessor

getRealm

public String getRealm()

Specified by:

getRealm in interface org.refcodes.web.RealmAccessor

getWildcardNames

public String[] getWildcardNames()

Specified by:

getWildcardNames in interface org.refcodes.mixin.WildcardSubstitutes