Package com.linecorp.armeria.server

Class DefaultServiceRequestContext

java.lang.Object

com.linecorp.armeria.common.NonWrappingRequestContext

com.linecorp.armeria.server.DefaultServiceRequestContext

All Implemented Interfaces:

RequestContext, ServiceRequestContext

@UnstableApi
public final class DefaultServiceRequestContext
extends NonWrappingRequestContext
implements ServiceRequestContext

Default ServiceRequestContext implementation.

Constructor Summary

Constructors

Constructor	Description
DefaultServiceRequestContext(ServiceConfig cfg, Channel ch, MeterRegistry meterRegistry, SessionProtocol sessionProtocol, RequestId id, RoutingContext routingContext, RoutingResult routingResult, HttpRequest req, SSLSession sslSession, ProxiedAddresses proxiedAddresses, InetAddress clientAddress, long requestStartTimeNanos, long requestStartTimeMicros)	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.
ByteBufAllocator	alloc()	Returns the ByteBufAllocator for this RequestContext.
<V> V	attr(AttributeKey<V> key)	Returns the value mapped to the given AttributeKey or null if there's no value set by RequestContext.setAttr(AttributeKey, Object), RequestContext.setAttrIfAbsent(AttributeKey, Object) or RequestContext.computeAttrIfAbsent(AttributeKey, Function).
Iterator<Map.Entry<AttributeKey<?>,Object>>	attrs()	Returns the Iterator of all Map.Entrys this context contains.
ScheduledExecutorService	blockingTaskExecutor()	Returns the ScheduledExecutorService that could be used for executing a potentially long-running task.
protected Channel	channel()	Returns the Channel that is handling this request, or null if the connection is not established yet.
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.
EventLoop	eventLoop()	Returns the EventLoop that is handling the current Request.
boolean	isTimedOut()	Returns whether this ServiceRequestContext 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.
RequestLogAccess	log()	Returns the RequestLogAccess that provides the access to the RequestLog, which contains the information collected while processing the current Request.
RequestLogBuilder	logBuilder()	Returns the RequestLogBuilder that collects the information about the current Request.
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.
ServiceRequestContext	newDerivedContext(RequestId id, HttpRequest req, RpcRequest rpcReq)	Creates a new RequestContext whose properties and RequestContext.attrs() are copied from this RequestContext, except having a different pair of HttpRequest and RpcRequest and its own RequestLog.
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.
Runnable	requestTimeoutHandler()	Returns Request timeout handler which is executed when receiving the current Request and sending the corresponding Response is not completely received within the allowed ServiceRequestContext.requestTimeoutMillis().
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	setRequestTimeoutAtMillis(long requestTimeoutAtMillis)	Deprecated.
void	setRequestTimeoutHandler(Runnable requestTimeoutHandler)	Sets a handler to run when the request times out.
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.
SSLSession	sslSession()	The SSLSession for this request if the connection is made over TLS, or null if the connection is not established yet or the connection is not a TLS connection.
String	toString()

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

computeAttrIfAbsent, decodedPath, id, meterRegistry, method, ownAttr, ownAttrs, path, query, request, rpcRequest, sessionProtocol, setAttr, setAttrIfAbsent, unsafeUpdateRequest, updateRequest, updateRpcRequest, validateHeaders

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

computeAttrIfAbsent, contextAwareEventLoop, contextAwareExecutor, decodedPath, executor, id, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, meterRegistry, method, ownAttr, ownAttrs, path, query, replace, sessionProtocol, setAttr, setAttrIfAbsent, updateRequest, updateRpcRequest

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

accessLogWriter, extendRequestTimeout, extendRequestTimeoutMillis, pathParam, push, request, root, route, rpcRequest, server, service, setRequestTimeout, setRequestTimeout, setRequestTimeoutAfter, setRequestTimeoutAfterMillis, setRequestTimeoutAt, setRequestTimeoutMillis, verboseResponses, virtualHost

Constructor Details

DefaultServiceRequestContext

public DefaultServiceRequestContext(ServiceConfig cfg, Channel ch, MeterRegistry meterRegistry, SessionProtocol sessionProtocol, RequestId id, RoutingContext routingContext, RoutingResult routingResult, HttpRequest req, @Nullable SSLSession sslSession, ProxiedAddresses proxiedAddresses, InetAddress clientAddress, long requestStartTimeNanos, long requestStartTimeMicros)

Creates a new instance.

Parameters:

cfg - the ServiceConfig

ch - the Channel that handles the invocation

meterRegistry - the MeterRegistry that collects various stats

sessionProtocol - the SessionProtocol of the invocation

id - the RequestId that represents the identifier of the current Request and Response pair.

routingContext - the parameters which are used when finding a matched Route

routingResult - the result of finding a matched Route

req - the request associated with this context

sslSession - the SSLSession for this invocation if it is over TLS

proxiedAddresses - source and destination addresses delivered through proxy servers

clientAddress - the address of a client who initiated the request

requestStartTimeNanos - System.nanoTime() value when the request started.

requestStartTimeMicros - the number of microseconds since the epoch, e.g. System.currentTimeMillis() * 1000.

Method Details

attr

@Nullable public <V> V attr(AttributeKey<V> key)

Description copied from interface: RequestContext

Returns the value mapped to the given AttributeKey or null if there's no value set by RequestContext.setAttr(AttributeKey, Object), RequestContext.setAttrIfAbsent(AttributeKey, Object) or RequestContext.computeAttrIfAbsent(AttributeKey, Function).

Searching for attributes in a root context

Note: This section applies only to a ClientRequestContext. A ServiceRequestContext always has itself as a RequestContext.root().

If the value does not exist in this context but only in RequestContext.root(), this method will return the value from the RequestContext.root().

 ClientRequestContext ctx = ...;
 assert ctx.root().attr(KEY).equals("root");
 assert ctx.attr(KEY).equals("root");
 assert ctx.ownAttr(KEY) == null;
 

If the value exists both in this context and RequestContext.root(), this method will return the value from this context.

 ClientRequestContext ctx = ...;
 assert ctx.root().attr(KEY).equals("root");
 assert ctx.ownAttr(KEY).equals("child");
 assert ctx.attr(KEY).equals("child");
 

Specified by:

attr in interface RequestContext

Overrides:

attr in class NonWrappingRequestContext

See Also:

RequestContext.ownAttr(AttributeKey)

attrs

public Iterator<Map.Entry<AttributeKey<?>,Object>> attrs()

Description copied from interface: RequestContext

Returns the Iterator of all Map.Entrys this context contains.

Searching for attributes in a root context

Note: This section applies only to a ClientRequestContext. A ServiceRequestContext always has itself as a RequestContext.root().

The Iterator returned by this method will also yield the Map.Entrys from the RequestContext.root() except those whose AttributeKey exist already in this context, e.g.

 ClientRequestContext ctx = ...;
 assert ctx.ownAttr(KEY_A).equals("child_a");
 assert ctx.root().attr(KEY_A).equals("root_a");
 assert ctx.root().attr(KEY_B).equals("root_b");

 Iterator<Entry<AttributeKey<?>, Object>> attrs = ctx.attrs();
 assert attrs.next().getValue().equals("child_a"); // KEY_A
 // Skip KEY_A in the root.
 assert attrs.next().getValue().equals("root_b"); // KEY_B
 assert attrs.hasNext() == false;
 

Please note that any changes made to the Map.Entry returned by Iterator.next() never affects the Map.Entry owned by RequestContext.root(). For example:

 ClientRequestContext ctx = ...;
 assert ctx.root().attr(KEY).equals("root");
 assert ctx.ownAttr(KEY) == null;

 Iterator<Entry<AttributeKey<?>, Object>> attrs = ctx.attrs();
 Entry<AttributeKey<?>, Object> next = attrs.next();
 assert next.getKey() == KEY;
 // Overriding the root entry creates the client context's own entry.
 next.setValue("child");
 assert ctx.attr(KEY).equals("child");
 assert ctx.ownAttr(KEY).equals("child");
 // root attribute remains unaffected.
 assert ctx.root().attr(KEY).equals("root");
 

If you want to change the value from the root while iterating, please call RequestContext.attrs() from RequestContext.root().

 ClientRequestContext ctx = ...;
 assert ctx.root().attr(KEY).equals("root");
 assert ctx.ownAttr(KEY) == null;

 // Call attrs() from the root to set a value directly while iterating.
 Iterator<Entry<AttributeKey<?>, Object>> attrs = ctx.root().attrs();
 Entry<AttributeKey<?>, Object> next = attrs.next();
 assert next.getKey() == KEY;
 next.setValue("another_root");
 // The ctx does not have its own attribute.
 assert ctx.ownAttr(KEY) == null;
 assert ctx.attr(KEY).equals("another_root");
 

Specified by:

attrs in interface RequestContext

Overrides:

attrs in class NonWrappingRequestContext

See Also:

RequestContext.ownAttrs()

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 NonWrappingRequestContext

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 NonWrappingRequestContext

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

newDerivedContext

public ServiceRequestContext newDerivedContext(RequestId id, @Nullable HttpRequest req, @Nullable RpcRequest rpcReq)

Description copied from interface: RequestContext

Creates a new RequestContext whose properties and RequestContext.attrs() are copied from this RequestContext, except having a different pair of HttpRequest and RpcRequest and its own RequestLog.

Specified by:

newDerivedContext in interface RequestContext

Specified by:

newDerivedContext in interface ServiceRequestContext

channel

protected Channel channel()

Description copied from class: NonWrappingRequestContext

Returns the Channel that is handling this request, or null if the connection is not established yet.

Specified by:

channel in class NonWrappingRequestContext

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 ScheduledExecutorService blockingTaskExecutor()

Description copied from interface: ServiceRequestContext

Returns the ScheduledExecutorService that could be used for executing a potentially long-running task. The ScheduledExecutorService will propagate the ServiceRequestContext automatically when running a task.

Note that performing a long-running task in Service.serve(ServiceRequestContext, Request) may block the Server's I/O event loop and thus should be executed in other threads.

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

eventLoop

public EventLoop eventLoop()

Description copied from interface: RequestContext

Returns the EventLoop that is handling the current Request.

Specified by:

eventLoop in interface RequestContext

alloc

public ByteBufAllocator alloc()

Description copied from interface: RequestContext

Returns the ByteBufAllocator for this RequestContext. Any buffers created by this ByteBufAllocator must be reference-counted. If you don't know what this means, you should probably use byte[] or ByteBuffer directly instead of calling this method.

Specified by:

alloc in interface RequestContext

sslSession

@Nullable public SSLSession sslSession()

Description copied from interface: RequestContext

The SSLSession for this request if the connection is made over TLS, or null if the connection is not established yet or the connection is not a TLS connection.

Specified by:

sslSession in interface RequestContext

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

setRequestTimeoutAtMillis

@Deprecated public void setRequestTimeoutAtMillis(long requestTimeoutAtMillis)

Deprecated.

Description copied from interface: ServiceRequestContext

Schedules the request timeout that is triggered at the specified time represented as the number since the epoch (1970-01-01T00:00:00Z). Note that the request will be timed out immediately if the specified time is before now. The initial timeout is set from ServiceConfig.requestTimeoutMillis().

For example:

 ServiceRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 long responseTimeoutAt = Instant.now().plus(1, ChronoUnit.SECONDS).toEpochMilli();
 ctx.setRequestTimeoutAtMillis(responseTimeoutAt);
 

Specified by:

setRequestTimeoutAtMillis in interface ServiceRequestContext

Parameters:

requestTimeoutAtMillis - the request timeout represented as the number of milliseconds since the epoch (1970-01-01T00:00:00Z)

requestTimeoutHandler

@Nullable public Runnable requestTimeoutHandler()

Description copied from interface: ServiceRequestContext

Returns Request timeout handler which is executed when receiving the current Request and sending the corresponding Response is not completely received within the allowed ServiceRequestContext.requestTimeoutMillis().

Specified by:

requestTimeoutHandler in interface ServiceRequestContext

setRequestTimeoutHandler

public void setRequestTimeoutHandler(Runnable requestTimeoutHandler)

Description copied from interface: ServiceRequestContext

Sets a handler to run when the request times out. requestTimeoutHandler must close the response, e.g., by calling StreamWriter.close(). If not set, the response will be closed with HttpStatus.SERVICE_UNAVAILABLE.

For example,

   HttpResponseWriter res = HttpResponse.streaming();
   ctx.setRequestTimeoutHandler(() -> {
      res.write(ResponseHeaders.of(HttpStatus.OK,
                                   HttpHeaderNames.CONTENT_TYPE, MediaType.PLAIN_TEXT_UTF_8));
      res.write(HttpData.ofUtf8("Request timed out."));
      res.close();
   });
   ...
 

Specified by:

setRequestTimeoutHandler in interface ServiceRequestContext

isTimedOut

public boolean isTimedOut()

Description copied from interface: ServiceRequestContext

Returns whether this ServiceRequestContext has been timed-out (e.g., when the corresponding request passes a deadline).

Specified by:

isTimedOut in interface ServiceRequestContext

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

log

public RequestLogAccess log()

Description copied from interface: RequestContext

Returns the RequestLogAccess that provides the access to the RequestLog, which contains the information collected while processing the current Request.

Specified by:

log in interface RequestContext

logBuilder

public RequestLogBuilder logBuilder()

Description copied from interface: RequestContext

Returns the RequestLogBuilder that collects the information about the current Request.

Specified by:

logBuilder in interface RequestContext

toString

public String toString()

Overrides:

toString in class Object