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 and Description
protected	NonWrappingRequestContext(MeterRegistry meterRegistry, SessionProtocol sessionProtocol, RequestId id, HttpMethod method, String path, String query, HttpRequest req, RpcRequest rpcReq, RequestContext rootAttributeMap) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
<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.Entrys this context contains.
protected abstract io.netty.channel.Channel	channel() Returns the Channel that is handling this request, or null if the connection is not established yet.
<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.
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(io.netty.util.AttributeKey<V> key) Returns the value mapped to the given AttributeKey or null if there's no value set by setAttr(AttributeKey, Object) or setAttrIfAbsent(AttributeKey, Object).
Iterator<Map.Entry<io.netty.util.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 '?'
<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.
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, contextAwareEventLoop, contextAwareExecutor, current, currentOrNull, eventLoop, executor, log, logBuilder, 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, sslSession

Constructor Detail

NonWrappingRequestContext

protected NonWrappingRequestContext(MeterRegistry meterRegistry,
                                    SessionProtocol sessionProtocol,
                                    RequestId id,
                                    HttpMethod method,
                                    String path,
                                    String query,
                                    HttpRequest req,
                                    RpcRequest rpcReq,
                                    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 Detail

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

protected abstract io.netty.channel.Channel channel()

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

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

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

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

ownAttr

public <V> V ownAttr(io.netty.util.AttributeKey<V> key)

Returns the value mapped to the given AttributeKey or null if there's no value set by setAttr(AttributeKey, Object) or setAttrIfAbsent(AttributeKey, Object). Unlike attr(AttributeKey), this does not search in rootAttributeMap.

See Also:

attr(AttributeKey)

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

ownAttrs

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

Returns the Iterator of all Map.Entrys this context contains. Unlike attrs(), this does not iterate rootAttributeMap.

See Also:

attrs()