ServiceRequestContext (filter-service-metrics 1.12 1.12 API)

All Superinterfaces:

io.netty.util.AttributeMap, RequestContext

All Known Implementing Classes:

DefaultServiceRequestContext, ServiceRequestContextWrapper
```
public interface ServiceRequestContext
extends RequestContext
```
Provides information about an invocation and related utilities. Every request being handled has its own ServiceRequestContext instance.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`AccessLogWriter`	`accessLogWriter()`
`void`	`addAdditionalResponseHeader(CharSequence name, Object value)` Adds a header with the specified `name` and `value`.
`void`	`addAdditionalResponseHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)` Adds the specified `HttpHeaders` which is included when a `Service` sends an `HttpResponse`.
`void`	`addAdditionalResponseTrailer(CharSequence name, Object value)` Adds a trailer with the specified `name` and `value`.
`void`	`addAdditionalResponseTrailers(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)` Adds the specified `HttpHeaders` which is included when a `Service` completes an `HttpResponse`.
`HttpHeaders`	`additionalResponseHeaders()` Returns an immutable `HttpHeaders` which is included when a `Service` sends an `HttpResponse`.
`HttpHeaders`	`additionalResponseTrailers()` Returns the `HttpHeaders` which is returned along with any other trailers when a `Service` completes an `HttpResponse`.
`ScheduledExecutorService`	`blockingTaskExecutor()` Returns the `ScheduledExecutorService` that could be used for executing a potentially long-running task.
`static ServiceRequestContextBuilder`	`builder(HttpRequest request)` Returns a new `ServiceRequestContextBuilder` created from the specified `HttpRequest`.
`default InetAddress`	`clientAddress()` Returns the address of the client who initiated this request.
`static ServiceRequestContext`	`current()` Returns the server-side context of the `Request` that is being handled in the current thread.
`static ServiceRequestContext`	`currentOrNull()` Returns the server-side context of the `Request` that is being handled in the current thread.
`String`	`decodedMappedPath()` Returns the `RequestContext.decodedPath()` with its context path removed.
`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.
`org.slf4j.Logger`	`logger()` Deprecated. Use a logging framework integration such as `RequestContextExportingAppender` in `armeria-logback`.
`static <T> T`	`mapCurrent(Function<? super ServiceRequestContext,T> mapper, Supplier<T> defaultValueSupplier)` Maps the server-side context of the `Request` that is being handled in the current thread.
`String`	`mappedPath()` Returns the `RequestContext.path()` with its context path removed.
`long`	`maxRequestLength()` Returns the maximum length of the current `Request`.
`default MediaType`	`negotiatedProduceType()` Deprecated. Use `negotiatedResponseMediaType()`.
`MediaType`	`negotiatedResponseMediaType()` Returns the negotiated producible media type.
`ServiceRequestContext`	`newDerivedContext(RequestId id, HttpRequest req, RpcRequest rpcReq)` Creates a new `RequestContext` whose properties and `Attribute`s are copied from this `RequestContext`, except having a different pair of `HttpRequest` and `RpcRequest` and its own `RequestLog`.
`static ServiceRequestContext`	`of(HttpRequest request)` Returns a new `ServiceRequestContext` created from the specified `HttpRequest`.
`default String`	`pathParam(String name)` Returns the value of the specified path parameter.
`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.
`boolean`	`removeAdditionalResponseHeader(CharSequence name)` Removes all headers with the specified `name`.
`boolean`	`removeAdditionalResponseTrailer(CharSequence name)` Removes all trailers with the specified `name`.
`HttpRequest`	`request()` Returns the `HttpRequest` associated with this context.
`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 `requestTimeoutMillis()`.
`long`	`requestTimeoutMillis()` Returns the amount of time allowed until receiving the current `Request` and sending the corresponding `Response` completely.
`Route`	`route()` Returns the `Route` associated with the `Service` that is handling the current `Request`.
`RoutingContext`	`routingContext()` Returns the `RoutingContext` used to find the `Service`.
`RpcRequest`	`rpcRequest()` Returns the `RpcRequest` associated with this context, or `null` if there's no `RpcRequest` associated with this context.
`Server`	`server()` Returns the `Server` that is handling the current `Request`.
`HttpService`	`service()` Returns the `HttpService` that is handling the current `Request`.
`void`	`setAdditionalResponseHeader(CharSequence name, Object value)` Sets a header with the specified `name` and `value`.
`void`	`setAdditionalResponseHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)` Clears the current header and sets the specified `HttpHeaders` which is included when a `Service` sends an `HttpResponse`.
`void`	`setAdditionalResponseTrailer(CharSequence name, Object value)` Sets a trailer with the specified `name` and `value`.
`void`	`setAdditionalResponseTrailers(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)` Clears the current trailer and sets the specified `HttpHeaders` which is included when a `Service` completes an `HttpResponse`.
`void`	`setMaxRequestLength(long maxRequestLength)` Sets the maximum length of the current `Request`.
`void`	`setRequestTimeout(Duration requestTimeout)` Sets the amount of time allowed until receiving the current `Request` and sending the corresponding `Response` completely.
`void`	`setRequestTimeoutHandler(Runnable requestTimeoutHandler)` Sets a handler to run when the request times out.
`void`	`setRequestTimeoutMillis(long requestTimeoutMillis)` Sets the amount of time allowed until receiving the current `Request` and sending the corresponding `Response` completely.
`boolean`	`verboseResponses()` Returns whether the verbose response mode is enabled.
`VirtualHost`	`virtualHost()` Returns the `VirtualHost` that is handling the current `Request`.

Methods inherited from interface com.linecorp.armeria.common.RequestContext
alloc, attrs, contextAwareEventLoop, contextAwareExecutor, decodedPath, eventLoop, executor, id, invokeOnChildCallbacks, invokeOnEnterCallbacks, invokeOnExitCallbacks, log, logBuilder, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, mapCurrent, meterRegistry, method, onChild, onEnter, onEnter, onExit, onExit, path, push, push, push, push, pushIfAbsent, query, rejectPromise, resolvePromise, sessionProtocol, sslSession, updateRequest, updateRpcRequest

Methods inherited from interface io.netty.util.AttributeMap
attr, hasAttr

- Method Detail
  - current
```
static ServiceRequestContext current()
```
    Returns the server-side context of the Request that is being handled in the current thread.
    
    Specified by:
    
    current in interface RequestContext
    
    Throws:
    
    IllegalStateException - if the context is unavailable in the current thread or the current context is not a ServiceRequestContext.
  - currentOrNull
```
@Nullable
static ServiceRequestContext currentOrNull()
```
    Returns the server-side context of the Request that is being handled in the current thread.
    
    Specified by:
    
    currentOrNull in interface RequestContext
    
    Returns:
    
    the ServiceRequestContext available in the current thread, or null if unavailable.
    
    Throws:
    
    IllegalStateException - if the current context is not a ServiceRequestContext.
  - mapCurrent
```
@Nullable
static <T> T mapCurrent(Function<? super ServiceRequestContext,T> mapper,
                                  @Nullable
                                  Supplier<T> defaultValueSupplier)
```
    Maps the server-side context of the Request that is being handled in the current thread.
    
    Parameters:
    
    mapper - the Function that maps the ServiceRequestContext
    
    defaultValueSupplier - the Supplier that provides the value when the context is unavailable in the current thread. If null, the null will be returned when the context is unavailable in the current thread.
    
    Throws:
    
    IllegalStateException - if the current context is not a ServiceRequestContext.
  - of
```
static ServiceRequestContext of(HttpRequest request)
```
    Returns a new ServiceRequestContext created from the specified HttpRequest. Note that it is not usually required to create a new context by yourself, because Armeria will always provide a context object for you. However, it may be useful in some cases such as unit testing.
    
    See Also:
    
    ServiceRequestContextBuilder
  - builder
```
static ServiceRequestContextBuilder builder(HttpRequest request)
```
    Returns a new ServiceRequestContextBuilder created from the specified HttpRequest.
  - request
```
@Nonnull
HttpRequest request()
```
    Returns the HttpRequest associated with this context.
    
    Specified by:
    
    request in interface RequestContext
  - rpcRequest
```
@Nullable
RpcRequest rpcRequest()
```
    Returns the RpcRequest associated with this context, or null if there's no RpcRequest associated with this context. For example, this method will return null when the request being handled is 1) not an RPC request or 2) not decoded into an RPC request yet.
    
    Specified by:
    
    rpcRequest in interface RequestContext
  - remoteAddress
```
@Nonnull
<A extends SocketAddress> A remoteAddress()
```
    Returns the remote address of this request.
    
    Specified by:
    
    remoteAddress in interface RequestContext
  - localAddress
```
@Nonnull
<A extends SocketAddress> A localAddress()
```
    Returns the local address of this request.
    
    Specified by:
    
    localAddress in interface RequestContext
  - clientAddress
```
default InetAddress clientAddress()
```
    Returns the address of the client who initiated this request.
  - newDerivedContext
```
ServiceRequestContext newDerivedContext(RequestId id,
                                        @Nullable
                                        HttpRequest req,
                                        @Nullable
                                        RpcRequest rpcReq)
```
    Description copied from interface: RequestContext
    
    Creates a new RequestContext whose properties and Attributes are copied from this RequestContext, except having a different pair of HttpRequest and RpcRequest and its own RequestLog.
    
    Specified by:
    
    newDerivedContext in interface RequestContext
  - server
```
Server server()
```
    Returns the Server that is handling the current Request.
  - virtualHost
```
VirtualHost virtualHost()
```
    Returns the VirtualHost that is handling the current Request.
  - route
```
Route route()
```
    Returns the Route associated with the Service that is handling the current Request.
  - routingContext
```
RoutingContext routingContext()
```
    Returns the RoutingContext used to find the Service.
  - pathParams
```
Map<String,String> pathParams()
```
    Returns the path parameters mapped by the route() associated with the Service that is handling the current Request.
  - pathParam
```
@Nullable
default String pathParam(String name)
```
    Returns the value of the specified path parameter.
  - service
```
HttpService service()
```
    Returns the HttpService that is handling the current Request.
  - blockingTaskExecutor
```
ScheduledExecutorService blockingTaskExecutor()
```
    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.
  - mappedPath
```
String mappedPath()
```
    Returns the RequestContext.path() with its context path removed. This method can be useful for a reusable service bound at various path prefixes.
  - decodedMappedPath
```
String decodedMappedPath()
```
    Returns the RequestContext.decodedPath() with its context path removed. This method can be useful for a reusable service bound at various path prefixes.
  - negotiatedResponseMediaType
```
@Nullable
MediaType negotiatedResponseMediaType()
```
    Returns the negotiated producible media type. If the media type negotiation is not used for the Service, null would be returned.
  - negotiatedProduceType
```
@Deprecated
 @Nullable
default MediaType negotiatedProduceType()
```
    Deprecated. Use negotiatedResponseMediaType().
    
    Returns the negotiated producible media type. If the media type negotiation is not used for the Service, null would be returned.
  - logger
```
@Deprecated
org.slf4j.Logger logger()
```
    Deprecated. Use a logging framework integration such as RequestContextExportingAppender in armeria-logback.
    
    Returns the Logger of the Service.
  - requestTimeoutMillis
```
long requestTimeoutMillis()
```
    Returns the amount of time allowed until receiving the current Request and sending the corresponding Response completely. This value is initially set from ServiceConfig.requestTimeoutMillis().
  - setRequestTimeoutMillis
```
void setRequestTimeoutMillis(long requestTimeoutMillis)
```
    Sets the amount of time allowed until receiving the current Request and sending the corresponding Response completely. This value is initially set from ServiceConfig.requestTimeoutMillis().
  - setRequestTimeout
```
void setRequestTimeout(Duration requestTimeout)
```
    Sets the amount of time allowed until receiving the current Request and sending the corresponding Response completely. This value is initially set from ServiceConfig.requestTimeoutMillis().
  - requestTimeoutHandler
```
@Nullable
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 requestTimeoutMillis().
  - setRequestTimeoutHandler
```
void setRequestTimeoutHandler(Runnable requestTimeoutHandler)
```
    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();
   });
   ...
 
```
  - isTimedOut
```
boolean isTimedOut()
```
    Returns whether this ServiceRequestContext has been timed-out (e.g., when the corresponding request passes a deadline).
    
    Specified by:
    
    isTimedOut in interface RequestContext
  - maxRequestLength
```
long maxRequestLength()
```
    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.
    
    See Also:
    
    ContentTooLargeException
  - setMaxRequestLength
```
void setMaxRequestLength(long maxRequestLength)
```
    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.
    
    See Also:
    
    ContentTooLargeException
  - verboseResponses
```
boolean verboseResponses()
```
    Returns whether the verbose response mode is enabled. When enabled, the service responses will contain the exception type and its full stack trace, which may be useful for debugging while potentially insecure. When disabled, the service responses will not expose such server-side details to the client.
  - accessLogWriter
```
AccessLogWriter accessLogWriter()
```
  - additionalResponseHeaders
```
HttpHeaders additionalResponseHeaders()
```
    Returns an immutable HttpHeaders which is included when a Service sends an HttpResponse.
  - setAdditionalResponseHeader
```
void setAdditionalResponseHeader(CharSequence name,
                                 Object value)
```
    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.
  - setAdditionalResponseHeaders
```
void setAdditionalResponseHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Clears the current header and sets the specified HttpHeaders which is included when a Service sends an HttpResponse.
  - addAdditionalResponseHeader
```
void addAdditionalResponseHeader(CharSequence name,
                                 Object value)
```
    Adds a header with the specified name and value. The header will be included when a Service sends an HttpResponse.
  - addAdditionalResponseHeaders
```
void addAdditionalResponseHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Adds the specified HttpHeaders which is included when a Service sends an HttpResponse.
  - removeAdditionalResponseHeader
```
boolean removeAdditionalResponseHeader(CharSequence name)
```
    Removes all headers with the specified name.
    
    Returns:
    
    true if at least one entry has been removed
  - additionalResponseTrailers
```
HttpHeaders additionalResponseTrailers()
```
    Returns the HttpHeaders which is returned along with any other trailers when a Service completes an HttpResponse.
  - setAdditionalResponseTrailer
```
void setAdditionalResponseTrailer(CharSequence name,
                                  Object value)
```
    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.
  - setAdditionalResponseTrailers
```
void setAdditionalResponseTrailers(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Clears the current trailer and sets the specified HttpHeaders which is included when a Service completes an HttpResponse.
  - addAdditionalResponseTrailer
```
void addAdditionalResponseTrailer(CharSequence name,
                                  Object value)
```
    Adds a trailer with the specified name and value. The trailer will be included when a Service completes an HttpResponse.
  - addAdditionalResponseTrailers
```
void addAdditionalResponseTrailers(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Adds the specified HttpHeaders which is included when a Service completes an HttpResponse.
  - removeAdditionalResponseTrailer
```
boolean removeAdditionalResponseTrailer(CharSequence name)
```
    Removes all trailers with the specified name.
    
    Returns:
    
    true if at least one entry has been removed
  - proxiedAddresses
```
ProxiedAddresses proxiedAddresses()
```
    Returns the proxied addresses of the current Request.

Interface ServiceRequestContext

Method Summary

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

Methods inherited from interface io.netty.util.AttributeMap

Method Detail

current

currentOrNull

mapCurrent

of

builder

request

rpcRequest

remoteAddress

localAddress

clientAddress

newDerivedContext

server

virtualHost

route

routingContext

pathParams

pathParam

service

blockingTaskExecutor

mappedPath

decodedMappedPath

negotiatedResponseMediaType

negotiatedProduceType

logger

requestTimeoutMillis

setRequestTimeoutMillis

setRequestTimeout

requestTimeoutHandler

setRequestTimeoutHandler

isTimedOut

maxRequestLength

setMaxRequestLength

verboseResponses

accessLogWriter

additionalResponseHeaders

setAdditionalResponseHeader

setAdditionalResponseHeaders

addAdditionalResponseHeader

addAdditionalResponseHeaders

removeAdditionalResponseHeader

additionalResponseTrailers

setAdditionalResponseTrailer

setAdditionalResponseTrailers

addAdditionalResponseTrailer

addAdditionalResponseTrailers

removeAdditionalResponseTrailer

proxiedAddresses