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.
`boolean`	`isTimedOut()`	Returns whether this `RequestContext` has been timed-out (e.g., when the corresponding request passes a deadline).
`<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`.
`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.
`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`.
`void`	`timeoutNow()`	Triggers the current timeout immediately if a timeout was scheduled before.
`CompletableFuture<Void>`	`whenRequestTimedOut()`	Returns a `CompletableFuture` which is completed after `ServiceRequestContext` has been timed out (e.g., when the corresponding request passes a deadline).
`CompletableFuture<Void>`	`whenRequestTimingOut()`	Returns a `CompletableFuture` which is completed when `ServiceRequestContext` is about to get timed out.

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

alloc, attr, attrs, computeAttrIfAbsent, decodedPath, delegate, eventLoop, id, log, logBuilder, meterRegistry, method, ownAttr, ownAttrs, path, query, root, rpcRequest, sessionProtocol, setAttr, setAttrIfAbsent, sslSession, 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, computeAttrIfAbsent, contextAwareEventLoop, contextAwareExecutor, decodedPath, eventLoop, executor, id, log, logBuilder, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, meterRegistry, method, ownAttr, ownAttrs, path, query, replace, sessionProtocol, setAttr, setAttrIfAbsent, sslSession, updateRequest, updateRpcRequest

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

pathParam, push, requestTimeoutHandler, root, rpcRequest, setRequestTimeout, setRequestTimeoutHandler, setRequestTimeoutMillis

Constructor Details
- ServiceRequestContextWrapper
  
  protected ServiceRequestContextWrapper(ServiceRequestContext delegate)
  
  Creates a new instance.

Method Details

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 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
`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
`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.