Module org.eclipse.jetty.server

Package org.eclipse.jetty.server.handler

Class ContextRequest

java.lang.Object

org.eclipse.jetty.util.Attributes.Wrapper

org.eclipse.jetty.server.Request.Wrapper

org.eclipse.jetty.server.handler.ContextRequest

All Implemented Interfaces:

org.eclipse.jetty.io.Content.Source, Request, org.eclipse.jetty.util.Attributes, org.eclipse.jetty.util.thread.Invocable

public class ContextRequest
extends Request.Wrapper
implements org.eclipse.jetty.util.thread.Invocable

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Attributes

org.eclipse.jetty.util.Attributes.Layer, org.eclipse.jetty.util.Attributes.Lazy, org.eclipse.jetty.util.Attributes.Mapped, org.eclipse.jetty.util.Attributes.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.Invocable

org.eclipse.jetty.util.thread.Invocable.Callable, org.eclipse.jetty.util.thread.Invocable.InvocationType, org.eclipse.jetty.util.thread.Invocable.ReadyTask, org.eclipse.jetty.util.thread.Invocable.Task

Nested classes/interfaces inherited from interface org.eclipse.jetty.server.Request

Request.AuthenticationState, Request.Handler, Request.ServeAs, Request.Wrapper

Field Summary

Fields inherited from interface org.eclipse.jetty.util.Attributes

NULL

Fields inherited from interface org.eclipse.jetty.util.thread.Invocable

__nonBlocking, NOOP

Fields inherited from interface org.eclipse.jetty.server.Request

CACHE_ATTRIBUTE, COOKIE_ATTRIBUTE, DEFAULT_LOCALES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ContextRequest(ContextHandler.ScopedContext context, Request request)

Method Summary

Modifier and Type	Method	Description
void	addFailureListener(Consumer<Throwable> onFailure)	Adds a listener for asynchronous hard errors.
void	addIdleTimeoutListener(Predicate<TimeoutException> onIdleTimeout)	Adds a listener for idle timeouts.
void	demand(Runnable demandCallback)
Context	getContext()	Get the Context associated with this Request.

Methods inherited from class org.eclipse.jetty.server.Request.Wrapper

addHttpStreamWrapper, consumeAvailable, fail, getBeginNanoTime, getComponents, getConnectionMetaData, getHeaders, getHeadersNanoTime, getHttpURI, getId, getLength, getMethod, getSession, getTrailers, getTunnelSupport, getWrapped, isSecure, push, read

Methods inherited from class org.eclipse.jetty.util.Attributes.Wrapper

clearAttributes, equals, getAttribute, getAttributeNameSet, hashCode, removeAttribute, setAttribute

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.Attributes

asAttributeMap, clearAttributes, getAttribute, getAttributeNameSet, removeAttribute, setAttribute

Methods inherited from interface org.eclipse.jetty.io.Content.Source

fail, rewind

Methods inherited from interface org.eclipse.jetty.util.thread.Invocable

getInvocationType

Constructor Details

ContextRequest

protected ContextRequest(ContextHandler.ScopedContext context,
 Request request)

Method Details

demand

public void demand(Runnable demandCallback)

Description copied from interface: Request

Specified by:

demand in interface org.eclipse.jetty.io.Content.Source

Specified by:

demand in interface Request

Overrides:

demand in class Request.Wrapper

Parameters:

demandCallback - the demand callback to invoke when there is a content chunk available. In addition to the invocation guarantees of Content.Source.demand(Runnable), this implementation serializes the invocation of the Runnable with invocations of any Response.write(boolean, ByteBuffer, Callback) Callback invocations.

See Also:

• Content.Source.demand(Runnable)

addIdleTimeoutListener

public void addIdleTimeoutListener(Predicate<TimeoutException> onIdleTimeout)

Description copied from interface: Request

Adds a listener for idle timeouts.

The listener is a predicate function that should return true to indicate that the idle timeout should be handled by the container as a hard failure (see Request.addFailureListener(Consumer)); or false to ignore that specific timeout and for another timeout to occur after another idle period.

Any pending Request.demand(Runnable) or Response.write(boolean, ByteBuffer, Callback) operations are not affected by this call. Applications need to be mindful of any such pending operations if attempting to make new operations.

Listeners are processed in sequence, and the first that returns true stops the processing of subsequent listeners, which are therefore not invoked.

Specified by:

addIdleTimeoutListener in interface Request

Overrides:

addIdleTimeoutListener in class Request.Wrapper

Parameters:

onIdleTimeout - the predicate function

See Also:

• Request.addFailureListener(Consumer)

addFailureListener

public void addFailureListener(Consumer<Throwable> onFailure)

Description copied from interface: Request

Adds a listener for asynchronous hard errors.

When a listener is called, the effects of the error will already have taken place:

• Pending Request.demand(Runnable) will be woken up.
• Calls to Request.read() will return the Throwable.
• Pending and new Response.write(boolean, ByteBuffer, Callback) calls will be failed by calling Callback.failed(Throwable) on the callback passed to write(...).
• Any call to Callback.succeeded() on the callback passed to Request.Handler.handle(Request, Response, Callback) will effectively be a call to Callback.failed(Throwable) with the notified Throwable.

Listeners are processed in sequence. When all listeners are invoked then Callback.failed(Throwable) will be called on the callback passed to Request.Handler.handle(Request, Response, Callback).

Specified by:

addFailureListener in interface Request

Overrides:

addFailureListener in class Request.Wrapper

Parameters:

onFailure - the consumer function

See Also:

• Request.addIdleTimeoutListener(Predicate)

getContext

public Context getContext()

Description copied from interface: Request

Get the Context associated with this Request.

Note that a Request should always have an associated Context since if the Request is not being handled by a ContextHandler then the Context from Server.getContext() will be used.

Specified by:

getContext in interface Request

Overrides:

getContext in class Request.Wrapper

Returns:

the Context associated with this Request. Never null.

See Also:

• ContextHandler
• Server.getContext()