AbstractRequestContext (filter-service-metrics 1.12 1.12 API)

java.lang.Object
- com.linecorp.armeria.common.AbstractRequestContext

All Implemented Interfaces:

RequestContext, io.netty.util.AttributeMap

Direct Known Subclasses:

NonWrappingRequestContext, RequestContextWrapper
```
public abstract class AbstractRequestContext
extends Object
implements RequestContext
```
A skeletal RequestContext implementation.

Constructor Summary

Constructors
Constructor and Description

AbstractRequestContext()

Constructors
Constructor and Description
`AbstractRequestContext()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`io.netty.channel.EventLoop`	`contextAwareEventLoop()` Returns an `EventLoop` that will make sure this `RequestContext` is set as the current context before executing any callback.
`Executor`	`contextAwareExecutor()` Returns an `Executor` that will make sure this `RequestContext` is set as the current context before executing any callback.
`boolean`	`equals(Object obj)`
`Executor`	`executor()` Returns the `Executor` that is handling the current `Request`.
`int`	`hashCode()`
`boolean`	`isTimedOut()` Returns whether this `RequestContext` has been timed-out (e.g., when the corresponding request passes a deadline).
`<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)` Returns a `ChannelFutureListener` that makes sure the current `RequestContext` is set and then invokes the input `listener`.
`<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`.
`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.
`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)` Returns a `FutureListener` that makes sure the current `RequestContext` is set and then invokes the input `listener`.
`<T extends io.netty.util.concurrent.Future<?>> io.netty.util.concurrent.GenericFutureListener<T>`	`makeContextAware(io.netty.util.concurrent.GenericFutureListener<T> listener)` Returns a `GenericFutureListener` that makes sure the current `RequestContext` is set and then invokes the input `listener`.
`Runnable`	`makeContextAware(Runnable runnable)` Returns a `Runnable` that makes sure the current `RequestContext` is set and then invokes the input `runnable`.
`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.
`void`	`onEnter(Runnable callback)` Registers `callback` to be run when re-entering this `RequestContext`, usually when using the `RequestContext.makeContextAware(java.util.concurrent.Executor)` family of methods.
`void`	`onExit(Runnable callback)` Registers `callback` to be run when re-exiting this `RequestContext`, usually when using the `RequestContext.makeContextAware(java.util.concurrent.Executor)` family of methods.
`SafeCloseable`	`push()` Pushes the specified context to the thread-local stack.
`SafeCloseable`	`push(boolean runCallbacks)` Pushes the specified context to the thread-local stack.
`SafeCloseable`	`pushIfAbsent()` Pushes this context to the thread-local stack if there is no current context.
`void`	`rejectPromise(io.netty.util.concurrent.Promise<?> promise, Throwable cause)` Rejects the specified `promise` with the specified `cause`.
`void`	`resolvePromise(io.netty.util.concurrent.Promise<?> promise, Object result)` Resolves the specified `promise` with the specified `result` so that the `promise` is marked as 'done'.
`void`	`setTimedOut()` Deprecated. Use `DefaultServiceRequestContext.setTimedOut()`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.linecorp.armeria.common.RequestContext
alloc, attrs, current, currentOrNull, decodedPath, eventLoop, id, invokeOnChildCallbacks, invokeOnEnterCallbacks, invokeOnExitCallbacks, localAddress, log, logBuilder, mapCurrent, meterRegistry, method, newDerivedContext, onChild, onEnter, onExit, path, push, push, query, remoteAddress, request, rpcRequest, sessionProtocol, sslSession, updateRequest, updateRpcRequest

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

- Constructor Detail
  - AbstractRequestContext
```
public AbstractRequestContext()
```
- Method Detail
  - executor
```
public final Executor executor()
```
    Description copied from interface: RequestContext
    
    Returns the Executor that is handling the current Request.
    
    Specified by:
    
    executor in interface RequestContext
  - contextAwareExecutor
```
public final Executor contextAwareExecutor()
```
    Description copied from interface: RequestContext
    
    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.
    
    Specified by:
    
    contextAwareExecutor in interface RequestContext
  - contextAwareEventLoop
```
public final io.netty.channel.EventLoop contextAwareEventLoop()
```
    Description copied from interface: RequestContext
    
    Returns an EventLoop that will make sure this RequestContext is set as the current context before executing any callback.
    
    Specified by:
    
    contextAwareEventLoop in interface RequestContext
  - push
```
public final SafeCloseable push()
```
    Description copied from interface: RequestContext
    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 RequestContext.onEnter(Consumer) and RequestContext.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.
    Specified by:
    
    push in interface RequestContext
  - push
```
public final SafeCloseable push(boolean runCallbacks)
```
    Description copied from interface: RequestContext
    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 RequestContext.push() otherwise.
    Specified by:
    
    push in interface RequestContext
    
    Parameters:
    
    runCallbacks - if true, the callbacks added by RequestContext.onEnter(Consumer) and RequestContext.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
```
public final SafeCloseable pushIfAbsent()
```
    Description copied from interface: RequestContext
    
    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.
    
    Specified by:
    
    pushIfAbsent in interface RequestContext
  - makeContextAware
```
public final Executor makeContextAware(Executor executor)
```
    Description copied from interface: RequestContext
    
    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 RequestContext.contextAwareEventLoop() to ensure the callback stays on the same thread as well.
    
    Specified by:
    
    makeContextAware in interface RequestContext
  - makeContextAware
```
public final ExecutorService makeContextAware(ExecutorService executor)
```
    Description copied from interface: RequestContext
    
    Returns an ExecutorService that will execute callbacks in the given executor, making sure to propagate the current RequestContext into the callback execution.
    
    Specified by:
    
    makeContextAware in interface RequestContext
  - makeContextAware
```
public final ScheduledExecutorService makeContextAware(ScheduledExecutorService executor)
```
    Description copied from interface: RequestContext
    
    Returns a ScheduledExecutorService that will execute callbacks in the given executor, making sure to propagate the current RequestContext into the callback execution.
    
    Specified by:
    
    makeContextAware in interface RequestContext
  - makeContextAware
```
public final <T> Callable<T> makeContextAware(Callable<T> callable)
```
    Description copied from interface: RequestContext
    
    Returns a Callable that makes sure the current RequestContext is set and then invokes the input callable.
    
    Specified by:
    
    makeContextAware in interface RequestContext
  - makeContextAware
```
public final Runnable makeContextAware(Runnable runnable)
```
    Description copied from interface: RequestContext
    
    Returns a Runnable that makes sure the current RequestContext is set and then invokes the input runnable.
    
    Specified by:
    
    makeContextAware in interface RequestContext
  - makeContextAware
```
public final <T,R> Function<T,R> makeContextAware(Function<T,R> function)
```
    Description copied from interface: RequestContext
    
    Returns a Function that makes sure the current RequestContext is set and then invokes the input function.
    
    Specified by:
    
    makeContextAware in interface RequestContext
  - makeContextAware
```
public final <T,U,V> BiFunction<T,U,V> makeContextAware(BiFunction<T,U,V> function)
```
    Description copied from interface: RequestContext
    
    Returns a BiFunction that makes sure the current RequestContext is set and then invokes the input function.
    
    Specified by:
    
    makeContextAware in interface RequestContext
  - makeContextAware
```
public final <T> Consumer<T> makeContextAware(Consumer<T> action)
```
    Description copied from interface: RequestContext
    
    Returns a Consumer that makes sure the current RequestContext is set and then invokes the input action.
    
    Specified by:
    
    makeContextAware in interface RequestContext
  - makeContextAware
```
public final <T,U> BiConsumer<T,U> makeContextAware(BiConsumer<T,U> action)
```
    Description copied from interface: RequestContext
    
    Returns a BiConsumer that makes sure the current RequestContext is set and then invokes the input action.
    
    Specified by:
    
    makeContextAware in interface RequestContext
  - makeContextAware
```
public final <T> io.netty.util.concurrent.FutureListener<T> makeContextAware(io.netty.util.concurrent.FutureListener<T> listener)
```
    Description copied from interface: RequestContext
    
    Returns a FutureListener that makes sure the current RequestContext is set and then invokes the input listener.
    
    Specified by:
    
    makeContextAware in interface RequestContext
  - makeContextAware
```
public final io.netty.channel.ChannelFutureListener makeContextAware(io.netty.channel.ChannelFutureListener listener)
```
    Description copied from interface: RequestContext
    
    Returns a ChannelFutureListener that makes sure the current RequestContext is set and then invokes the input listener.
    
    Specified by:
    
    makeContextAware in interface RequestContext
  - makeContextAware
```
public final <T extends io.netty.util.concurrent.Future<?>> io.netty.util.concurrent.GenericFutureListener<T> makeContextAware(io.netty.util.concurrent.GenericFutureListener<T> listener)
```
    Description copied from interface: RequestContext
    
    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.
    
    Specified by:
    
    makeContextAware in interface RequestContext
  - makeContextAware
```
public final <T> CompletionStage<T> makeContextAware(CompletionStage<T> stage)
```
    Description copied from interface: RequestContext
    
    Returns a CompletionStage that makes sure the current CompletionStage is set and then invokes the input stage.
    
    Specified by:
    
    makeContextAware in interface RequestContext
  - makeContextAware
```
public final <T> CompletableFuture<T> makeContextAware(CompletableFuture<T> future)
```
    Description copied from interface: RequestContext
    
    Returns a CompletableFuture that makes sure the current CompletableFuture is set and then invokes the input future.
    
    Specified by:
    
    makeContextAware in interface RequestContext
  - isTimedOut
```
public boolean isTimedOut()
```
    Description copied from interface: RequestContext
    
    Returns whether this RequestContext has been timed-out (e.g., when the corresponding request passes a deadline).
    
    Specified by:
    
    isTimedOut in interface RequestContext
  - setTimedOut
```
@Deprecated
public void setTimedOut()
```
    Deprecated. Use DefaultServiceRequestContext.setTimedOut().
    
    Marks this RequestContext as having been timed out. Any callbacks created with makeContextAware that are run after this will be failed with CancellationException.
  - onEnter
```
public final void onEnter(Runnable callback)
```
    Description copied from interface: RequestContext
    
    Registers callback to be run when re-entering this RequestContext, usually when using the RequestContext.makeContextAware(java.util.concurrent.Executor) family of methods. Any thread-local state associated with this context should be restored by this callback.
    
    Specified by:
    
    onEnter in interface RequestContext
  - onExit
```
public final void onExit(Runnable callback)
```
    Description copied from interface: RequestContext
    
    Registers callback to be run when re-exiting this RequestContext, usually when using the RequestContext.makeContextAware(java.util.concurrent.Executor) family of methods. Any thread-local state associated with this context should be reset by this callback.
    
    Specified by:
    
    onExit in interface RequestContext
  - resolvePromise
```
public final void resolvePromise(io.netty.util.concurrent.Promise<?> promise,
                                 Object result)
```
    Description copied from interface: RequestContext
    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:
      
      RequestContext.resolvePromise(Promise, Object)
      
      RequestContext.rejectPromise(Promise, Throwable)
      
      Promise.setSuccess(Object)
      
      Promise.setFailure(Throwable)
      
      Future.cancel(boolean)
    Specified by:
    
    resolvePromise in interface RequestContext
  - rejectPromise
```
public final void rejectPromise(io.netty.util.concurrent.Promise<?> promise,
                                Throwable cause)
```
    Description copied from interface: RequestContext
    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:
      
      RequestContext.resolvePromise(Promise, Object)
      
      RequestContext.rejectPromise(Promise, Throwable)
      
      Promise.setSuccess(Object)
      
      Promise.setFailure(Throwable)
      
      Future.cancel(boolean)
    Specified by:
    
    rejectPromise in interface RequestContext
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(@Nullable
                            Object obj)
```
    Overrides:
    
    equals in class Object

Class AbstractRequestContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.util.AttributeMap

Constructor Detail

AbstractRequestContext

Method Detail

executor

contextAwareExecutor

contextAwareEventLoop

push

push

pushIfAbsent

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

makeContextAware

isTimedOut

setTimedOut

onEnter

onExit

resolvePromise

rejectPromise

hashCode

equals