Package com.linecorp.armeria.server

Class ServiceRequestContextWrapper

java.lang.Object

com.linecorp.armeria.common.RequestContextWrapper<ServiceRequestContext>

com.linecorp.armeria.server.ServiceRequestContextWrapper

All Implemented Interfaces:

RequestContext, ServiceRequestContext

public class ServiceRequestContextWrapper
extends RequestContextWrapper<ServiceRequestContext>
implements ServiceRequestContext

Wraps an existing ServiceRequestContext.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServiceRequestContextWrapper(ServiceRequestContext delegate)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addAdditionalResponseHeader(CharSequence name, Object value)	Adds a header with the specified name and value.
void	addAdditionalResponseTrailer(CharSequence name, Object value)	Adds a trailer with the specified name and value.
HttpHeaders	additionalResponseHeaders()	Returns the HttpHeaders which will be included when a Service sends an HttpResponse.
HttpHeaders	additionalResponseTrailers()	Returns the HttpHeaders which is included along with any other trailers when a Service completes an HttpResponse.
ContextAwareScheduledExecutorService	blockingTaskExecutor()	Returns the ContextAwareScheduledExecutorService that could be used for executing a potentially long-running task.
void	clearRequestTimeout()	Clears the previously scheduled request timeout, if any.
InetAddress	clientAddress()	Returns the address of the client who initiated this request.
ServiceConfig	config()	Returns the ServiceConfig of the Service that is handling the current Request.
String	decodedMappedPath()	Returns the RequestContext.decodedPath() with its context path removed.
CompletableFuture<Void>	initiateConnectionShutdown()	Initiates connection shutdown without overriding current configuration of the drain duration and returns CompletableFuture that completes when the channel is closed.
CompletableFuture<Void>	initiateConnectionShutdown(long drainDurationMicros)	Initiates graceful connection shutdown with a given drain duration in microseconds and returns CompletableFuture that completes when the channel is closed.
boolean	isCancelled()	Returns whether this RequestContext has been cancelled.
boolean	isTimedOut()	Returns whether this RequestContext has been timed-out, that is the cancellation cause is an instance of TimeoutException.
<A extends SocketAddress> A	localAddress()	Returns the local address of this request, or null if the connection is not established yet.
String	mappedPath()	Returns the RequestContext.path() with its context path removed.
long	maxRequestLength()	Returns the maximum length of the current Request.
void	mutateAdditionalResponseHeaders(Consumer<HttpHeadersBuilder> mutator)	Mutates the HttpHeaders which will be included when a Service sends an HttpResponse.
void	mutateAdditionalResponseTrailers(Consumer<HttpHeadersBuilder> mutator)	Mutates the HttpHeaders which is included along with any other trailers when a Service completes an HttpResponse.
@Nullable MediaType	negotiatedResponseMediaType()	Returns the negotiated producible media type.
Map<String,String>	pathParams()	Returns the path parameters mapped by the Route associated with the Service that is handling the current Request.
ProxiedAddresses	proxiedAddresses()	Returns the proxied addresses of the current Request.
<A extends SocketAddress> A	remoteAddress()	Returns the remote address of this request, or null if the connection is not established yet.
HttpRequest	request()	Returns the HttpRequest associated with this context, or null if there's no HttpRequest associated with this context yet.
long	requestTimeoutMillis()	Returns the amount of time allowed from the start time of the Request until receiving the current Request and sending the corresponding Response completely.
ServiceRequestContext	root()	Returns the root ServiceRequestContext of this context.
RoutingContext	routingContext()	Returns the RoutingContext used to find the Service.
void	setAdditionalResponseHeader(CharSequence name, Object value)	Sets a header with the specified name and value.
void	setAdditionalResponseTrailer(CharSequence name, Object value)	Sets a trailer with the specified name and value.
void	setMaxRequestLength(long maxRequestLength)	Sets the maximum length of the current Request.
void	setRequestTimeout(TimeoutMode mode, Duration requestTimeout)	Schedules the request timeout that is triggered when the Request is not fully received or the corresponding Response is not sent completely within the specified TimeoutMode and the specified requestTimeout.
void	setRequestTimeoutMillis(TimeoutMode mode, long requestTimeoutMillis)	Schedules the request timeout that is triggered when the Request is not fully received or the corresponding Response is not sent completely within the specified TimeoutMode and the specified requestTimeoutMillis.
CompletableFuture<Throwable>	whenRequestCancelled()	Returns a CompletableFuture which is completed with a Throwable cancellation cause after the ServiceRequestContext has been cancelled.
CompletableFuture<Throwable>	whenRequestCancelling()	Returns a CompletableFuture which is completed with a Throwable cancellation cause when the ServiceRequestContext is about to get cancelled.
CompletableFuture<Void>	whenRequestTimedOut()	Deprecated.
CompletableFuture<Void>	whenRequestTimingOut()	Deprecated.

Methods inherited from class com.linecorp.armeria.common.RequestContextWrapper

alloc, attr, attrs, cancel, cancel, cancellationCause, decodedPath, delegate, eventLoop, hasAttr, hasOwnAttr, id, log, logBuilder, meterRegistry, method, ownAttr, ownAttrs, path, query, rpcRequest, sessionProtocol, setAttr, sslSession, timeoutNow, toString, updateRequest, updateRpcRequest

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.common.RequestContext

alloc, attr, attrs, cancel, cancellationCause, decodedPath, eventLoop, hasAttr, hasOwnAttr, id, log, logBuilder, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, meterRegistry, method, ownAttr, ownAttrs, path, query, replace, run, run, sessionProtocol, setAttr, sslSession, updateRequest, updateRpcRequest

Methods inherited from interface com.linecorp.armeria.server.ServiceRequestContext

cancel, initiateConnectionShutdown, pathParam, push, rpcRequest, setRequestTimeout, setRequestTimeoutMillis, timeoutNow

Constructor Details

ServiceRequestContextWrapper

protected ServiceRequestContextWrapper(ServiceRequestContext delegate)

Creates a new instance.

Method Details

root

public ServiceRequestContext root()

Description copied from interface: RequestContext

Returns the root ServiceRequestContext of this context.

Specified by:

root in interface RequestContext

Specified by:

root in interface ServiceRequestContext

Overrides:

root in class RequestContextWrapper<ServiceRequestContext>

Returns:

the root ServiceRequestContext, or null if this context was not created in the context of a server request.

request

@Nonnull
public HttpRequest request()

Description copied from interface: RequestContext

Returns the HttpRequest associated with this context, or null if there's no HttpRequest associated with this context yet.

Specified by:

request in interface RequestContext

Specified by:

request in interface ServiceRequestContext

Overrides:

request in class RequestContextWrapper<ServiceRequestContext>

remoteAddress

@Nonnull
public <A extends SocketAddress> A remoteAddress()

Description copied from interface: RequestContext

Returns the remote address of this request, or null if the connection is not established yet.

Specified by:

remoteAddress in interface RequestContext

Specified by:

remoteAddress in interface ServiceRequestContext

Overrides:

remoteAddress in class RequestContextWrapper<ServiceRequestContext>

localAddress

@Nonnull
public <A extends SocketAddress> A localAddress()

Description copied from interface: RequestContext

Returns the local address of this request, or null if the connection is not established yet.

Specified by:

localAddress in interface RequestContext

Specified by:

localAddress in interface ServiceRequestContext

Overrides:

localAddress in class RequestContextWrapper<ServiceRequestContext>

clientAddress

public InetAddress clientAddress()

Description copied from interface: ServiceRequestContext

Returns the address of the client who initiated this request.

Specified by:

clientAddress in interface ServiceRequestContext

config

public ServiceConfig config()

Description copied from interface: ServiceRequestContext

Returns the ServiceConfig of the Service that is handling the current Request.

Specified by:

config in interface ServiceRequestContext

routingContext

public RoutingContext routingContext()

Description copied from interface: ServiceRequestContext

Returns the RoutingContext used to find the Service.

Specified by:

routingContext in interface ServiceRequestContext

pathParams

public Map<String,String> pathParams()

Description copied from interface: ServiceRequestContext

Returns the path parameters mapped by the Route associated with the Service that is handling the current Request.

Specified by:

pathParams in interface ServiceRequestContext

blockingTaskExecutor

public ContextAwareScheduledExecutorService blockingTaskExecutor()

Description copied from interface: ServiceRequestContext

Returns the ContextAwareScheduledExecutorService that could be used for executing a potentially long-running task. The ContextAwareScheduledExecutorService sets this ServiceRequestContext as the current context before executing any submitted tasks. If you want to use ScheduledExecutorService without setting this context, call ContextAwareScheduledExecutorService.withoutContext() and use the returned ScheduledExecutorService.

Specified by:

blockingTaskExecutor in interface ServiceRequestContext

mappedPath

public String mappedPath()

Description copied from interface: ServiceRequestContext

Returns the RequestContext.path() with its context path removed. This method can be useful for a reusable service bound at various path prefixes.

Specified by:

mappedPath in interface ServiceRequestContext

decodedMappedPath

public String decodedMappedPath()

Description copied from interface: ServiceRequestContext

Returns the RequestContext.decodedPath() with its context path removed. This method can be useful for a reusable service bound at various path prefixes.

Specified by:

decodedMappedPath in interface ServiceRequestContext

negotiatedResponseMediaType

@Nullable
public @Nullable MediaType negotiatedResponseMediaType()

Description copied from interface: ServiceRequestContext

Returns the negotiated producible media type. If the media type negotiation is not used for the Service, null would be returned.

Specified by:

negotiatedResponseMediaType in interface ServiceRequestContext

requestTimeoutMillis

public long requestTimeoutMillis()

Description copied from interface: ServiceRequestContext

Returns the amount of time allowed from the start time of the Request until receiving the current Request and sending the corresponding Response completely. This value is initially set from ServiceConfig.requestTimeoutMillis().

Specified by:

requestTimeoutMillis in interface ServiceRequestContext

clearRequestTimeout

public void clearRequestTimeout()

Description copied from interface: ServiceRequestContext

Clears the previously scheduled request timeout, if any. Note that calling this will prevent the request from ever being timed out.

Specified by:

clearRequestTimeout in interface ServiceRequestContext

setRequestTimeoutMillis

public void setRequestTimeoutMillis(TimeoutMode mode,
 long requestTimeoutMillis)

Description copied from interface: ServiceRequestContext

Schedules the request timeout that is triggered when the Request is not fully received or the corresponding Response is not sent completely within the specified TimeoutMode and the specified requestTimeoutMillis.

timeout mode description

Timeout mode	description
TimeoutMode.SET_FROM_NOW	Sets a given amount of timeout from the current time.
TimeoutMode.SET_FROM_START	Sets a given amount of timeout since the current Request began processing.
TimeoutMode.EXTEND	Extends the previously scheduled timeout by the given amount of timeout.

For example:

 ServiceRequestContext ctx = ...;
 // Schedules a timeout from the start time of the request
 ctx.setRequestTimeoutMillis(TimeoutMode.SET_FROM_START, 2000);
 assert ctx.requestTimeoutMillis() == 2000;
 ctx.setRequestTimeoutMillis(TimeoutMode.SET_FROM_START, 1000);
 assert ctx.requestTimeoutMillis() == 1000;

 // Schedules timeout after 3 seconds from now.
 ctx.setRequestTimeoutMillis(TimeoutMode.SET_FROM_NOW, 3000);

 // Extends the previously scheduled timeout.
 long oldRequestTimeoutMillis = ctx.requestTimeoutMillis();
 ctx.setRequestTimeoutMillis(TimeoutMode.EXTEND, 1000);
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 1000;
 ctx.extendRequestTimeoutMillis(TimeoutMode.EXTEND, -500);
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 500;
 

Specified by:

setRequestTimeoutMillis in interface ServiceRequestContext

setRequestTimeout

public void setRequestTimeout(TimeoutMode mode,
 Duration requestTimeout)

Description copied from interface: ServiceRequestContext

Schedules the request timeout that is triggered when the Request is not fully received or the corresponding Response is not sent completely within the specified TimeoutMode and the specified requestTimeout.

timeout mode description

Timeout mode	description
TimeoutMode.SET_FROM_NOW	Sets a given amount of timeout from the current time.
TimeoutMode.SET_FROM_START	Sets a given amount of timeout since the current Request began processing.
TimeoutMode.EXTEND	Extends the previously scheduled timeout by the given amount of timeout.

For example:

 ServiceRequestContext ctx = ...;
 // Schedules a timeout from the start time of the request
 ctx.setRequestTimeout(TimeoutMode.SET_FROM_START, Duration.ofSeconds(2));
 assert ctx.requestTimeoutMillis() == 2000;
 ctx.setRequestTimeout(TimeoutMode.SET_FROM_START, Duration.ofSeconds(1));
 assert ctx.requestTimeoutMillis() == 1000;

 // Schedules timeout after 3 seconds from now.
 ctx.setRequestTimeout(TimeoutMode.SET_FROM_NOW, Duration.ofSeconds(3));

 // Extends the previously scheduled timeout.
 long oldRequestTimeoutMillis = ctx.requestTimeoutMillis();
 ctx.setRequestTimeout(TimeoutMode.EXTEND, Duration.ofSeconds(1));
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 1000;
 ctx.setRequestTimeout(TimeoutMode.EXTEND, Duration.ofMillis(-500));
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 500;
 

Specified by:

setRequestTimeout in interface ServiceRequestContext

whenRequestCancelling

public CompletableFuture<Throwable> whenRequestCancelling()

Description copied from interface: ServiceRequestContext

Returns a CompletableFuture which is completed with a Throwable cancellation cause when the ServiceRequestContext is about to get cancelled. If the request is handled successfully without cancellation, the CompletableFuture won't complete.

Specified by:

whenRequestCancelling in interface ServiceRequestContext

whenRequestCancelled

public CompletableFuture<Throwable> whenRequestCancelled()

Description copied from interface: ServiceRequestContext

Returns a CompletableFuture which is completed with a Throwable cancellation cause after the ServiceRequestContext has been cancelled. RequestContext.isCancelled() will always return true when the returned CompletableFuture is completed. If the request is handled successfully without cancellation, the CompletableFuture won't complete.

Specified by:

whenRequestCancelled in interface ServiceRequestContext

whenRequestTimingOut

@Deprecated
public CompletableFuture<Void> whenRequestTimingOut()

Deprecated.

Description copied from interface: ServiceRequestContext

Returns a CompletableFuture which is completed when the ServiceRequestContext is about to get timed out. If the request is handled successfully or not cancelled by timeout, the CompletableFuture won't complete.

Specified by:

whenRequestTimingOut in interface ServiceRequestContext

whenRequestTimedOut

@Deprecated
public CompletableFuture<Void> whenRequestTimedOut()

Deprecated.

Description copied from interface: ServiceRequestContext

Returns a CompletableFuture which is completed after the ServiceRequestContext has been timed out. RequestContext.isTimedOut() will always return true when the returned CompletableFuture is completed. If the request is handled successfully or not cancelled by timeout, the CompletableFuture won't complete.

Specified by:

whenRequestTimedOut in interface ServiceRequestContext

isCancelled

public boolean isCancelled()

Description copied from interface: RequestContext

Returns whether this RequestContext has been cancelled.

Specified by:

isCancelled in interface RequestContext

isTimedOut

public boolean isTimedOut()

Description copied from interface: RequestContext

Returns whether this RequestContext has been timed-out, that is the cancellation cause is an instance of TimeoutException.

Specified by:

isTimedOut in interface RequestContext

maxRequestLength

public long maxRequestLength()

Description copied from interface: ServiceRequestContext

Returns the maximum length of the current Request. This value is initially set from ServiceConfig.maxRequestLength(). If 0, there is no limit on the request size.

Specified by:

maxRequestLength in interface ServiceRequestContext

See Also:

ContentTooLargeException

setMaxRequestLength

public void setMaxRequestLength(long maxRequestLength)

Description copied from interface: ServiceRequestContext

Sets the maximum length of the current Request. This value is initially set from ServiceConfig.maxRequestLength(). If 0, there is no limit on the request size.

Specified by:

setMaxRequestLength in interface ServiceRequestContext

See Also:

ContentTooLargeException

additionalResponseHeaders

public HttpHeaders additionalResponseHeaders()

Description copied from interface: ServiceRequestContext

Returns the HttpHeaders which will be included when a Service sends an HttpResponse.

Specified by:

additionalResponseHeaders in interface ServiceRequestContext

setAdditionalResponseHeader

public void setAdditionalResponseHeader(CharSequence name,
 Object value)

Description copied from interface: ServiceRequestContext

Sets a header with the specified name and value. This will remove all previous values associated with the specified name. The header will be included when a Service sends an HttpResponse.

Specified by:

setAdditionalResponseHeader in interface ServiceRequestContext

addAdditionalResponseHeader

public void addAdditionalResponseHeader(CharSequence name,
 Object value)

Description copied from interface: ServiceRequestContext

Adds a header with the specified name and value. The header will be included when a Service sends an HttpResponse.

Specified by:

addAdditionalResponseHeader in interface ServiceRequestContext

mutateAdditionalResponseHeaders

public void mutateAdditionalResponseHeaders(Consumer<HttpHeadersBuilder> mutator)

Description copied from interface: ServiceRequestContext

Mutates the HttpHeaders which will be included when a Service sends an HttpResponse.

Specified by:

mutateAdditionalResponseHeaders in interface ServiceRequestContext

Parameters:

mutator - the Consumer that mutates the additional response headers

additionalResponseTrailers

public HttpHeaders additionalResponseTrailers()

Description copied from interface: ServiceRequestContext

Returns the HttpHeaders which is included along with any other trailers when a Service completes an HttpResponse.

Specified by:

additionalResponseTrailers in interface ServiceRequestContext

setAdditionalResponseTrailer

public void setAdditionalResponseTrailer(CharSequence name,
 Object value)

Description copied from interface: ServiceRequestContext

Sets a trailer with the specified name and value. This will remove all previous values associated with the specified name. The trailer will be included when a Service completes an HttpResponse.

Specified by:

setAdditionalResponseTrailer in interface ServiceRequestContext

addAdditionalResponseTrailer

public void addAdditionalResponseTrailer(CharSequence name,
 Object value)

Description copied from interface: ServiceRequestContext

Adds a trailer with the specified name and value. The trailer will be included when a Service completes an HttpResponse.

Specified by:

addAdditionalResponseTrailer in interface ServiceRequestContext

mutateAdditionalResponseTrailers

public void mutateAdditionalResponseTrailers(Consumer<HttpHeadersBuilder> mutator)

Description copied from interface: ServiceRequestContext

Mutates the HttpHeaders which is included along with any other trailers when a Service completes an HttpResponse.

Specified by:

mutateAdditionalResponseTrailers in interface ServiceRequestContext

Parameters:

mutator - the Consumer that mutates the additional trailers

proxiedAddresses

public ProxiedAddresses proxiedAddresses()

Description copied from interface: ServiceRequestContext

Returns the proxied addresses of the current Request.

Specified by:

proxiedAddresses in interface ServiceRequestContext

initiateConnectionShutdown

public CompletableFuture<Void> initiateConnectionShutdown(long drainDurationMicros)

Description copied from interface: ServiceRequestContext

Initiates graceful connection shutdown with a given drain duration in microseconds and returns CompletableFuture that completes when the channel is closed.

At the connection drain server signals the clients that the connection shutdown is imminent but still accepts in flight requests. At the connection drain end server stops accepting new requests.

If graceful shutdown is already triggered and the given connection drain duration is smaller than the wait time before the connection drain end, it reschedules the drain end to happen faster. Otherwise, drain will end as it was previously scheduled.

Note that HTTP/1 doesn't support draining as described here, so for HTTP/1 drain duration is always 0, which means the connection will be closed immediately at the end of the current response.

Specified by:

initiateConnectionShutdown in interface ServiceRequestContext

See Also:

ServiceRequestContext.initiateConnectionShutdown(), ServiceRequestContext.initiateConnectionShutdown(Duration)

initiateConnectionShutdown

public CompletableFuture<Void> initiateConnectionShutdown()

Description copied from interface: ServiceRequestContext

Initiates connection shutdown without overriding current configuration of the drain duration and returns CompletableFuture that completes when the channel is closed.

Specified by:

initiateConnectionShutdown in interface ServiceRequestContext

See Also:

ServiceRequestContext.initiateConnectionShutdown(long), ServiceRequestContext.initiateConnectionShutdown(Duration)