com.linecorp.armeria.internal.common

Class RequestContextUtil

java.lang.Object

com.linecorp.armeria.internal.common.RequestContextUtil

public final class RequestContextUtil
extends Object

Utilities for RequestContext.

Method Summary

Modifier and Type	Method and Description
static IllegalStateException	newIllegalContextPushingException(RequestContext newCtx, RequestContext oldCtx) Returns an IllegalStateException which is raised when pushing a context from the unexpected thread or forgetting to close the previous context.
static SafeCloseable	noopSafeCloseable() Returns the SafeCloseable which doesn't do anything.
static SafeCloseable	pop() Removes the RequestContext in the thread-local if exists and returns SafeCloseable which pushes the RequestContext back to the thread-local.

Methods inherited from class java.lang.Object

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

Method Detail

noopSafeCloseable

public static SafeCloseable noopSafeCloseable()

Returns the SafeCloseable which doesn't do anything.

newIllegalContextPushingException

public static IllegalStateException newIllegalContextPushingException(RequestContext newCtx,
                                                                      RequestContext oldCtx)

Returns an IllegalStateException which is raised when pushing a context from the unexpected thread or forgetting to close the previous context.

pop

public static SafeCloseable pop()

Removes the RequestContext in the thread-local if exists and returns SafeCloseable which pushes the RequestContext back to the thread-local.

Because this method pops the RequestContext arbitrarily, it shouldn't be used in most cases. One of the examples this can be used is in ChannelFutureListener. The ChannelFuture can be complete when the eventloop handles the different request. The eventloop might have the wrong RequestContext in the thread-local, so we should pop it.