RequestContext (filter-service-metrics 1.13 1.13 API)

All Known Subinterfaces:

ClientRequestContext, ServiceRequestContext

All Known Implementing Classes:

ClientRequestContextWrapper, DefaultClientRequestContext, DefaultServiceRequestContext, NonWrappingRequestContext, RequestContextWrapper, ServiceRequestContextWrapper
```
public interface RequestContext
```
Provides information about a Request, its Response and related utilities. A server-side Request has a ServiceRequestContext and a client-side Request has a ClientRequestContext.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default io.netty.buffer.ByteBufAllocator`	`alloc()` Returns the `ByteBufAllocator` for this `RequestContext`.
`<V> V`	`attr(io.netty.util.AttributeKey<V> key)` Returns the value mapped to the given `AttributeKey` or `null` if there's no value set by `setAttr(AttributeKey, Object)` or `setAttrIfAbsent(AttributeKey, Object)`.
`Iterator<Map.Entry<io.netty.util.AttributeKey<?>,Object>>`	`attrs()` Returns the `Iterator` of all `Map.Entry`s this context contains.
`<V> V`	`computeAttrIfAbsent(io.netty.util.AttributeKey<V> key, Function<? super io.netty.util.AttributeKey<V>,? extends V> mappingFunction)` If the specified `AttributeKey` is not already associated with a value (or is mapped to `null`), attempts to compute its value using the given mapping function and stores it into this context.
`default io.netty.channel.EventLoop`	`contextAwareEventLoop()` Returns an `EventLoop` that will make sure this `RequestContext` is set as the current context before executing any callback.
`default Executor`	`contextAwareExecutor()` Returns an `Executor` that will make sure this `RequestContext` is set as the current context before executing any callback.
`static <T extends RequestContext> T`	`current()` Returns the context of the `Request` that is being handled in the current thread.
`static <T extends RequestContext> T`	`currentOrNull()` Returns the context of the `Request` that is being handled in the current thread.
`String`	`decodedPath()` Returns the absolute path part of the current `Request` URI, excluding the query part, decoded in UTF-8.
`io.netty.channel.EventLoop`	`eventLoop()` Returns the `EventLoop` that is handling the current `Request`.
`default Executor`	`executor()` Returns the `Executor` that is handling the current `Request`.
`RequestId`	`id()` Returns the `RequestId` of the current `Request` and `Response` pair.
`<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`.
`default <T,U> BiConsumer<T,U>`	`makeContextAware(BiConsumer<T,U> action)` Returns a `BiConsumer` that makes sure the current `RequestContext` is set and then invokes the input `action`.
`default <T,U,V> BiFunction<T,U,V>`	`makeContextAware(BiFunction<T,U,V> function)` Returns a `BiFunction` that makes sure the current `RequestContext` is set and then invokes the input `function`.
`default <T> Callable<T>`	`makeContextAware(Callable<T> callable)` Returns a `Callable` that makes sure the current `RequestContext` is set and then invokes the input `callable`.
`default io.netty.channel.ChannelFutureListener`	`makeContextAware(io.netty.channel.ChannelFutureListener listener)` Deprecated. Use `CompletableFuture` instead.
`default <T> CompletableFuture<T>`	`makeContextAware(CompletableFuture<T> future)` Returns a `CompletableFuture` that makes sure the current `RequestContext` is set and then invokes the input `future`.
`default <T> CompletionStage<T>`	`makeContextAware(CompletionStage<T> stage)` Returns a `CompletionStage` that makes sure the current `RequestContext` is set and then invokes the input `stage`.
`default <T> Consumer<T>`	`makeContextAware(Consumer<T> action)` Returns a `Consumer` that makes sure the current `RequestContext` is set and then invokes the input `action`.
`default Executor`	`makeContextAware(Executor executor)` Returns an `Executor` that will execute callbacks in the given `executor`, making sure to propagate the current `RequestContext` into the callback execution.
`default ExecutorService`	`makeContextAware(ExecutorService executor)` Returns an `ExecutorService` that will execute callbacks in the given `executor`, making sure to propagate the current `RequestContext` into the callback execution.
`default <T,R> Function<T,R>`	`makeContextAware(Function<T,R> function)` Returns a `Function` that makes sure the current `RequestContext` is set and then invokes the input `function`.
`default <T> io.netty.util.concurrent.FutureListener<T>`	`makeContextAware(io.netty.util.concurrent.FutureListener<T> listener)` Deprecated. Use `CompletableFuture` instead.
`default <T extends io.netty.util.concurrent.Future<?>> io.netty.util.concurrent.GenericFutureListener<T>`	`makeContextAware(io.netty.util.concurrent.GenericFutureListener<T> listener)` Deprecated. Use `CompletableFuture` instead.
`default org.slf4j.Logger`	`makeContextAware(org.slf4j.Logger logger)` Returns a `Logger` which prepends this `RequestContext` to the log message.
`default Runnable`	`makeContextAware(Runnable runnable)` Returns a `Runnable` that makes sure the current `RequestContext` is set and then invokes the input `runnable`.
`default ScheduledExecutorService`	`makeContextAware(ScheduledExecutorService executor)` Returns a `ScheduledExecutorService` that will execute callbacks in the given `executor`, making sure to propagate the current `RequestContext` into the callback execution.
`static <T> T`	`mapCurrent(Function<? super RequestContext,T> mapper, Supplier<T> defaultValueSupplier)` Maps the context of the `Request` that is being handled in the current thread.
`MeterRegistry`	`meterRegistry()` Returns the `MeterRegistry` that collects various stats.
`HttpMethod`	`method()` Returns the HTTP method of the current `Request`.
`RequestContext`	`newDerivedContext(RequestId id, HttpRequest req, RpcRequest rpcReq)` Creates a new `RequestContext` whose properties and `attrs()` are copied from this `RequestContext`, except having a different pair of `HttpRequest` and `RpcRequest` and its own `RequestLog`.
`String`	`path()` Returns the absolute path part of the current `Request` URI, excluding the query part, as defined in RFC3986.
`SafeCloseable`	`push()` Pushes the specified context to the thread-local stack.
`default SafeCloseable`	`push(boolean runCallbacks)` Deprecated. Use `push()`.
`static SafeCloseable`	`push(RequestContext ctx)` Deprecated. Use `push()`.
`static SafeCloseable`	`push(RequestContext ctx, boolean runCallbacks)` Deprecated. Use `push()`.
`default SafeCloseable`	`pushIfAbsent()` Deprecated. Use `push()`.
`String`	`query()` Returns the query part of the current `Request` URI, without the leading `'?'`
`default void`	`rejectPromise(io.netty.util.concurrent.Promise<?> promise, Throwable cause)` Deprecated. Use `CompletableFuture` instead.
`<A extends SocketAddress> A`	`remoteAddress()` Returns the remote address of this request, or `null` if the connection is not established yet.
`default SafeCloseable`	`replace()` Replaces the current `RequestContext` in the thread-local with this context without any validation.
`HttpRequest`	`request()` Returns the `HttpRequest` associated with this context, or `null` if there's no `HttpRequest` associated with this context yet.
`default void`	`resolvePromise(io.netty.util.concurrent.Promise<?> promise, Object result)` Deprecated. Use `CompletableFuture` instead.
`RpcRequest`	`rpcRequest()` Returns the `RpcRequest` associated with this context, or `null` if there's no `RpcRequest` associated with this context.
`SessionProtocol`	`sessionProtocol()` Returns the `SessionProtocol` of the current `Request`.
`<V> void`	`setAttr(io.netty.util.AttributeKey<V> key, V value)` Associates the specified value with the given `AttributeKey` in this context.
`<V> V`	`setAttrIfAbsent(io.netty.util.AttributeKey<V> key, V value)` Associates the specified value with the given `AttributeKey` in this context only if this context does not contain a mapping for the `AttributeKey`.
`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.
`void`	`updateRequest(HttpRequest req)` Replaces the `HttpRequest` associated with this context with the specified one.
`void`	`updateRpcRequest(RpcRequest rpcReq)` Replaces the `RpcRequest` associated with this context with the specified one.

- Method Detail
  - current
```
static <T extends RequestContext> T current()
```
    Returns the context of the Request that is being handled in the current thread.
    
    Throws:
    
    IllegalStateException - if the context is unavailable in the current thread
  - currentOrNull
```
static <T extends RequestContext> T currentOrNull()
```
    Returns the context of the Request that is being handled in the current thread.
    
    Returns:
    
    the RequestContext available in the current thread, or null if unavailable.
  - mapCurrent
```
static <T> T mapCurrent(Function<? super RequestContext,T> mapper,
                        Supplier<T> defaultValueSupplier)
```
    Maps the context of the Request that is being handled in the current thread.
    
    Parameters:
    
    mapper - the Function that maps the RequestContext
    
    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.
  - attr
```
<V> V attr(io.netty.util.AttributeKey<V> key)
```
    Returns the value mapped to the given AttributeKey or null if there's no value set by setAttr(AttributeKey, Object) or setAttrIfAbsent(AttributeKey, Object).
  - setAttr
```
<V> void setAttr(io.netty.util.AttributeKey<V> key,
                 V value)
```
    Associates the specified value with the given AttributeKey in this context. If this context previously contained a mapping for the AttributeKey, the old value is replaced by the specified value. Set null not to iterate the mapping from attrs().
  - setAttrIfAbsent
```
<V> V setAttrIfAbsent(io.netty.util.AttributeKey<V> key,
                      V value)
```
    Associates the specified value with the given AttributeKey in this context only if this context does not contain a mapping for the AttributeKey.
    
    Returns:
    
    null if there was no mapping for the AttributeKey or the old value if there's a mapping for the AttributeKey.
  - computeAttrIfAbsent
```
<V> V computeAttrIfAbsent(io.netty.util.AttributeKey<V> key,
                          Function<? super io.netty.util.AttributeKey<V>,? extends V> mappingFunction)
```
    If the specified AttributeKey is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and stores it into this context.
    If the mapping function returns null, no mapping is recorded.
    
    Returns:
    
    the current (existing or computed) value associated with the specified AttributeKey, or null if the computed value is null
  - attrs
```
Iterator<Map.Entry<io.netty.util.AttributeKey<?>,Object>> attrs()
```
    Returns the Iterator of all Map.Entrys this context contains.
  - request
```
HttpRequest request()
```
    Returns the HttpRequest associated with this context, or null if there's no HttpRequest associated with this context yet.
  - rpcRequest
```
RpcRequest rpcRequest()
```
    Returns the RpcRequest associated with this context, or null if there's no RpcRequest associated with this context.
  - updateRequest
```
void updateRequest(HttpRequest req)
```
    Replaces the HttpRequest associated with this context with the specified one. This method is useful to a decorator that manipulates HTTP request headers.
    Note that it is a bad idea to change the values of the pseudo headers (":method", ":path", ":scheme" and ":authority") when replacing an HttpRequest, because the properties of this context, such as path(), are unaffected by such an attempt.
    
    See Also:
    
    HttpRequest.withHeaders(RequestHeaders), HttpRequest.withHeaders(RequestHeadersBuilder)
  - updateRpcRequest
```
void updateRpcRequest(RpcRequest rpcReq)
```
    Replaces the RpcRequest associated with this context with the specified one. This method is useful to a decorator that manipulates an RPC call.
  - sessionProtocol
```
SessionProtocol sessionProtocol()
```
    Returns the SessionProtocol of the current Request.
  - remoteAddress
```
<A extends SocketAddress> A remoteAddress()
```
    Returns the remote address of this request, or null if the connection is not established yet.
  - localAddress
```
<A extends SocketAddress> A localAddress()
```
    Returns the local address of this request, or null if the connection is not established yet.
  - sslSession
```
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.
  - id
```
RequestId id()
```
    Returns the RequestId of the current Request and Response pair.
  - method
```
HttpMethod method()
```
    Returns the HTTP method of the current Request.
  - path
```
String path()
```
    Returns the absolute path part of the current Request URI, excluding the query part, as defined in RFC3986.
  - decodedPath
```
String decodedPath()
```
    Returns the absolute path part of the current Request URI, excluding the query part, decoded in UTF-8.
  - query
```
String query()
```
    Returns the query part of the current Request URI, without the leading '?', as defined in RFC3986.
  - log
```
RequestLogAccess log()
```
    Returns the RequestLogAccess that provides the access to the RequestLog, which contains the information collected while processing the current Request.
  - logBuilder
```
RequestLogBuilder logBuilder()
```
    Returns the RequestLogBuilder that collects the information about the current Request.
  - meterRegistry
```
MeterRegistry meterRegistry()
```
    Returns the MeterRegistry that collects various stats.
  - executor
```
default Executor executor()
```
    Returns the Executor that is handling the current Request.
  - eventLoop
```
io.netty.channel.EventLoop eventLoop()
```
    Returns the EventLoop that is handling the current Request.
  - alloc
```
default io.netty.buffer.ByteBufAllocator alloc()
```
    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.
  - contextAwareExecutor
```
default Executor contextAwareExecutor()
```
    Returns an Executor that will make sure this RequestContext is set as the current context before executing any callback. This should almost always be used for executing asynchronous callbacks in service code to make sure features that require the RequestContext work properly. Most asynchronous libraries like CompletableFuture provide methods that accept an Executor to run callbacks on.
  - contextAwareEventLoop
```
default io.netty.channel.EventLoop contextAwareEventLoop()
```
    Returns an EventLoop that will make sure this RequestContext is set as the current context before executing any callback.
  - push
```
@Deprecated
static SafeCloseable push(RequestContext ctx)
```
    Deprecated. Use push().
    
    Pushes the specified context to the thread-local stack. To pop the context from the stack, call SafeCloseable.close(), which can be done using a try-with-resources block.
    This method may throw an IllegalStateException according to the status of the current thread-local. Please see ServiceRequestContext.push() and ClientRequestContext.push() to find out the satisfying conditions.
  - push
```
@Deprecated
static SafeCloseable push(RequestContext ctx,
                                      boolean runCallbacks)
```
    Deprecated. Use push().
    
    Pushes the specified context to the thread-local stack. To pop the context from the stack, call SafeCloseable.close(), which can be done using a try-with-resources block.
    This method may throw an IllegalStateException according to the status of the current thread-local. Please see ServiceRequestContext.push() and ClientRequestContext.push() to find out the satisfying conditions.
  - push
```
SafeCloseable push()
```
    Pushes the specified context to the thread-local stack. To pop the context from the stack, call SafeCloseable.close(), which can be done using a try-with-resources block:
```
 try (SafeCloseable ignored = ctx.push()) {
     ...
 }
 
```
    This method may throw an IllegalStateException according to the status of the current thread-local. Please see ServiceRequestContext.push() and ClientRequestContext.push() to find out the satisfying conditions.
  - push
```
@Deprecated
default SafeCloseable push(boolean runCallbacks)
```
    Deprecated. Use push().
    
    Pushes the specified context to the thread-local stack. To pop the context from the stack, call SafeCloseable.close(), which can be done using a try-with-resources block:
    This method may throw an IllegalStateException according to the status of the current thread-local. Please see ServiceRequestContext.push() and ClientRequestContext.push() to find out the satisfying conditions.
    
    Parameters:
    
    runCallbacks - This is not used.
  - pushIfAbsent
```
@Deprecated
default SafeCloseable pushIfAbsent()
```
    Deprecated. Use push().
    
    Pushes this context to the thread-local stack. To pop the context from the stack, call SafeCloseable.close(), which can be done using a try-with-resources block.
    This method may throw an IllegalStateException according to the status of the current thread-local. Please see ServiceRequestContext.push() and ClientRequestContext.push() to find out the satisfying conditions.
  - replace
```
default SafeCloseable replace()
```
    Replaces the current RequestContext in the thread-local with this context without any validation. This method also does not run any callbacks.
    Note: Do not use this if you don't know what you are doing. This method does not prevent the situation where a wrong RequestContext is pushed into the thread-local. Use push() instead.
    
    See Also:
    
    ClientRequestContext.push(), ServiceRequestContext.push()
  - makeContextAware
```
default Executor makeContextAware(Executor executor)
```
    Returns an Executor that will execute callbacks in the given executor, making sure to propagate the current RequestContext into the callback execution. It is generally preferred to use contextAwareEventLoop() to ensure the callback stays on the same thread as well.
  - makeContextAware
```
default ExecutorService makeContextAware(ExecutorService executor)
```
    Returns an ExecutorService that will execute callbacks in the given executor, making sure to propagate the current RequestContext into the callback execution.
  - makeContextAware
```
default ScheduledExecutorService makeContextAware(ScheduledExecutorService executor)
```
    Returns a ScheduledExecutorService that will execute callbacks in the given executor, making sure to propagate the current RequestContext into the callback execution.
  - makeContextAware
```
default <T> Callable<T> makeContextAware(Callable<T> callable)
```
    Returns a Callable that makes sure the current RequestContext is set and then invokes the input callable.
  - makeContextAware
```
default Runnable makeContextAware(Runnable runnable)
```
    Returns a Runnable that makes sure the current RequestContext is set and then invokes the input runnable.
  - makeContextAware
```
default <T,R> Function<T,R> makeContextAware(Function<T,R> function)
```
    Returns a Function that makes sure the current RequestContext is set and then invokes the input function.
  - makeContextAware
```
default <T,U,V> BiFunction<T,U,V> makeContextAware(BiFunction<T,U,V> function)
```
    Returns a BiFunction that makes sure the current RequestContext is set and then invokes the input function.
  - makeContextAware
```
default <T> Consumer<T> makeContextAware(Consumer<T> action)
```
    Returns a Consumer that makes sure the current RequestContext is set and then invokes the input action.
  - makeContextAware
```
default <T,U> BiConsumer<T,U> makeContextAware(BiConsumer<T,U> action)
```
    Returns a BiConsumer that makes sure the current RequestContext is set and then invokes the input action.
  - makeContextAware
```
@Deprecated
default <T> io.netty.util.concurrent.FutureListener<T> makeContextAware(io.netty.util.concurrent.FutureListener<T> listener)
```
    Deprecated. Use CompletableFuture instead.
    
    Returns a FutureListener that makes sure the current RequestContext is set and then invokes the input listener.
  - makeContextAware
```
@Deprecated
default io.netty.channel.ChannelFutureListener makeContextAware(io.netty.channel.ChannelFutureListener listener)
```
    Deprecated. Use CompletableFuture instead.
    
    Returns a ChannelFutureListener that makes sure the current RequestContext is set and then invokes the input listener.
  - makeContextAware
```
@Deprecated
default <T extends io.netty.util.concurrent.Future<?>> io.netty.util.concurrent.GenericFutureListener<T> makeContextAware(io.netty.util.concurrent.GenericFutureListener<T> listener)
```
    Deprecated. Use CompletableFuture instead.
    
    Returns a GenericFutureListener that makes sure the current RequestContext is set and then invokes the input listener. Unlike other versions of makeContextAware, this one will invoke the listener with the future's result even if the context has already been timed out.
  - makeContextAware
```
default <T> CompletionStage<T> makeContextAware(CompletionStage<T> stage)
```
    Returns a CompletionStage that makes sure the current RequestContext is set and then invokes the input stage.
  - makeContextAware
```
default <T> CompletableFuture<T> makeContextAware(CompletableFuture<T> future)
```
    Returns a CompletableFuture that makes sure the current RequestContext is set and then invokes the input future.
  - makeContextAware
```
default org.slf4j.Logger makeContextAware(org.slf4j.Logger logger)
```
    Returns a Logger which prepends this RequestContext to the log message.
    
    Parameters:
    
    logger - the Logger to decorate.
  - resolvePromise
```
@Deprecated
default void resolvePromise(io.netty.util.concurrent.Promise<?> promise,
                                        Object result)
```
    Deprecated. Use CompletableFuture instead.
    Resolves the specified promise with the specified result so that the promise is marked as 'done'. If promise is done already, this method does the following:
    - Log a warning about the failure, and
    - Release result if it is a reference-counted object, such as ByteBuf and FullHttpResponse.
    Note that a Promise can be done already even if you did not call this method in the following cases:
    - Invocation timeout - The invocation associated with the Promise has been timed out.
    - User error - A service implementation called any of the following methods more than once:
      
      resolvePromise(Promise, Object)
      
      rejectPromise(Promise, Throwable)
      
      Promise.setSuccess(Object)
      
      Promise.setFailure(Throwable)
      
      Future.cancel(boolean)
  - rejectPromise
```
@Deprecated
default void rejectPromise(io.netty.util.concurrent.Promise<?> promise,
                                       Throwable cause)
```
    Deprecated. Use CompletableFuture instead.
    Rejects the specified promise with the specified cause. If promise is done already, this method logs a warning about the failure. Note that a Promise can be done already even if you did not call this method in the following cases:
    - Invocation timeout - The invocation associated with the Promise has been timed out.
    - User error - A service implementation called any of the following methods more than once:
      
      resolvePromise(Promise, Object)
      
      rejectPromise(Promise, Throwable)
      
      Promise.setSuccess(Object)
      
      Promise.setFailure(Throwable)
      
      Future.cancel(boolean)
  - newDerivedContext
```
RequestContext newDerivedContext(RequestId id,
                                 HttpRequest req,
                                 RpcRequest rpcReq)
```
    Creates a new RequestContext whose properties and attrs() are copied from this RequestContext, except having a different pair of HttpRequest and RpcRequest and its own RequestLog.

Interface RequestContext

Method Summary

Method Detail

current

currentOrNull

mapCurrent

attr

setAttr

setAttrIfAbsent

computeAttrIfAbsent

attrs

request

rpcRequest

updateRequest

updateRpcRequest

sessionProtocol

remoteAddress

localAddress

sslSession

id

method

path

decodedPath

query

log

logBuilder

meterRegistry

executor

eventLoop

alloc

contextAwareExecutor

contextAwareEventLoop

push

push

push

push

pushIfAbsent

replace

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

resolvePromise

rejectPromise

newDerivedContext