ServiceRequestContext (Armeria 0.59.2 API reference)

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 Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`java.util.concurrent.ExecutorService`	`blockingTaskExecutor()` Returns the `ExecutorService` that could be used for executing a potentially long-running task.
`<A extends java.net.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`.
`java.lang.String`	`mappedPath()` Returns the path with its context path removed.
`long`	`maxRequestLength()` Returns the maximum length of the current `Request`.
`MediaType`	`negotiatedProduceType()` Returns the negotiated producible media type.
`ServiceRequestContext`	`newDerivedContext()` Creates a new derived `RequestContext` which only the `RequestLog` is different from the deriving context.
`ServiceRequestContext`	`newDerivedContext(Request request)` Creates a new derived `RequestContext` with the specified `Request` which the `RequestLog` is different from the deriving context.
`PathMapping`	`pathMapping()` Returns the `PathMapping` associated with the `Service` that is handling the current `Request`.
`PathMappingContext`	`pathMappingContext()` Returns the `PathMappingContext` used to find the `Service`.
`default java.lang.String`	`pathParam(java.lang.String name)` Returns the value of the specified path parameter.
`java.util.Map<java.lang.String,java.lang.String>`	`pathParams()` Returns the path parameters mapped by the `PathMapping` associated with the `Service` that is handling the current `Request`.
`<A extends java.net.SocketAddress> A`	`remoteAddress()` Returns the remote address of this request.
`long`	`requestTimeoutMillis()` Returns the amount of time allowed until receiving the current `Request` completely.
`Server`	`server()` Returns the `Server` that is handling the current `Request`.
`<T extends Service<HttpRequest,HttpResponse>> T`	`service()` Returns the `Service` that is handling the current `Request`.
`void`	`setMaxRequestLength(long maxRequestLength)` Sets the maximum length of the current `Request`.
`void`	`setRequestTimeout(java.time.Duration requestTimeout)` Sets the amount of time allowed until receiving the current `Request` completely.
`void`	`setRequestTimeoutHandler(java.lang.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` completely.
`VirtualHost`	`virtualHost()` Returns the `VirtualHost` that is handling the current `Request`.

Methods inherited from interface com.linecorp.armeria.common.RequestContext
alloc, attrs, contextAwareEventLoop, current, eventLoop, invokeOnChildCallbacks, invokeOnEnterCallbacks, invokeOnExitCallbacks, isTimedOut, log, logBuilder, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, mapCurrent, meterRegistry, method, onChild, onEnter, onEnter, onExit, onExit, path, push, push, query, rejectPromise, request, resolvePromise, sessionProtocol, sslSession

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

- Method Detail
  - remoteAddress
```
@Nonnull
<A extends java.net.SocketAddress> A remoteAddress()
```
    Returns the remote address of this request.
    
    Specified by:
    
    remoteAddress in interface RequestContext
  - localAddress
```
@Nonnull
<A extends java.net.SocketAddress> A localAddress()
```
    Returns the local address of this request.
    
    Specified by:
    
    localAddress in interface RequestContext
  - newDerivedContext
```
ServiceRequestContext newDerivedContext()
```
    Description copied from interface: RequestContext
    
    Creates a new derived RequestContext which only the RequestLog is different from the deriving context. Note that the references of Attributes in the RequestContext.attrs() are copied as well.
    
    Specified by:
    
    newDerivedContext in interface RequestContext
  - newDerivedContext
```
ServiceRequestContext newDerivedContext(Request request)
```
    Description copied from interface: RequestContext
    
    Creates a new derived RequestContext with the specified Request which the RequestLog is different from the deriving context. Note that the references of Attributes in the RequestContext.attrs() are copied as well.
    
    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.
  - pathMapping
```
PathMapping pathMapping()
```
    Returns the PathMapping associated with the Service that is handling the current Request.
  - pathMappingContext
```
PathMappingContext pathMappingContext()
```
    Returns the PathMappingContext used to find the Service.
  - pathParams
```
java.util.Map<java.lang.String,java.lang.String> pathParams()
```
    Returns the path parameters mapped by the PathMapping associated with the Service that is handling the current Request.
  - pathParam
```
@Nullable
default java.lang.String pathParam(java.lang.String name)
```
    Returns the value of the specified path parameter.
  - service
```
<T extends Service<HttpRequest,HttpResponse>> T service()
```
    Returns the Service that is handling the current Request.
  - blockingTaskExecutor
```
java.util.concurrent.ExecutorService blockingTaskExecutor()
```
    Returns the ExecutorService that could be used for executing a potentially long-running task. The ExecutorService 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
```
java.lang.String mappedPath()
```
    Returns the path with its context path removed. This method can be useful for a reusable service bound at various path prefixes.
  - negotiatedProduceType
```
@Nullable
MediaType negotiatedProduceType()
```
    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 completely. This value is initially set from ServerConfig.defaultRequestTimeoutMillis().
  - setRequestTimeoutMillis
```
void setRequestTimeoutMillis(long requestTimeoutMillis)
```
    Sets the amount of time allowed until receiving the current Request completely. This value is initially set from ServerConfig.defaultRequestTimeoutMillis().
  - setRequestTimeout
```
void setRequestTimeout(java.time.Duration requestTimeout)
```
    Sets the amount of time allowed until receiving the current Request completely. This value is initially set from ServerConfig.defaultRequestTimeoutMillis().
  - setRequestTimeoutHandler
```
void setRequestTimeoutHandler(java.lang.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(HttpHeaders.of(HttpStatus.OK, MediaType.PLAIN_TEXT_UTF_8, "Request timed out."));
      res.close();
   });
   ...
 
```
  - maxRequestLength
```
long maxRequestLength()
```
    Returns the maximum length of the current Request. This value is initially set from ServerConfig.defaultMaxRequestLength(). 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 ServerConfig.defaultMaxRequestLength(). If 0, there is no limit on the request size.
    
    See Also:
    
    ContentTooLargeException

Interface ServiceRequestContext

Method Summary

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

Methods inherited from interface io.netty.util.AttributeMap

Method Detail

remoteAddress

localAddress

newDerivedContext

newDerivedContext

server

virtualHost

pathMapping

pathMappingContext

pathParams

pathParam

service

blockingTaskExecutor

mappedPath

negotiatedProduceType

logger

requestTimeoutMillis

setRequestTimeoutMillis

setRequestTimeout

setRequestTimeoutHandler

maxRequestLength

setMaxRequestLength