Package org.jgrapes.http.events

Class Request.In

java.lang.Object

org.jgrapes.core.internal.EventBase<Boolean>

org.jgrapes.core.Event<Boolean>

org.jgrapes.http.events.MessageReceived<Boolean>

org.jgrapes.http.events.Request<Boolean>

org.jgrapes.http.events.Request.In

All Implemented Interfaces:

Future<Boolean>, Associator, Eligible

Direct Known Subclasses:

Request.In.Connect, Request.In.Delete, Request.In.Get, Request.In.Head, Request.In.Options, Request.In.Post, Request.In.Put, Request.In.Trace

Enclosing class:

Request<R>

public static class Request.In
extends Request<Boolean>

The base class for all incoming HTTP requests.

Incoming request flow downstream and are served by the framework.

A result of true indicates that the request has been processed, i.e. a response has been sent or will sent. Händlers MUST check that a request has not been fulfilled() before firing a Response event to avoid duplicate response events. Handlers that have fired a response event and all related Output events SHOULD stop the request event to avoid unnecessary subsequent invocations of handlers. Handlers that want to do “postprocessing” MUST therefore listen for the corresponding Request.In.Completed event instead of defining a handler for the request event with low priority.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Request.In.Completed	The associated completion event.
static class	Request.In.Connect	Represents a HTTP CONNECT request.
static class	Request.In.Delete	The Class Delete.
static class	Request.In.Get	Represents a HTTP GET request.
static class	Request.In.Head	Represents a HTTP HEAD request.
static class	Request.In.Options	Represents a HTTP OPTIONS request.
static class	Request.In.Post	Represents a HTTP POST request.
static class	Request.In.Put	Represents a HTTP PUT request.
static class	Request.In.Trace	Represents a HTTP TRACE request.

Nested classes/interfaces inherited from class org.jgrapes.http.events.Request

Request.In, Request.Out

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Field Summary

Fields inherited from class org.jgrapes.core.internal.EventBase

completed, completionEvents, invokedFor

Constructor Summary

Constructors

Constructor	Description
In(String protocol, HttpRequest request, int matchLevels, Channel... channels)	Creates a new request event with the associated Request.In.Completed event.

Method Summary

Modifier and Type	Method	Description
static Object	createMatchValue(Class<?> type, ResourcePattern resource)	Creates the match value.
Object	defaultCriterion()	The match value consists of the event class and a URI.
protected URI	effectiveRequestUri(String protocol, HttpRequest request)	Builds the URI that represents this request.
static Request.In	fromHttpRequest(HttpRequest request, boolean secure, int matchLevels)	Creates the appropriate derived request event type from a given HttpRequest.
boolean	fulfilled()	Checks if the request has been processed, i.e.
HttpRequest	httpRequest()	Returns the “raw” request as provided by the HTTP decoder.
boolean	isEligibleFor(Object value)	Returns true if the criterion is of the same class or a base class of this event’s class.
final URI	requestUri()	Returns an absolute URI of the request.
protected final void	setRequestUri(URI uri)	Sets the request URI.
String	toString()

Methods inherited from class org.jgrapes.core.Event

addCompletionEvent, associated, cancel, channels, channels, completionEvents, currentResults, forChannels, get, get, handled, handlingError, isCancelled, isDone, isStopped, processedBy, results, results, resumeHandling, setAssociated, setChannels, setRequiresResult, setResult, stop, suspendHandling, suspendHandling, tieTo

Methods inherited from class org.jgrapes.core.internal.EventBase

disableTracking, enqueued, firstResultAssigned, isTracked, onCompletion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgrapes.core.Associator

associated, associated, associated, associatedGet

Methods inherited from interface java.util.concurrent.Future

exceptionNow, resultNow, state

Constructor Details

In

public In(String protocol,
 HttpRequest request,
 int matchLevels,
 Channel... channels)
   throws URISyntaxException

Creates a new request event with the associated Request.In.Completed event.

Parameters:

protocol - the protocol as reported by requestUri()

request - the request data

matchLevels - the number of elements from the request path to use in the match value (see matchValue)

channels - the channels associated with this event

Throws:

URISyntaxException

Method Details

effectiveRequestUri

protected URI effectiveRequestUri(String protocol,
 HttpRequest request)
                           throws URISyntaxException

Builds the URI that represents this request.

The default implementation checks that request URI in the HTTP request is directed at this server as specified in the “Host”-header and adds the protocol, host and port if not specified in the request URI.

Parameters:

protocol - the protocol

request - the request

Returns:

the URI

Throws:

URISyntaxException - if the request is not acceptable

fromHttpRequest

public static Request.In fromHttpRequest(HttpRequest request,
 boolean secure,
 int matchLevels)
                                  throws URISyntaxException

Creates the appropriate derived request event type from a given HttpRequest.

Parameters:

request - the HTTP request

secure - whether the request was received over a secure channel

matchLevels - the match levels

Returns:

the request event

Throws:

URISyntaxException

setRequestUri

protected final void setRequestUri(URI uri)

Sets the request URI.

Parameters:

uri - the new request URI

requestUri

public final URI requestUri()

Returns an absolute URI of the request.

For incoming requests, the URI is built from the information provided by the decoder.

Returns:

the URI

httpRequest

public HttpRequest httpRequest()

Returns the “raw” request as provided by the HTTP decoder.

Returns:

the request

defaultCriterion

public Object defaultCriterion()

The match value consists of the event class and a URI.

The URI is similar to the request URI but its path elements are shortened as specified in the constructor.

The match value is used as key in a map that speeds up the lookup of handlers. Having the complete URI in the match value would inflate this map.

Specified by:

defaultCriterion in interface Eligible

Overrides:

defaultCriterion in class Event<Boolean>

Returns:

the object

See Also:

• Event.defaultCriterion()

isEligibleFor

public boolean isEligibleFor(Object value)

Description copied from class: Event

Returns true if the criterion is of the same class or a base class of this event’s class.

Specified by:

isEligibleFor in interface Eligible

Overrides:

isEligibleFor in class Event<Boolean>

Parameters:

value - the criterion

Returns:

true if this meets the criterion

See Also:

• Eligible.isEligibleFor(java.lang.Object)

fulfilled

public boolean fulfilled()

Checks if the request has been processed, i.e.

a response has been sent.

Returns:

true, if fulfilled

toString

public String toString()

Overrides:

toString in class Event<Boolean>

createMatchValue

public static Object createMatchValue(Class<?> type,
 ResourcePattern resource)

Creates the match value.

Parameters:

type - the type

resource - the resource

Returns:

the object