Package com.linecorp.armeria.common

Class NonWrappingRequestContext

java.lang.Object

com.linecorp.armeria.common.NonWrappingRequestContext

All Implemented Interfaces:

RequestContext

Direct Known Subclasses:

DefaultClientRequestContext, DefaultServiceRequestContext

@UnstableApi
public abstract class NonWrappingRequestContext
extends Object
implements RequestContext

A skeletal RequestContext implementation that helps to implement a non-wrapping RequestContext.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NonWrappingRequestContext(MeterRegistry meterRegistry, SessionProtocol sessionProtocol, RequestId id, HttpMethod method, String path, @Nullable String query, @Nullable HttpRequest req, @Nullable RpcRequest rpcReq, @Nullable RequestContext rootAttributeMap)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
<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.
protected abstract @Nullable Channel	channel()	Returns the Channel that is handling this request, or null if the connection is not established yet.
String	decodedPath()	Returns the absolute path part of the current Request URI, excluding the query part, decoded in UTF-8.
@Nullable Supplier<SafeCloseable>	hook()	Returns the hook which is invoked whenever this NonWrappingRequestContext is pushed to the RequestContextStorage.
void	hook(Supplier<? extends SafeCloseable> contextHook)	Adds a hook which is invoked whenever this NonWrappingRequestContext is pushed to the RequestContextStorage.
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.
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.
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.
protected void	unsafeUpdateRequest(HttpRequest req)	Replaces the HttpRequest associated with this context with the specified one without any validation.
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.
protected void	validateHeaders(RequestHeaders headers)	Validates the specified RequestHeaders.

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

alloc, cancel, cancel, cancellationCause, eventLoop, hasAttr, hasOwnAttr, isCancelled, isTimedOut, log, logBuilder, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, push, replace, root, run, run, sslSession, timeoutNow

Constructor Details

NonWrappingRequestContext

protected NonWrappingRequestContext(MeterRegistry meterRegistry,
 SessionProtocol sessionProtocol,
 RequestId id,
 HttpMethod method,
 String path,
 @Nullable
 @Nullable String query,
 @Nullable
 @Nullable HttpRequest req,
 @Nullable
 @Nullable RpcRequest rpcReq,
 @Nullable
 @Nullable RequestContext rootAttributeMap)

Creates a new instance.

Parameters:

sessionProtocol - the SessionProtocol of the invocation

id - the RequestId associated with this context

req - the HttpRequest associated with this context

rpcReq - the RpcRequest associated with this context

Method Details

request

public final 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 final 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 final 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 final 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

validateHeaders

protected void validateHeaders(RequestHeaders headers)

Validates the specified RequestHeaders. By default, this method will raise an IllegalArgumentException if it does not have ":scheme" or ":authority" header.

unsafeUpdateRequest

protected final void unsafeUpdateRequest(HttpRequest req)

Replaces the HttpRequest associated with this context with the specified one without any validation. Internal use only. Use it at your own risk.

sessionProtocol

public final SessionProtocol sessionProtocol()

Description copied from interface: RequestContext

Returns the SessionProtocol of the current Request.

Specified by:

sessionProtocol in interface RequestContext

channel

@Nullable
protected abstract @Nullable Channel channel()

Returns the Channel that is handling this request, or null if the connection is not established yet.

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

id

public final 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 final HttpMethod method()

Description copied from interface: RequestContext

Returns the HTTP method of the current Request.

Specified by:

method in interface RequestContext

path

public final 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 final 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 final 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

meterRegistry

public final MeterRegistry meterRegistry()

Description copied from interface: RequestContext

Returns the MeterRegistry that collects various stats.

Specified by:

meterRegistry in interface RequestContext

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 final <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)

setAttr

public final <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.

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 final 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()

hook

@UnstableApi
public void hook(Supplier<? extends SafeCloseable> contextHook)

Adds a hook which is invoked whenever this NonWrappingRequestContext is pushed to the RequestContextStorage. The SafeCloseable returned by contextHook will be called whenever this RequestContext is popped from the RequestContextStorage. This method is useful when you need to propagate a custom context in this RequestContext's scope.

Note that this operation is highly performance-sensitive operation, and thus it's not a good idea to run a time-consuming task.

hook

@UnstableApi
@Nullable
public @Nullable Supplier<SafeCloseable> hook()

Returns the hook which is invoked whenever this NonWrappingRequestContext is pushed to the RequestContextStorage. The SafeCloseable returned by the Supplier will be called whenever this RequestContext is popped from the RequestContextStorage.