Package com.linecorp.armeria.common

Class RequestContextWrapper<T extends RequestContext>

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<T>

com.linecorp.armeria.common.RequestContextWrapper<T>

Type Parameters:

T - the self type

All Implemented Interfaces:

RequestContext, Unwrappable

Direct Known Subclasses:

ClientRequestContextWrapper, ServiceRequestContextWrapper

public abstract class RequestContextWrapper<T extends RequestContext>
extends AbstractUnwrappable<T>
implements RequestContext

Wraps an existing RequestContext.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ByteBufAllocator	alloc()	Returns the ByteBufAllocator for this RequestContext.
<V> V	attr(AttributeKey<V> key)	Returns the value associated with the given AttributeKey or null if there's no value set by RequestContext.setAttr(AttributeKey, Object).
Iterator<Map.Entry<AttributeKey<?>,Object>>	attrs()	Returns the Iterator of all Map.Entrys this context contains.
void	cancel()	Cancels the current Request.
void	cancel(Throwable cause)	Cancels the current Request with a Throwable.
@Nullable Throwable	cancellationCause()	Returns the cause of cancellation, null if the request has not been cancelled.
String	decodedPath()	Returns the absolute path part of the current Request URI, excluding the query part, decoded in UTF-8.
protected final T	delegate()	Deprecated. Use AbstractUnwrappable.unwrap() instead.
ContextAwareEventLoop	eventLoop()	Returns the ContextAwareEventLoop that is handling the current Request.
ExchangeType	exchangeType()	Returns the ExchangeType that determines whether to stream an HttpRequest or HttpResponse.
boolean	hasAttr(AttributeKey<?> key)	Returns true if and only if the value associated with the specified AttributeKey is not null.
boolean	hasOwnAttr(AttributeKey<?> key)	Returns true if and only if the value associated with the specified AttributeKey is not null.
RequestId	id()	Returns the RequestId of the current Request and Response pair.
CompletableFuture<Void>	initiateConnectionShutdown()	Initiates connection shutdown and returns CompletableFuture that completes when the connection associated with this context is closed.
<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.
<V> V	ownAttr(AttributeKey<V> key)	Returns the value associated with the given AttributeKey or null if there's no value set by RequestContext.setAttr(AttributeKey, Object).
Iterator<Map.Entry<AttributeKey<?>,Object>>	ownAttrs()	Returns the Iterator of all Map.Entrys this context contains.
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 '?', as defined in RFC3986.
<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.
@Nullable ServiceRequestContext	root()	Returns the root ServiceRequestContext of this context.
@Nullable 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> V	setAttr(AttributeKey<V> key, V value)	Associates the specified value with the given AttributeKey in this context.
@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.
void	timeoutNow()	Times out the current Request.
String	toString()
RequestContext	unwrapAll()	Unwraps this object and returns the innermost object being decorated.
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.
URI	uri()	Returns the URI associated with the current Request.

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, unwrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

isCancelled, isTimedOut, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, push, replace, run, run, unwrap

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

as, equalsIgnoreWrapper

Constructor Details

RequestContextWrapper

protected RequestContextWrapper(T delegate)

Creates a new instance.

Method Details

delegate

@Deprecated
protected final T delegate()

Deprecated.

Use AbstractUnwrappable.unwrap() instead.

Returns the delegate context.

root

@Nullable
public @Nullable ServiceRequestContext root()

Description copied from interface: RequestContext

Returns the root ServiceRequestContext of this context.

Specified by:

root in interface RequestContext

Returns:

the root ServiceRequestContext, or null if this context was not created in the context of a server request.

attr

@Nullable
public <V> V attr(AttributeKey<V> key)

Description copied from interface: RequestContext

Returns the value associated with the given AttributeKey or null if there's no value set by RequestContext.setAttr(AttributeKey, Object).

Searching for attributes in a root context

Note: This section applies only to a ClientRequestContext. A ServiceRequestContext always has itself as a RequestContext.root().

If the value does not exist in this context but only in RequestContext.root(), this method will return the value from the RequestContext.root().

 ClientRequestContext ctx = ...;
 assert ctx.root().attr(KEY).equals("root");
 assert ctx.attr(KEY).equals("root");
 assert ctx.ownAttr(KEY) == null;
 

If the value exists both in this context and RequestContext.root(), this method will return the value from this context.

 ClientRequestContext ctx = ...;
 assert ctx.root().attr(KEY).equals("root");
 assert ctx.ownAttr(KEY).equals("child");
 assert ctx.attr(KEY).equals("child");
 

Specified by:

attr in interface RequestContext

See Also:

• RequestContext.ownAttr(AttributeKey)

ownAttr

@Nullable
public <V> V ownAttr(AttributeKey<V> key)

Description copied from interface: RequestContext

Returns the value associated with the given AttributeKey or null if there's no value set by RequestContext.setAttr(AttributeKey, Object).

Unlike RequestContext.attr(AttributeKey), this does not search in RequestContext.root().

Specified by:

ownAttr in interface RequestContext

See Also:

• RequestContext.attr(AttributeKey)

hasAttr

public boolean hasAttr(AttributeKey<?> key)

Description copied from interface: RequestContext

Returns true if and only if the value associated with the specified AttributeKey is not null.

Specified by:

hasAttr in interface RequestContext

See Also:

• RequestContext.hasOwnAttr(AttributeKey)

hasOwnAttr

public boolean hasOwnAttr(AttributeKey<?> key)

Description copied from interface: RequestContext

Returns true if and only if the value associated with the specified AttributeKey is not null.

Unlike RequestContext.hasAttr(AttributeKey), this does not search in RequestContext.root().

Specified by:

hasOwnAttr in interface RequestContext

See Also:

• RequestContext.hasAttr(AttributeKey)

attrs

public Iterator<Map.Entry<AttributeKey<?>,Object>> attrs()

Description copied from interface: RequestContext

Returns the Iterator of all Map.Entrys this context contains.

Searching for attributes in a root context

Note: This section applies only to a ClientRequestContext. A ServiceRequestContext always has itself as a RequestContext.root().

The Iterator returned by this method will also yield the Map.Entrys from the RequestContext.root() except those whose AttributeKey exist already in this context, e.g.

 ClientRequestContext ctx = ...;
 assert ctx.ownAttr(KEY_A).equals("child_a");
 assert ctx.root().attr(KEY_A).equals("root_a");
 assert ctx.root().attr(KEY_B).equals("root_b");

 Iterator<Entry<AttributeKey<?>, Object>> attrs = ctx.attrs();
 assert attrs.next().getValue().equals("child_a"); // KEY_A
 // Skip KEY_A in the root.
 assert attrs.next().getValue().equals("root_b"); // KEY_B
 assert attrs.hasNext() == false;
 

Please note that any changes made to the Map.Entry returned by Iterator.next() never affects the Map.Entry owned by RequestContext.root(). For example:

 ClientRequestContext ctx = ...;
 assert ctx.root().attr(KEY).equals("root");
 assert ctx.ownAttr(KEY) == null;

 Iterator<Entry<AttributeKey<?>, Object>> attrs = ctx.attrs();
 Entry<AttributeKey<?>, Object> next = attrs.next();
 assert next.getKey() == KEY;
 // Overriding the root entry creates the client context's own entry.
 next.setValue("child");
 assert ctx.attr(KEY).equals("child");
 assert ctx.ownAttr(KEY).equals("child");
 // root attribute remains unaffected.
 assert ctx.root().attr(KEY).equals("root");
 

If you want to change the value from the root while iterating, please call RequestContext.attrs() from RequestContext.root().

 ClientRequestContext ctx = ...;
 assert ctx.root().attr(KEY).equals("root");
 assert ctx.ownAttr(KEY) == null;

 // Call attrs() from the root to set a value directly while iterating.
 Iterator<Entry<AttributeKey<?>, Object>> attrs = ctx.root().attrs();
 Entry<AttributeKey<?>, Object> next = attrs.next();
 assert next.getKey() == KEY;
 next.setValue("another_root");
 // The ctx does not have its own attribute.
 assert ctx.ownAttr(KEY) == null;
 assert ctx.attr(KEY).equals("another_root");
 

Specified by:

attrs in interface RequestContext

See Also:

• RequestContext.ownAttrs()

ownAttrs

public Iterator<Map.Entry<AttributeKey<?>,Object>> ownAttrs()

Description copied from interface: RequestContext

Returns the Iterator of all Map.Entrys this context contains.

Unlike RequestContext.attrs(), this does not iterate RequestContext.root().

Specified by:

ownAttrs in interface RequestContext

See Also:

• RequestContext.attrs()

setAttr

public <V> V setAttr(AttributeKey<V> key,
 @Nullable
 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

Returns:

the old value that has been replaced if there's a mapping for the specified key in this context or its RequestContext.root(), or null otherwise.

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

@Nullable
public @Nullable 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

@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.

Specified by:

remoteAddress in interface RequestContext

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.

Specified by:

localAddress in interface RequestContext

sslSession

@Nullable
public @Nullable 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

uri

public URI uri()

Description copied from interface: RequestContext

Returns the URI associated with the current Request.

Specified by:

uri in interface RequestContext

See Also:

• ServiceRequestContext.uri()
• ClientRequestContext.uri()

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

cancel

public void cancel(Throwable cause)

Description copied from interface: RequestContext

Cancels the current Request with a Throwable.

Specified by:

cancel in interface RequestContext

cancel

public void cancel()

Description copied from interface: RequestContext

Cancels the current Request.

Specified by:

cancel in interface RequestContext

timeoutNow

public void timeoutNow()

Description copied from interface: RequestContext

Times out the current Request.

Specified by:

timeoutNow in interface RequestContext

unwrapAll

public RequestContext unwrapAll()

Description copied from interface: Unwrappable

Unwraps this object and returns the innermost object being decorated. If this Unwrappable is the innermost object, this method returns itself. For example:

 class Foo implements Unwrappable {}

 class Bar<T extends Unwrappable> extends AbstractUnwrappable<T> {
     Bar(T delegate) {
         super(delegate);
     }
 }

 class Qux<T extends Unwrappable> extends AbstractUnwrappable<T> {
     Qux(T delegate) {
         super(delegate);
     }
 }

 Foo foo = new Foo();
 assert foo.unwrapAll() == foo;

 Bar<Foo> bar = new Bar<>(foo);
 assert bar.unwrapAll() == foo;

 Qux<Bar<Foo>> qux = new Qux<>(bar);
 assert qux.unwrap() == bar;
 assert qux.unwrapAll() == foo;
 

Specified by:

unwrapAll in interface RequestContext

Specified by:

unwrapAll in interface Unwrappable

Overrides:

unwrapAll in class AbstractUnwrappable<T extends RequestContext>

cancellationCause

@Nullable
public @Nullable Throwable cancellationCause()

Description copied from interface: RequestContext

Returns the cause of cancellation, null if the request has not been cancelled.

Specified by:

cancellationCause in interface RequestContext

eventLoop

public ContextAwareEventLoop eventLoop()

Description copied from interface: RequestContext

Returns the ContextAwareEventLoop that is handling the current Request. The ContextAwareEventLoop sets this RequestContext as the current context before executing any submitted tasks. If you want to use EventLoop without setting this context, call ContextAwareEventLoop.withoutContext() and use the returned EventLoop.

Specified by:

eventLoop in interface RequestContext

alloc

public 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

exchangeType

public ExchangeType exchangeType()

Description copied from interface: RequestContext

Returns the ExchangeType that determines whether to stream an HttpRequest or HttpResponse.

Specified by:

exchangeType in interface RequestContext

initiateConnectionShutdown

public CompletableFuture<Void> initiateConnectionShutdown()

Description copied from interface: RequestContext

Initiates connection shutdown and returns CompletableFuture that completes when the connection associated with this context is closed.

Specified by:

initiateConnectionShutdown in interface RequestContext

See Also:

• ClientRequestContext.initiateConnectionShutdown()
• ServiceRequestContext.initiateConnectionShutdown()

toString

public String toString()

Overrides:

toString in class AbstractUnwrappable<T extends RequestContext>