Package org.eclipse.jetty.server.handler

Class ContextRequest

java.lang.Object

org.eclipse.jetty.server.Request.Wrapper

org.eclipse.jetty.server.handler.ContextRequest

All Implemented Interfaces:

Content.Source, Request, Attributes, Invocable

Direct Known Subclasses:

ServletContextRequest

public class ContextRequest
extends Request.Wrapper
implements Invocable

Nested Class Summary

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

Attributes.Layer, Attributes.Lazy, Attributes.Mapped, Attributes.Synthetic

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

Invocable.Callable, Invocable.InvocationType, Invocable.ReadyTask, Invocable.Task

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

Request.AttributesWrapper, 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

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 fatal failures.
void	addIdleTimeoutListener(Predicate<TimeoutException> onIdleTimeout)	Adds a listener for idle timeouts.
void	demand(Runnable demandCallback)	Demands to invoke the given demand callback parameter when a chunk of content is available.
Context	getContext()	Get the Context associated with this Request.

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

addHttpStreamWrapper, asAttributeMap, clearAttributes, consumeAvailable, fail, getAttribute, getAttributeNameSet, getBeginNanoTime, getComponents, getConnectionMetaData, getHeaders, getHeadersNanoTime, getHttpURI, getId, getLength, getMethod, getSession, getTrailers, getTunnelSupport, getWrapped, isSecure, push, read, removeAttribute, setAttribute, toString

Methods inherited from class java.lang.Object

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

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

equals, hashCode

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

Demands to invoke the given demand callback parameter when a chunk of content is available.

See how to use this method idiomatically.

Implementations guarantee that calls to this method are safely reentrant so that stack overflows are avoided in the case of mutual recursion between the execution of the Runnable callback and a call to this method. Invocations of the passed Runnable are serialized and a callback for demand call is not invoked until any previous demand callback has returned. Thus the Runnable should not block waiting for a callback of a future demand call.

The demand callback may be invoked spuriously: a subsequent call to Content.Source.read() may return null.

Calling this method establishes a pending demand, which is fulfilled when the demand callback is invoked.

Calling this method when there is already a pending demand results in an IllegalStateException to be thrown.

If the invocation of the demand callback throws an exception, then Content.Source.fail(Throwable) is called.

Specified by:

demand in interface 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.

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 fatal failure (see Request.addFailureListener(Consumer)); or false to ignore that specific timeout and for another timeout to occur after another idle period.

Idle timeout listeners are only invoked if there are no pending Request.demand(Runnable) or Response.write(boolean, ByteBuffer, Callback) operations.

Listeners are processed in the same order they are added, 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 idle timeout listener as a predicate function

See Also:

• Request.addFailureListener(Consumer)

addFailureListener

public void addFailureListener(Consumer<Throwable> onFailure)

Description copied from interface: Request

Adds a listener for asynchronous fatal failures.

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

• Pending Request.demand(Runnable) have been woken up.
• Calls to Request.read() will return the Throwable failure.
• Pending and new Response.write(boolean, ByteBuffer, Callback) calls will be failed by calling Callback.failed(Throwable) on the callback passed to Response.write(boolean, ByteBuffer, Callback).

Listeners are processed in the same order they are added.

Specified by:

addFailureListener in interface Request

Overrides:

addFailureListener in class Request.Wrapper

Parameters:

onFailure - the failure listener as a 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()