org.glassfish.jersey.server.internal.process

Class RequestProcessingContext

java.lang.Object

org.glassfish.jersey.server.internal.process.RequestProcessingContext

All Implemented Interfaces:

RespondingContext

public final class RequestProcessingContext
extends java.lang.Object
implements RespondingContext

Request processing context. Serves as a hub for all request processing related information and is being passed between stages.

Field Summary

Fields

Modifier and Type	Field and Description
private Ref<Value<AsyncContext>>	asyncContextValueRef
private CloseableService	closeableService
private RequestEventBuilder	monitoringEventBuilder
private RequestEventListener	monitoringEventListener
private ContainerRequest	request
private RespondingContext	respondingContext
private UriRoutingContext	routingContext
private org.glassfish.hk2.api.ServiceLocator	serviceLocator

Constructor Summary

Constructors

Constructor and Description
RequestProcessingContext(org.glassfish.hk2.api.ServiceLocator serviceLocator, ContainerRequest request, UriRoutingContext routingContext, RequestEventBuilder monitoringEventBuilder, RequestEventListener monitoringEventListener) Create new request processing context.

Method Summary

Modifier and Type	Method and Description
AsyncContext	asyncContext() Get the asynchronous context associated with this request processing context.
Value<AsyncContext>	asyncContextValue() Get a Value instance holding the asynchronous context associated with this request processing context.
CloseableService	closeableService() Get closeable service associated with the request.
Stage<ContainerResponse>	createRespondingRoot() (Optionally) create a responder chain from all transformations previously pushed into the context.
void	initAsyncContext(Value<AsyncContext> lazyContextValue) Lazily initialize AsyncContext for this request processing context.
RequestEventBuilder	monitoringEventBuilder() Get request monitoring event builder.
void	push(ChainableStage<ContainerResponse> stage) Push chainable response transformation stage that should be applied.
void	push(com.google.common.base.Function<ContainerResponse,ContainerResponse> responseTransformation) Push response transformation function that should be applied.
ContainerRequest	request() Get the processed container request.
RoutingContext	routingContext() Get the routing context for the processed container request.
org.glassfish.hk2.api.ServiceLocator	serviceLocator() Get service locator.
void	triggerEvent(RequestEvent.Type eventType) Trigger a new monitoring event for the currently processed request.
(package private) UriRoutingContext	uriRoutingContext() Get the underlying UriRoutingContext instance for the processed container request.

Methods inherited from class java.lang.Object

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

Field Detail

serviceLocator

private final org.glassfish.hk2.api.ServiceLocator serviceLocator

request

private final ContainerRequest request

routingContext

private final UriRoutingContext routingContext

respondingContext

private final RespondingContext respondingContext

closeableService

private final CloseableService closeableService

monitoringEventBuilder

private final RequestEventBuilder monitoringEventBuilder

monitoringEventListener

private final RequestEventListener monitoringEventListener

asyncContextValueRef

private final Ref<Value<AsyncContext>> asyncContextValueRef

Constructor Detail

RequestProcessingContext

public RequestProcessingContext(org.glassfish.hk2.api.ServiceLocator serviceLocator,
                                ContainerRequest request,
                                UriRoutingContext routingContext,
                                RequestEventBuilder monitoringEventBuilder,
                                RequestEventListener monitoringEventListener)

Create new request processing context.

Parameters:

serviceLocator - service locator / injector.

request - container request.

routingContext - routing context.

monitoringEventBuilder - request monitoring event builder.

monitoringEventListener - registered request monitoring event listener.

Method Detail

request

public ContainerRequest request()

Get the processed container request.

Returns:

processed container request.

routingContext

public RoutingContext routingContext()

Get the routing context for the processed container request.

Returns:

request routing context.

uriRoutingContext

UriRoutingContext uriRoutingContext()

Get the underlying UriRoutingContext instance for the processed container request.

This instance is used by ServerProcessingBinder to satisfy injection of multiple types, namely:

• UriInfo
ExtendedUriInfo
ResourceInfo

Returns:

request routing context.

closeableService

public CloseableService closeableService()

Get closeable service associated with the request.

Returns:

closeable service associated with the request.

initAsyncContext

public void initAsyncContext(Value<AsyncContext> lazyContextValue)

Lazily initialize AsyncContext for this request processing context.

The lazyContextValue will be only invoked once during the first call to asyncContext(). As such, the asynchronous context for this request can be initialized lazily, on demand.

Parameters:

lazyContextValue - lazily initialized AsyncContext instance bound to this request processing context.

asyncContext

public AsyncContext asyncContext()

Get the asynchronous context associated with this request processing context. May return null if no asynchronous context has been initialized in this request processing context yet.

Returns:

asynchronous context associated with this request processing context, or null if the asynchronous context has not been initialized yet (see initAsyncContext(org.glassfish.jersey.internal.util.collection.Value)).

asyncContextValue

public Value<AsyncContext> asyncContextValue()

Get a Value instance holding the asynchronous context associated with this request processing context. May return an empty value if no asynchronous context has been initialized in this request processing context yet.

Returns:

value instance holding the asynchronous context associated with this request processing context. The returned value may be empty, if no asynchronous context has been initialized yet (see initAsyncContext(org.glassfish.jersey.internal.util.collection.Value)).

serviceLocator

public org.glassfish.hk2.api.ServiceLocator serviceLocator()

Get service locator. The returned instance is application-scoped.

Returns:

application-scoped service locator.

monitoringEventBuilder

public RequestEventBuilder monitoringEventBuilder()

Get request monitoring event builder.

Returns:

request monitoring event builder.

triggerEvent

public void triggerEvent(RequestEvent.Type eventType)

Trigger a new monitoring event for the currently processed request.

Parameters:

eventType - request event type.

push

public void push(com.google.common.base.Function<ContainerResponse,ContainerResponse> responseTransformation)

Description copied from interface: RespondingContext

Push response transformation function that should be applied.

Specified by:

push in interface RespondingContext

Parameters:

responseTransformation - response transformation function.

push

public void push(ChainableStage<ContainerResponse> stage)

Description copied from interface: RespondingContext

Push chainable response transformation stage that should be applied.

Specified by:

push in interface RespondingContext

Parameters:

stage - response transformation chainable stage.

createRespondingRoot

public Stage<ContainerResponse> createRespondingRoot()

Description copied from interface: RespondingContext

(Optionally) create a responder chain from all transformations previously pushed into the context.

Specified by:

createRespondingRoot in interface RespondingContext

Returns:

created responder chain root or null in case of no registered transformations.