RequestContext (filter-service-metrics 1.12 1.12 API)

All Superinterfaces:

io.netty.util.AttributeMap

All Known Subinterfaces:

ClientRequestContext, ServiceRequestContext

All Known Implementing Classes:

AbstractRequestContext, ClientRequestContextWrapper, DefaultClientRequestContext, DefaultServiceRequestContext, NonWrappingRequestContext, RequestContextWrapper, ServiceRequestContextWrapper
```
public interface RequestContext
extends io.netty.util.AttributeMap
```
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`.
`Iterator<io.netty.util.Attribute<?>>`	`attrs()` Returns all `Attribute`s set in 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.
`void`	`invokeOnChildCallbacks(RequestContext newCtx)` Invokes all `onChild(BiConsumer)` callbacks.
`void`	`invokeOnEnterCallbacks()` Invokes all `onEnter(Consumer)` callbacks.
`void`	`invokeOnExitCallbacks()` Invokes all `onExit(Consumer)` callbacks.
`boolean`	`isTimedOut()` Deprecated. Use `ServiceRequestContext.isTimedOut()`.
`<A extends SocketAddress> A`	`localAddress()` Returns the local address of this request, or `null` if the connection is not established yet.
`RequestLog`	`log()` Returns the `RequestLog` that contains the information about the current `Request`.
`RequestLogBuilder`	`logBuilder()` Returns the `RequestLogBuilder` that collects the information about the current `Request`.
`<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`.
`<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`.
`<T> Callable<T>`	`makeContextAware(Callable<T> callable)` Returns a `Callable` that makes sure the current `RequestContext` is set and then invokes the input `callable`.
`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 `CompletableFuture` is set and then invokes the input `future`.
`<T> CompletionStage<T>`	`makeContextAware(CompletionStage<T> stage)` Returns a `CompletionStage` that makes sure the current `CompletionStage` is set and then invokes the input `stage`.
`<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.
`<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`.
`<T> io.netty.util.concurrent.FutureListener<T>`	`makeContextAware(io.netty.util.concurrent.FutureListener<T> listener)` Deprecated. Use `CompletableFuture` instead.
`<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.
`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 `Attribute`s are copied from this `RequestContext`, except having a different pair of `HttpRequest` and `RpcRequest` and its own `RequestLog`.
`void`	`onChild(BiConsumer<? super RequestContext,? super RequestContext> callback)` Registers `callback` to be run when this context is replaced by a child context.
`void`	`onEnter(Consumer<? super RequestContext> callback)` Registers `callback` to be run when re-entering this `RequestContext`, usually when using the `makeContextAware(java.util.concurrent.Executor)` family of methods.
`default void`	`onEnter(Runnable callback)` Deprecated. Use `onEnter(Consumer)` instead.
`void`	`onExit(Consumer<? super RequestContext> callback)` Registers `callback` to be run when re-exiting this `RequestContext`, usually when using the `makeContextAware(java.util.concurrent.Executor)` family of methods.
`default void`	`onExit(Runnable callback)` Deprecated. Use `onExit(Consumer)` instead.
`String`	`path()` Returns the absolute path part of the current `Request` URI, excluding the query part, as defined in RFC3986.
`default SafeCloseable`	`push()` Pushes the specified context to the thread-local stack.
`default SafeCloseable`	`push(boolean runCallbacks)` Pushes the specified context to the thread-local stack.
`static SafeCloseable`	`push(RequestContext ctx)` Deprecated. Use `push()`.
`static SafeCloseable`	`push(RequestContext ctx, boolean runCallbacks)` Deprecated. Use `push(boolean)`.
`default SafeCloseable`	`pushIfAbsent()` Pushes this context to the thread-local stack if there is no current context.
`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.
`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`.
`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.

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

- 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
```
@Nullable
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
```
@Nullable
static <T> T mapCurrent(Function<? super RequestContext,T> mapper,
                                  @Nullable
                                  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.
  - request
```
@Nullable
HttpRequest request()
```
    Returns the HttpRequest associated with this context, or null if there's no HttpRequest associated with this context yet.
  - rpcRequest
```
@Nullable
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
```
@Nullable
<A extends SocketAddress> A remoteAddress()
```
    Returns the remote address of this request, or null if the connection is not established yet.
  - localAddress
```
@Nullable
<A extends SocketAddress> A localAddress()
```
    Returns the local address of this request, or null if the connection is not established yet.
  - sslSession
```
@Nullable
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
```
@Nullable
String query()
```
    Returns the query part of the current Request URI, without the leading '?', as defined in RFC3986.
  - log
```
RequestLog log()
```
    Returns the RequestLog that contains the information about 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.
  - attrs
```
Iterator<io.netty.util.Attribute<?>> attrs()
```
    Returns all Attributes set in this context.
  - 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.
  - push
```
@Deprecated
static SafeCloseable push(RequestContext ctx,
                                      boolean runCallbacks)
```
    Deprecated. Use push(boolean).
    
    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.
  - push
```
default 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()) {
     ...
 }
 
```
    The callbacks added by onEnter(Consumer) and onExit(Consumer) will be invoked when the context is pushed to and removed from the thread-local stack respectively.
    NOTE: In case of re-entrance, the callbacks will never run.
  - push
```
default SafeCloseable push(boolean runCallbacks)
```
    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 (PushHandle ignored = ctx.push(true)) {
     ...
 }
 
```
    NOTE: This method is only useful when it is undesirable to invoke the callbacks, such as replacing the current context with another. Prefer push() otherwise.
    Parameters:
    
    runCallbacks - if true, the callbacks added by onEnter(Consumer) and onExit(Consumer) will be invoked when the context is pushed to and removed from the thread-local stack respectively. If false, no callbacks will be executed. NOTE: In case of re-entrance, the callbacks will never run.
  - pushIfAbsent
```
default SafeCloseable pushIfAbsent()
```
    Pushes this context to the thread-local stack if there is no current context. If there is and it is not same with this context (i.e. not reentrance), this method will throw an IllegalStateException. To pop the context from the stack, call SafeCloseable.close(), which can be done using a try-with-resources block.
  - 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
```
<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
```
Runnable makeContextAware(Runnable runnable)
```
    Returns a Runnable that makes sure the current RequestContext is set and then invokes the input runnable.
  - makeContextAware
```
<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
```
<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
```
<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
```
<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
<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
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
<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
```
<T> CompletionStage<T> makeContextAware(CompletionStage<T> stage)
```
    Returns a CompletionStage that makes sure the current CompletionStage 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 CompletableFuture is set and then invokes the input future.
  - isTimedOut
```
@Deprecated
boolean isTimedOut()
```
    Deprecated. Use ServiceRequestContext.isTimedOut().
    
    Returns whether this RequestContext has been timed-out (e.g., when the corresponding request passes a deadline).
  - onEnter
```
void onEnter(Consumer<? super RequestContext> callback)
```
    Registers callback to be run when re-entering this RequestContext, usually when using the makeContextAware(java.util.concurrent.Executor) family of methods. Any thread-local state associated with this context should be restored by this callback.
    
    Parameters:
    
    callback - a Consumer whose argument is this context
  - onEnter
```
@Deprecated
default void onEnter(Runnable callback)
```
    Deprecated. Use onEnter(Consumer) instead.
    
    Registers callback to be run when re-entering this RequestContext, usually when using the makeContextAware(java.util.concurrent.Executor) family of methods. Any thread-local state associated with this context should be restored by this callback.
  - onExit
```
void onExit(Consumer<? super RequestContext> callback)
```
    Registers callback to be run when re-exiting this RequestContext, usually when using the makeContextAware(java.util.concurrent.Executor) family of methods. Any thread-local state associated with this context should be reset by this callback.
    
    Parameters:
    
    callback - a Consumer whose argument is this context
  - onExit
```
@Deprecated
default void onExit(Runnable callback)
```
    Deprecated. Use onExit(Consumer) instead.
    
    Registers callback to be run when re-exiting this RequestContext, usually when using the makeContextAware(java.util.concurrent.Executor) family of methods. Any thread-local state associated with this context should be reset by this callback.
  - onChild
```
void onChild(BiConsumer<? super RequestContext,? super RequestContext> callback)
```
    Registers callback to be run when this context is replaced by a child context. You could use this method to inherit an attribute of this context to the child contexts or register a callback to the child contexts that may be created later:
```
 ctx.onChild((curCtx, newCtx) -> {
     assert ctx == curCtx && curCtx != newCtx;
     // Inherit the value of the 'MY_ATTR' attribute to the child context.
     newCtx.attr(MY_ATTR).set(curCtx.attr(MY_ATTR).get());
     // Add a callback to the child context.
     newCtx.onExit(() -> { ... });
 });
 
```
    Parameters:
    
    callback - a BiConsumer whose first argument is this context and whose second argument is the new context that replaces this context
  - invokeOnEnterCallbacks
```
void invokeOnEnterCallbacks()
```
    Invokes all onEnter(Consumer) callbacks. It is discouraged to use this method directly. Use makeContextAware(Runnable) or push(boolean) instead so that the callbacks are invoked automatically.
  - invokeOnExitCallbacks
```
void invokeOnExitCallbacks()
```
    Invokes all onExit(Consumer) callbacks. It is discouraged to use this method directly. Use makeContextAware(Runnable) or push(boolean) instead so that the callbacks are invoked automatically.
  - invokeOnChildCallbacks
```
void invokeOnChildCallbacks(RequestContext newCtx)
```
    Invokes all onChild(BiConsumer) callbacks. It is discouraged to use this method directly. Use makeContextAware(Runnable) or push(boolean) instead so that the callbacks are invoked automatically.
  - 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,
                                 @Nullable
                                 HttpRequest req,
                                 @Nullable
                                 RpcRequest rpcReq)
```
    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.

Interface RequestContext

Method Summary

Methods inherited from interface io.netty.util.AttributeMap

Method Detail

current

currentOrNull

mapCurrent

request

rpcRequest

updateRequest

updateRpcRequest

sessionProtocol

remoteAddress

localAddress

sslSession

id

method

path

decodedPath

query

log

logBuilder

meterRegistry

attrs

executor

eventLoop

alloc

contextAwareExecutor

contextAwareEventLoop

push

push

push

push

pushIfAbsent

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

isTimedOut

onEnter

onEnter

onExit

onExit

onChild

invokeOnEnterCallbacks

invokeOnExitCallbacks

invokeOnChildCallbacks

resolvePromise

rejectPromise

newDerivedContext