Class RestRequestEvent

java.lang.Object

org.refcodes.web.AbstractHttpRequest

org.refcodes.web.HttpServerRequest

org.refcodes.rest.RestRequestEvent

All Implemented Interfaces:

ActionAccessor<HttpMethod>, SourceAccessor<RestServer>, WildcardSubstitutes, ActionEvent<HttpMethod, RestServer>, Event<RestServer>, HeaderFieldsAccessor<RequestHeaderFields>, HttpBodyAccessor, HttpInputStreamAccessor, HttpMethodAccessor, HttpRequest, LocalAddressAccessor, RealmAccessor, RemoteAddressAccessor, UrlAccessor

public class RestRequestEvent
extends HttpServerRequest
implements ActionEvent<HttpMethod, RestServer>, WildcardSubstitutes, RemoteAddressAccessor, LocalAddressAccessor, RealmAccessor

Defines a RestRequestEvent 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 HeaderFieldsAccessor

HeaderFieldsAccessor.HeaderFieldsBuilder<T,B>, HeaderFieldsAccessor.HeaderFieldsMutator<T>, HeaderFieldsAccessor.HeaderFieldsProperty<T>

Nested classes/interfaces inherited from interface HttpBodyAccessor

HttpBodyAccessor.HttpBodyBuilder<B>, HttpBodyAccessor.HttpBodyMutator, HttpBodyAccessor.HttpBodyProperty, HttpBodyAccessor.HttpBodyProvider<EXC>

Nested classes/interfaces inherited from interface HttpInputStreamAccessor

HttpInputStreamAccessor.HttpInputStreamBuilder<B>, HttpInputStreamAccessor.HttpInputStreamMutator, HttpInputStreamAccessor.HttpInputStreamProperty, HttpInputStreamAccessor.HttpInputStreamProvider<EXC>

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

Field Summary

Fields inherited from class HttpServerRequest

_mediaTypeFactoryLookup

Fields inherited from class AbstractHttpRequest

_headerFields, _httpMethod, _url

Constructor Summary

Constructors

Constructor	Description
RestRequestEvent(InetSocketAddress aLocalAddress, InetSocketAddress aRemoteAddress, HttpMethod aHttpMethod, Url aUrl, WildcardSubstitutes aWildcardSubstitutes, RequestHeaderFields aHeaderFields, InputStream aHttpInputStream, RestServer aRestServer)	Constructs a RestRequestEvent with all required attributes.

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 HttpServerRequest

getHttpBody, getHttpInputStream, getRequest, getRequest, toString

Methods inherited from class AbstractHttpRequest

getHeaderFields, getHttpMethod, getUrl

Methods inherited from class Object

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

Constructor Details

RestRequestEvent

public RestRequestEvent(InetSocketAddress aLocalAddress,
 InetSocketAddress aRemoteAddress,
 HttpMethod aHttpMethod,
 Url aUrl,
 WildcardSubstitutes aWildcardSubstitutes,
 RequestHeaderFields aHeaderFields,
 InputStream aHttpInputStream,
 RestServer aRestServer)

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.

aRestServer - The system firing the event.

Method Details

getAction

public HttpMethod getAction()

Specified by:

getAction in interface ActionAccessor<HttpMethod>

getSource

public RestServer getSource()

Specified by:

getSource in interface SourceAccessor<RestServer>

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

getWildcardNames

public String[] getWildcardNames()

Specified by:

getWildcardNames in interface WildcardSubstitutes