com.linecorp.armeria.common

Class NonWrappingRequestContext

java.lang.Object

com.linecorp.armeria.common.AbstractRequestContext

com.linecorp.armeria.common.NonWrappingRequestContext

All Implemented Interfaces:

RequestContext, io.netty.util.AttributeMap

Direct Known Subclasses:

DefaultClientRequestContext, DefaultServiceRequestContext

public abstract class NonWrappingRequestContext
extends AbstractRequestContext

Default RequestContext implementation.

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) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
<T> io.netty.util.Attribute<T>	attr(io.netty.util.AttributeKey<T> key)
Iterator<io.netty.util.Attribute<?>>	attrs() Returns all Attributes set in this context.
protected abstract io.netty.channel.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.
<T> boolean	hasAttr(io.netty.util.AttributeKey<T> 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.
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.
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 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

alloc, current, currentOrNull, eventLoop, log, logBuilder, mapCurrent, newDerivedContext, push, push, sslSession

Constructor Detail

NonWrappingRequestContext

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

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.

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.

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.

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.

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.

channel

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

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

id

public final RequestId id()

Description copied from interface: RequestContext

Returns the RequestId of the current Request and Response pair.

method

public final HttpMethod method()

Description copied from interface: RequestContext

Returns the HTTP method of the current Request.

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.

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.

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.

meterRegistry

public final MeterRegistry meterRegistry()

Description copied from interface: RequestContext

Returns the MeterRegistry that collects various stats.

attr

public <T> io.netty.util.Attribute<T> attr(io.netty.util.AttributeKey<T> key)

hasAttr

public <T> boolean hasAttr(io.netty.util.AttributeKey<T> key)

attrs

public Iterator<io.netty.util.Attribute<?>> attrs()

Description copied from interface: RequestContext

Returns all Attributes set in this context.

onEnter

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