RequestContextWrapper (filter-service-metrics 1.13 1.13 API)

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

Type Parameters:

T - the self type

All Implemented Interfaces:

RequestContext

Direct Known Subclasses:

ClientRequestContextWrapper, ServiceRequestContextWrapper
```
public abstract class RequestContextWrapper<T extends RequestContext>
extends Object
implements RequestContext
```
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> 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 `RequestContext.setAttr(AttributeKey, Object)` or `RequestContext.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.
`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`.
`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`.
`MeterRegistry`	`meterRegistry()` Returns the `MeterRegistry` that collects various stats.
`HttpMethod`	`method()` Returns the HTTP method of the current `Request`.
`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`.
`<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.

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

Methods inherited from interface com.linecorp.armeria.common.RequestContext
contextAwareEventLoop, contextAwareExecutor, current, currentOrNull, executor, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, mapCurrent, newDerivedContext, push, push, push, push, pushIfAbsent, rejectPromise, replace, resolvePromise

- 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.
    
    Specified by:
    
    request in interface RequestContext
  - rpcRequest
```
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.
    
    Specified by:
    
    rpcRequest in interface RequestContext
  - 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.
    
    Specified by:
    
    updateRequest in interface RequestContext
    
    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.
    
    Specified by:
    
    updateRpcRequest in interface RequestContext
  - sessionProtocol
```
public SessionProtocol sessionProtocol()
```
    Description copied from interface: RequestContext
    
    Returns the SessionProtocol of the current Request.
    
    Specified by:
    
    sessionProtocol in interface RequestContext
  - 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
  - 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
  - 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
  - id
```
public RequestId id()
```
    Description copied from interface: RequestContext
    
    Returns the RequestId of the current Request and Response pair.
    
    Specified by:
    
    id in interface RequestContext
  - method
```
public HttpMethod method()
```
    Description copied from interface: RequestContext
    
    Returns the HTTP method of the current Request.
    
    Specified by:
    
    method in interface RequestContext
  - 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.
    
    Specified by:
    
    path in interface RequestContext
  - 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.
    
    Specified by:
    
    decodedPath in interface RequestContext
  - 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.
    
    Specified by:
    
    query in interface RequestContext
  - 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
  - meterRegistry
```
public MeterRegistry meterRegistry()
```
    Description copied from interface: RequestContext
    
    Returns the MeterRegistry that collects various stats.
    
    Specified by:
    
    meterRegistry in interface RequestContext
  - 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
  - attr
```
public <V> V attr(io.netty.util.AttributeKey<V> key)
```
    Description copied from interface: RequestContext
    
    Returns the value mapped to the given AttributeKey or null if there's no value set by RequestContext.setAttr(AttributeKey, Object) or RequestContext.setAttrIfAbsent(AttributeKey, Object).
    
    Specified by:
    
    attr in interface RequestContext
  - setAttr
```
public <V> void setAttr(io.netty.util.AttributeKey<V> key,
                        V value)
```
    Description copied from interface: RequestContext
    
    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 RequestContext.attrs().
    
    Specified by:
    
    setAttr in interface RequestContext
  - setAttrIfAbsent
```
public <V> V setAttrIfAbsent(io.netty.util.AttributeKey<V> key,
                             V value)
```
    Description copied from interface: RequestContext
    
    Associates the specified value with the given AttributeKey in this context only if this context does not contain a mapping for the AttributeKey.
    
    Specified by:
    
    setAttrIfAbsent in interface RequestContext
    
    Returns:
    
    null if there was no mapping for the AttributeKey or the old value if there's a mapping for the AttributeKey.
  - computeAttrIfAbsent
```
public <V> V computeAttrIfAbsent(io.netty.util.AttributeKey<V> key,
                                 Function<? super io.netty.util.AttributeKey<V>,? extends V> mappingFunction)
```
    Description copied from interface: RequestContext
    
    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.
    
    Specified by:
    
    computeAttrIfAbsent in interface RequestContext
    
    Returns:
    
    the current (existing or computed) value associated with the specified AttributeKey, or null if the computed value is null
  - attrs
```
public Iterator<Map.Entry<io.netty.util.AttributeKey<?>,Object>> attrs()
```
    Description copied from interface: RequestContext
    
    Returns the Iterator of all Map.Entrys this context contains.
    
    Specified by:
    
    attrs 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

Class RequestContextWrapper<T extends RequestContext>

Constructor Summary

Method Summary

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

eventLoop

attr

setAttr

setAttrIfAbsent

computeAttrIfAbsent

attrs

alloc