Package com.linecorp.armeria.common

Class RequestContextStorageWrapper

java.lang.Object

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

com.linecorp.armeria.common.RequestContextStorageWrapper

All Implemented Interfaces:

RequestContextStorage, Unwrappable

public class RequestContextStorageWrapper
extends AbstractUnwrappable<RequestContextStorage>
implements RequestContextStorage

Wraps an existing RequestContextStorage.

See Also:

RequestContextStorage.hook(Function)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RequestContextStorageWrapper(RequestContextStorage delegate)	Creates a new instance that wraps the specified RequestContextStorage.

Method Summary

Modifier and Type	Method	Description
<T extends RequestContext> T	currentOrNull()	Returns the RequestContext in the storage.
void	pop(RequestContext current, @Nullable RequestContext toRestore)	Pops the current RequestContext in the storage and pushes back the specified toRestore.
<T extends RequestContext> T	push(RequestContext toPush)	Pushes the specified RequestContext into the storage.

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

as, toString, 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.RequestContextStorage

unwrap

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

as

Constructor Details

RequestContextStorageWrapper

protected RequestContextStorageWrapper(RequestContextStorage delegate)

Creates a new instance that wraps the specified RequestContextStorage.

Method Details

push

@Nullable
public <T extends RequestContext> T push(RequestContext toPush)

Description copied from interface: RequestContextStorage

Pushes the specified RequestContext into the storage.

Specified by:

push in interface RequestContextStorage

Returns:

the old RequestContext which was in the storage before the specified toPush is pushed. null, if there was no RequestContext.

pop

public void pop(RequestContext current,
 @Nullable
 @Nullable RequestContext toRestore)

Description copied from interface: RequestContextStorage

Pops the current RequestContext in the storage and pushes back the specified toRestore. toRestore is the RequestContext returned from when push(current) is called, so it can be null.

The specified current must be the RequestContext in the storage. If it's not, it means that RequestContext.push() is not called using try-with-resources block, so the previous RequestContext is not popped properly.

Specified by:

pop in interface RequestContextStorage

currentOrNull

@Nullable
public <T extends RequestContext> T currentOrNull()

Description copied from interface: RequestContextStorage

Returns the RequestContext in the storage. null if there is no RequestContext.

Specified by:

currentOrNull in interface RequestContextStorage