DefaultServiceRequestContext (filter-service-metrics 1.13 1.13 API)

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 and Description
`DefaultServiceRequestContext(ServiceConfig cfg, io.netty.channel.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessLogWriter`	`accessLogWriter()` Returns the `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`.
`io.netty.buffer.ByteBufAllocator`	`alloc()` Returns the `ByteBufAllocator` for this `RequestContext`.
`ScheduledExecutorService`	`blockingTaskExecutor()` Returns the `ScheduledExecutorService` that could be used for executing a potentially long-running task.
`protected io.netty.channel.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.
`String`	`decodedMappedPath()` Returns the `RequestContext.decodedPath()` with its context path removed.
`io.netty.channel.EventLoop`	`eventLoop()` Returns the `EventLoop` that is handling the current `Request`.
`void`	`extendRequestTimeout(Duration adjustment)` Extends the previously scheduled request timeout by the specified amount of `adjustment`.
`void`	`extendRequestTimeoutMillis(long adjustmentMillis)` Extends the previously scheduled request timeout by the specified amount of `adjustmentMillis`.
`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`.
`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 `ServiceRequestContext.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.
`boolean`	`removeAdditionalResponseHeader(CharSequence name)` Removes all headers with the specified `name`.
`boolean`	`removeAdditionalResponseTrailer(CharSequence name)` Removes all trailers with the specified `name`.
`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.
`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`.
`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)` Schedules the request timeout that is triggered when the `Request` is not fully received or the corresponding `Response` is not sent completely since the `Request` started.
`void`	`setRequestTimeoutAfter(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 amount time from now.
`void`	`setRequestTimeoutAfterMillis(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 amount of time from now.
`void`	`setRequestTimeoutAt(Instant requestTimeoutAt)` Schedules the request timeout that is triggered at the specified time represented as the number since the epoch (`1970-01-01T00:00:00Z`).
`void`	`setRequestTimeoutAtMillis(long requestTimeoutAtMillis)` Schedules the request timeout that is triggered at the specified time represented as the number since the epoch (`1970-01-01T00:00:00Z`).
`void`	`setRequestTimeoutHandler(Runnable requestTimeoutHandler)` Sets a handler to run when the request times out.
`void`	`setRequestTimeoutMillis(long requestTimeoutMillis)` Schedules the request timeout that is triggered when the `Request` is not fully received or the corresponding `Response` is not sent completely since the `Request` started.
`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()`
`boolean`	`verboseResponses()` Returns whether the verbose response mode is enabled.
`VirtualHost`	`virtualHost()` Returns the `VirtualHost` that is handling the current `Request`.

Methods inherited from class com.linecorp.armeria.common.NonWrappingRequestContext
attr, attrs, 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.server.ServiceRequestContext
builder, current, currentOrNull, mapCurrent, negotiatedProduceType, of, pathParam, push, request, rpcRequest

Methods inherited from interface com.linecorp.armeria.common.RequestContext
attr, attrs, computeAttrIfAbsent, contextAwareEventLoop, contextAwareExecutor, decodedPath, executor, id, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, mapCurrent, meterRegistry, method, path, push, push, push, pushIfAbsent, query, rejectPromise, replace, resolvePromise, sessionProtocol, setAttr, setAttrIfAbsent, updateRequest, updateRpcRequest

- Constructor Detail
  - DefaultServiceRequestContext
```
public DefaultServiceRequestContext(ServiceConfig cfg,
                                    io.netty.channel.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.
    
    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 Detail
  - remoteAddress
```
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
```
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,
                                               HttpRequest req,
                                               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 io.netty.channel.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
  - server
```
public Server server()
```
    Description copied from interface: ServiceRequestContext
    
    Returns the Server that is handling the current Request.
    
    Specified by:
    
    server in interface ServiceRequestContext
  - virtualHost
```
public VirtualHost virtualHost()
```
    Description copied from interface: ServiceRequestContext
    
    Returns the VirtualHost that is handling the current Request.
    
    Specified by:
    
    virtualHost in interface ServiceRequestContext
  - route
```
public Route route()
```
    Description copied from interface: ServiceRequestContext
    
    Returns the Route associated with the Service that is handling the current Request.
    
    Specified by:
    
    route 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 ServiceRequestContext.route() associated with the Service that is handling the current Request.
    
    Specified by:
    
    pathParams in interface ServiceRequestContext
  - service
```
public HttpService service()
```
    Description copied from interface: ServiceRequestContext
    
    Returns the HttpService that is handling the current Request.
    
    Specified by:
    
    service 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
```
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 io.netty.channel.EventLoop eventLoop()
```
    Description copied from interface: RequestContext
    
    Returns the EventLoop that is handling the current Request.
    
    Specified by:
    
    eventLoop in interface RequestContext
  - sslSession
```
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(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 since the Request started. This value is initially set from ServiceConfig.requestTimeoutMillis().
    For example:
```
 ServiceRequestContext ctx = ...;
 ctx.setRequestTimeoutMillis(1000);
 assert ctx.requestTimeoutMillis() == 1000;
 ctx.setRequestTimeoutMillis(2000);
 assert ctx.requestTimeoutMillis() == 2000;
 
```
    Specified by:
    
    setRequestTimeoutMillis in interface ServiceRequestContext
    
    Parameters:
    
    requestTimeoutMillis - the amount of time in milliseconds from the start time of the request
  - setRequestTimeout
```
public void setRequestTimeout(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 since the Request started. This value is initially set from ServiceConfig.requestTimeoutMillis().
    For example:
```
 ServiceRequestContext ctx = ...;
 ctx.setRequestTimeout(Duration.ofSeconds(1));
 assert ctx.requestTimeoutMillis() == 1000;
 ctx.setRequestTimeout(Duration.ofSeconds(2));
 assert ctx.requestTimeoutMillis() == 2000;
 
```
    Specified by:
    
    setRequestTimeout in interface ServiceRequestContext
    
    Parameters:
    
    requestTimeout - the amount of time from the start time of the request
  - extendRequestTimeoutMillis
```
public void extendRequestTimeoutMillis(long adjustmentMillis)
```
    Description copied from interface: ServiceRequestContext
    Extends the previously scheduled request timeout by the specified amount of adjustmentMillis. This method does nothing if no request timeout was scheduled previously. Note that a negative adjustment reduces the current timeout. The initial timeout is set from ServiceConfig.requestTimeoutMillis().
    For example:
```
 ServiceRequestContext ctx = ...;
 long oldRequestTimeoutMillis = ctx.requestTimeoutMillis();
 ctx.extendRequestTimeoutMillis(1000);
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 1000;
 ctx.extendRequestTimeoutMillis(-500);
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 500;
 
```
    Specified by:
    
    extendRequestTimeoutMillis in interface ServiceRequestContext
    
    Parameters:
    
    adjustmentMillis - the amount of time in milliseconds to extend the current timeout by
  - extendRequestTimeout
```
public void extendRequestTimeout(Duration adjustment)
```
    Description copied from interface: ServiceRequestContext
    Extends the previously scheduled request timeout by the specified amount of adjustment. This method does nothing if no response timeout was scheduled previously. Note that a negative adjustment reduces the current timeout. The initial timeout is set from ServiceConfig.requestTimeoutMillis().
    For example:
```
 ServiceRequestContext ctx = ...;
 long oldRequestTimeoutMillis = ctx.requestTimeoutMillis();
 ctx.extendRequestTimeout(Duration.ofSeconds(1));
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 1000;
 ctx.extendRequestTimeout(Duration.ofMillis(-500));
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 500;
 
```
    Specified by:
    
    extendRequestTimeout in interface ServiceRequestContext
    
    Parameters:
    
    adjustment - the amount of time to extend the current timeout by
  - setRequestTimeoutAfterMillis
```
public void setRequestTimeoutAfterMillis(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 amount of time from now. Note that the specified requestTimeoutMillis must be positive. The initial timeout is set from ServiceConfig.requestTimeoutMillis().
    For example:
```
 ServiceRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setRequestTimeoutAfterMillis(1000);
 
```
    Specified by:
    
    setRequestTimeoutAfterMillis in interface ServiceRequestContext
    
    Parameters:
    
    requestTimeoutMillis - the amount of time allowed in milliseconds from now
  - setRequestTimeoutAfter
```
public void setRequestTimeoutAfter(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 amount time from now. Note that the specified requestTimeout must be positive. The initial timeout is set from ServiceConfig.requestTimeoutMillis().
    For example:
```
 ServiceRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setRequestTimeoutAfter(Duration.ofSeconds(1));
 
```
    Specified by:
    
    setRequestTimeoutAfter in interface ServiceRequestContext
    
    Parameters:
    
    requestTimeout - the amount of time allowed from now
  - setRequestTimeoutAtMillis
```
public void setRequestTimeoutAtMillis(long requestTimeoutAtMillis)
```
    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)
  - setRequestTimeoutAt
```
public void setRequestTimeoutAt(Instant requestTimeoutAt)
```
    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.
 ctx.setRequestTimeoutAt(Instant.now().plus(1, ChronoUnit.SECONDS));
 
```
    Specified by:
    
    setRequestTimeoutAt in interface ServiceRequestContext
    
    Parameters:
    
    requestTimeoutAt - the request timeout represented as the number of milliseconds since the epoch (1970-01-01T00:00:00Z)
  - requestTimeoutHandler
```
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
  - verboseResponses
```
public boolean verboseResponses()
```
    Description copied from interface: ServiceRequestContext
    
    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.
    
    Specified by:
    
    verboseResponses in interface ServiceRequestContext
  - accessLogWriter
```
public AccessLogWriter accessLogWriter()
```
    Description copied from interface: ServiceRequestContext
    
    Returns the AccessLogWriter.
    
    Specified by:
    
    accessLogWriter in interface ServiceRequestContext
  - additionalResponseHeaders
```
public HttpHeaders additionalResponseHeaders()
```
    Description copied from interface: ServiceRequestContext
    
    Returns an immutable HttpHeaders which is 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
  - setAdditionalResponseHeaders
```
public void setAdditionalResponseHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Description copied from interface: ServiceRequestContext
    
    Clears the current header and sets the specified HttpHeaders which is included when a Service sends an HttpResponse.
    
    Specified by:
    
    setAdditionalResponseHeaders 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
  - addAdditionalResponseHeaders
```
public void addAdditionalResponseHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Description copied from interface: ServiceRequestContext
    
    Adds the specified HttpHeaders which is included when a Service sends an HttpResponse.
    
    Specified by:
    
    addAdditionalResponseHeaders in interface ServiceRequestContext
  - removeAdditionalResponseHeader
```
public boolean removeAdditionalResponseHeader(CharSequence name)
```
    Description copied from interface: ServiceRequestContext
    
    Removes all headers with the specified name.
    
    Specified by:
    
    removeAdditionalResponseHeader in interface ServiceRequestContext
    
    Returns:
    
    true if at least one entry has been removed
  - additionalResponseTrailers
```
public HttpHeaders additionalResponseTrailers()
```
    Description copied from interface: ServiceRequestContext
    
    Returns the HttpHeaders which is returned 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
  - setAdditionalResponseTrailers
```
public void setAdditionalResponseTrailers(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Description copied from interface: ServiceRequestContext
    
    Clears the current trailer and sets the specified HttpHeaders which is included when a Service completes an HttpResponse.
    
    Specified by:
    
    setAdditionalResponseTrailers 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
  - addAdditionalResponseTrailers
```
public void addAdditionalResponseTrailers(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Description copied from interface: ServiceRequestContext
    
    Adds the specified HttpHeaders which is included when a Service completes an HttpResponse.
    
    Specified by:
    
    addAdditionalResponseTrailers in interface ServiceRequestContext
  - removeAdditionalResponseTrailer
```
public boolean removeAdditionalResponseTrailer(CharSequence name)
```
    Description copied from interface: ServiceRequestContext
    
    Removes all trailers with the specified name.
    
    Specified by:
    
    removeAdditionalResponseTrailer in interface ServiceRequestContext
    
    Returns:
    
    true if at least one entry has been removed
  - 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
  - alloc
```
public io.netty.buffer.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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DefaultServiceRequestContext

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

DefaultServiceRequestContext

Method Detail

remoteAddress

localAddress

clientAddress

newDerivedContext

channel

server

virtualHost

route

routingContext

pathParams

service

blockingTaskExecutor

mappedPath

decodedMappedPath

negotiatedResponseMediaType

eventLoop

sslSession

requestTimeoutMillis

clearRequestTimeout

setRequestTimeoutMillis

setRequestTimeout

extendRequestTimeoutMillis

extendRequestTimeout

setRequestTimeoutAfterMillis

setRequestTimeoutAfter

setRequestTimeoutAtMillis

setRequestTimeoutAt

requestTimeoutHandler

setRequestTimeoutHandler

isTimedOut

maxRequestLength

setMaxRequestLength

verboseResponses

accessLogWriter

additionalResponseHeaders

setAdditionalResponseHeader

setAdditionalResponseHeaders

addAdditionalResponseHeader

addAdditionalResponseHeaders

removeAdditionalResponseHeader

additionalResponseTrailers

setAdditionalResponseTrailer

setAdditionalResponseTrailers

addAdditionalResponseTrailer

addAdditionalResponseTrailers

removeAdditionalResponseTrailer

proxiedAddresses

log

logBuilder

alloc

toString