RequestContextWrapper (filter-service-metrics 1.12 1.12 API)

java.lang.Object
- com.linecorp.armeria.common.AbstractRequestContext
- - com.linecorp.armeria.common.RequestContextWrapper<T>

Type Parameters:

T - the self type

All Implemented Interfaces:

RequestContext, io.netty.util.AttributeMap

Direct Known Subclasses:

ClientRequestContextWrapper, ServiceRequestContextWrapper
```
public abstract class RequestContextWrapper<T extends RequestContext>
extends AbstractRequestContext
```
Wraps an existing RequestContext.

Constructor Summary

Constructors
Modifier Constructor and Description

protected RequestContextWrapper(T delegate)
Creates a new instance.

Constructors
Modifier	Constructor and Description
`protected`	`RequestContextWrapper(T delegate)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`io.netty.buffer.ByteBufAllocator`	`alloc()` Returns the `ByteBufAllocator` for this `RequestContext`.
`<V> io.netty.util.Attribute<V>`	`attr(io.netty.util.AttributeKey<V> key)`
`Iterator<io.netty.util.Attribute<?>>`	`attrs()` Returns all `Attribute`s set in this context.
`String`	`decodedPath()` Returns the absolute path part of the current `Request` URI, excluding the query part, decoded in UTF-8.
`protected T`	`delegate()` Returns the delegate context.
`io.netty.channel.EventLoop`	`eventLoop()` Returns the `EventLoop` that is handling the current `Request`.
`<V> boolean`	`hasAttr(io.netty.util.AttributeKey<V> key)`
`RequestId`	`id()` Returns the `RequestId` of the current `Request` and `Response` pair.
`void`	`invokeOnChildCallbacks(RequestContext newCtx)` Invokes all `RequestContext.onChild(BiConsumer)` callbacks.
`void`	`invokeOnEnterCallbacks()` Invokes all `RequestContext.onEnter(Consumer)` callbacks.
`void`	`invokeOnExitCallbacks()` Invokes all `RequestContext.onExit(Consumer)` callbacks.
`<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`.
`MeterRegistry`	`meterRegistry()` Returns the `MeterRegistry` that collects various stats.
`HttpMethod`	`method()` Returns the HTTP method of the current `Request`.
`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 `RequestContext.makeContextAware(java.util.concurrent.Executor)` family of methods.
`void`	`onExit(Consumer<? super RequestContext> callback)` Registers `callback` to be run when re-exiting this `RequestContext`, usually when using the `RequestContext.makeContextAware(java.util.concurrent.Executor)` family of methods.
`String`	`path()` Returns the absolute path part of the current `Request` URI, excluding the query part, as defined in RFC3986.
`String`	`query()` Returns the query part of the current `Request` URI, without the leading `'?'`
`<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.
`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 class com.linecorp.armeria.common.AbstractRequestContext
contextAwareEventLoop, contextAwareExecutor, equals, executor, hashCode, isTimedOut, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, onEnter, onExit, push, push, pushIfAbsent, rejectPromise, resolvePromise, 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
current, currentOrNull, mapCurrent, newDerivedContext, push, push

- Constructor Detail
  - RequestContextWrapper
```
protected RequestContextWrapper(T delegate)
```
    Creates a new instance.
- Method Detail
  - delegate
```
protected final T delegate()
```
    Returns the delegate context.
  - request
```
public HttpRequest request()
```
    Description copied from interface: RequestContext
    
    Returns the HttpRequest associated with this context, or null if there's no HttpRequest associated with this context yet.
  - rpcRequest
```
@Nullable
public RpcRequest rpcRequest()
```
    Description copied from interface: RequestContext
    
    Returns the RpcRequest associated with this context, or null if there's no RpcRequest associated with this context.
  - updateRequest
```
public void updateRequest(HttpRequest req)
```
    Description copied from interface: RequestContext
    
    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 RequestContext.path(), are unaffected by such an attempt.
    
    See Also:
    
    HttpRequest.withHeaders(RequestHeaders), HttpRequest.withHeaders(RequestHeadersBuilder)
  - updateRpcRequest
```
public void updateRpcRequest(RpcRequest rpcReq)
```
    Description copied from interface: RequestContext
    
    Replaces the RpcRequest associated with this context with the specified one. This method is useful to a decorator that manipulates an RPC call.
  - sessionProtocol
```
public SessionProtocol sessionProtocol()
```
    Description copied from interface: RequestContext
    
    Returns the SessionProtocol of the current Request.
  - remoteAddress
```
@Nullable
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.
  - localAddress
```
@Nullable
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.
  - sslSession
```
@Nullable
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.
  - id
```
public RequestId id()
```
    Description copied from interface: RequestContext
    
    Returns the RequestId of the current Request and Response pair.
  - method
```
public HttpMethod method()
```
    Description copied from interface: RequestContext
    
    Returns the HTTP method of the current Request.
  - path
```
public String path()
```
    Description copied from interface: RequestContext
    
    Returns the absolute path part of the current Request URI, excluding the query part, as defined in RFC3986.
  - decodedPath
```
public String decodedPath()
```
    Description copied from interface: RequestContext
    
    Returns the absolute path part of the current Request URI, excluding the query part, decoded in UTF-8.
  - query
```
public String query()
```
    Description copied from interface: RequestContext
    
    Returns the query part of the current Request URI, without the leading '?', as defined in RFC3986.
  - log
```
public RequestLog log()
```
    Description copied from interface: RequestContext
    
    Returns the RequestLog that contains the information about the current Request.
  - logBuilder
```
public RequestLogBuilder logBuilder()
```
    Description copied from interface: RequestContext
    
    Returns the RequestLogBuilder that collects the information about the current Request.
  - meterRegistry
```
public MeterRegistry meterRegistry()
```
    Description copied from interface: RequestContext
    
    Returns the MeterRegistry that collects various stats.
  - attrs
```
public Iterator<io.netty.util.Attribute<?>> attrs()
```
    Description copied from interface: RequestContext
    
    Returns all Attributes set in this context.
  - eventLoop
```
public io.netty.channel.EventLoop eventLoop()
```
    Description copied from interface: RequestContext
    
    Returns the EventLoop that is handling the current Request.
  - onEnter
```
public void onEnter(Consumer<? super RequestContext> 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.
    
    Parameters:
    
    callback - a Consumer whose argument is this context
  - onExit
```
public void onExit(Consumer<? super RequestContext> 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.
    
    Parameters:
    
    callback - a Consumer whose argument is this context
  - onChild
```
public void onChild(BiConsumer<? super RequestContext,? super RequestContext> callback)
```
    Description copied from interface: RequestContext
    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
```
public void invokeOnEnterCallbacks()
```
    Description copied from interface: RequestContext
    
    Invokes all RequestContext.onEnter(Consumer) callbacks. It is discouraged to use this method directly. Use RequestContext.makeContextAware(Runnable) or RequestContext.push(boolean) instead so that the callbacks are invoked automatically.
  - invokeOnExitCallbacks
```
public void invokeOnExitCallbacks()
```
    Description copied from interface: RequestContext
    
    Invokes all RequestContext.onExit(Consumer) callbacks. It is discouraged to use this method directly. Use RequestContext.makeContextAware(Runnable) or RequestContext.push(boolean) instead so that the callbacks are invoked automatically.
  - invokeOnChildCallbacks
```
public void invokeOnChildCallbacks(RequestContext newCtx)
```
    Description copied from interface: RequestContext
    
    Invokes all RequestContext.onChild(BiConsumer) callbacks. It is discouraged to use this method directly. Use RequestContext.makeContextAware(Runnable) or RequestContext.push(boolean) instead so that the callbacks are invoked automatically.
  - attr
```
public <V> io.netty.util.Attribute<V> attr(io.netty.util.AttributeKey<V> key)
```
  - hasAttr
```
public <V> boolean hasAttr(io.netty.util.AttributeKey<V> key)
```
  - 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.

Class RequestContextWrapper<T extends RequestContext>

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestContextWrapper

Method Detail

delegate

request

rpcRequest

updateRequest

updateRpcRequest

sessionProtocol

remoteAddress

localAddress

sslSession

id

method

path

decodedPath

query

log

logBuilder

meterRegistry

attrs

eventLoop

onEnter

onExit

onChild

invokeOnEnterCallbacks

invokeOnExitCallbacks

invokeOnChildCallbacks

attr

hasAttr

alloc