Package io.micronaut.core.propagation

Interface PropagatedContext

public interface PropagatedContext

The propagation across different threads using the context which is immutable and can be extended/reduced by different elements. Each element can be a simple data structure carrying its state across the threads, or it can implement ThreadPropagatedContextElement for use-cases when thread-local values needs to be updated.

Since:

4.0.0

Author:

Denis Stepanov

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PropagatedContext.Scope	Context propagation AutoCloseable to be used in try-resource block.

Method Summary

Modifier and Type	Method	Description
static @NonNull PropagatedContext	empty()	Returns an empty context.
static boolean	exists()	Check if there is a context associated.
static @NonNull Optional<PropagatedContext>	find()	Returns an optional context.
<T extends PropagatedContextElement> Optional<T>	find(@NonNull Class<T> elementType)	Finds optional element of type.
<T extends PropagatedContextElement> Stream<T>	findAll(@NonNull Class<T> elementType)	Find all elements of type.
static @NonNull PropagatedContext	get()	Returns the current context or throws an exception otherwise.
<T extends PropagatedContextElement> T	get(@NonNull Class<T> elementType)	Gets element of type.
List<PropagatedContextElement>	getAllElements()	Gets all elements.
static @NonNull PropagatedContext	getOrEmpty()	Returns the current context or an empty one.
@NonNull PropagatedContext	minus(@NonNull PropagatedContextElement element)	Creates a new context without the provided element.
@NonNull PropagatedContext	plus(@NonNull PropagatedContextElement element)	Creates a new element with added element.
@NonNull PropagatedContext.Scope	propagate()	Propagate the context using try-resource block.
default <V> V	propagate(@NonNull Supplier<V> supplier)	Propagate the context for the supplier.
@NonNull PropagatedContext	replace(@NonNull PropagatedContextElement oldElement, @NonNull PropagatedContextElement newElement)	Creates a new context with replaced the provided element.
default @NonNull Runnable	wrap(@NonNull Runnable runnable)	Wrap runnable for this context to be propagated in.
default <V> @NonNull Callable<V>	wrap(@NonNull Callable<V> callable)	Wrap callable for this context to be propagated in.
default <V> @NonNull Supplier<V>	wrap(@NonNull Supplier<V> supplier)	Wrap supplier for this context to be propagated in.
static @NonNull Runnable	wrapCurrent(@NonNull Runnable runnable)	Wrap runnable for this context to be propagated in.
static <V> @NonNull Callable<V>	wrapCurrent(@NonNull Callable<V> callable)	Wrap callable for this context to be propagated in.
static <V> @NonNull Supplier<V>	wrapCurrent(@NonNull Supplier<V> supplier)	Wrap supplier for this context to be propagated in.

Method Details

empty

@NonNull
static @NonNull PropagatedContext empty()

Returns an empty context.

Returns:

the empty context

getOrEmpty

@NonNull
static @NonNull PropagatedContext getOrEmpty()

Returns the current context or an empty one.

Returns:

the current context or an empty one

get

@NonNull
static @NonNull PropagatedContext get()

Returns the current context or throws an exception otherwise.

Returns:

the current context

find

@NonNull
static @NonNull Optional<PropagatedContext> find()

Returns an optional context.

Returns:

the current optional context

wrapCurrent

@NonNull
static @NonNull Runnable wrapCurrent(@NonNull
 @NonNull Runnable runnable)

Wrap runnable for this context to be propagated in.

Parameters:

runnable - The runnable

Returns:

new runnable or existing if the context is missing

wrapCurrent

@NonNull
static <V> @NonNull Callable<V> wrapCurrent(@NonNull
 @NonNull Callable<V> callable)

Wrap callable for this context to be propagated in.

Type Parameters:

V - The callable type

Parameters:

callable - The callable

Returns:

new callable or existing if the context is missing

wrapCurrent

@NonNull
static <V> @NonNull Supplier<V> wrapCurrent(@NonNull
 @NonNull Supplier<V> supplier)

Wrap supplier for this context to be propagated in.

Type Parameters:

V - The supplier type

Parameters:

supplier - The supplier

Returns:

new supplier or existing if the context is missing

exists

static boolean exists()

Check if there is a context associated.

Returns:

true if the context exists

plus

@NonNull
@NonNull PropagatedContext plus(@NonNull
 @NonNull PropagatedContextElement element)

Creates a new element with added element.

NOTE: The new element needs to be propagated.

Parameters:

element - The element element to be added

Returns:

new element

minus

@NonNull
@NonNull PropagatedContext minus(@NonNull
 @NonNull PropagatedContextElement element)

Creates a new context without the provided element.

NOTE: The new context needs to be propagated.

Parameters:

element - The context element to be removed

Returns:

new context

replace

@NonNull
@NonNull PropagatedContext replace(@NonNull
 @NonNull PropagatedContextElement oldElement,
 @NonNull
 @NonNull PropagatedContextElement newElement)

Creates a new context with replaced the provided element.

NOTE: The new context needs to be propagated.

Parameters:

oldElement - The context element to be replaced

newElement - The context element to be replaced with

Returns:

new context

find

<T extends PropagatedContextElement> Optional<T> find(@NonNull
 @NonNull Class<T> elementType)

Finds optional element of type. In a case of multiple element of the same type the last one will be returned.

Type Parameters:

T - The element's type

Parameters:

elementType - The element type

Returns:

optional element

findAll

<T extends PropagatedContextElement> Stream<T> findAll(@NonNull
 @NonNull Class<T> elementType)

Find all elements of type. The first element processed by stream will be the last one added.

Type Parameters:

T - The element's type

Parameters:

elementType - The element type

Returns:

stream of elements of type

get

<T extends PropagatedContextElement> T get(@NonNull
 @NonNull Class<T> elementType)

Gets element of type.

Type Parameters:

T - The element's type

Parameters:

elementType - The element type

Returns:

an element or exception

getAllElements

List<PropagatedContextElement> getAllElements()

Gets all elements.

Returns:

all elements.

propagate

@NonNull
@NonNull PropagatedContext.Scope propagate()

Propagate the context using try-resource block.

Returns:

auto-closeable block to be used in try-resource block.

wrap

@NonNull
default @NonNull Runnable wrap(@NonNull
 @NonNull Runnable runnable)

Wrap runnable for this context to be propagated in.

Parameters:

runnable - The runnable

Returns:

new runnable

wrap

@NonNull
default <V> @NonNull Callable<V> wrap(@NonNull
 @NonNull Callable<V> callable)

Wrap callable for this context to be propagated in.

Type Parameters:

V - The callable return type

Parameters:

callable - The callable

Returns:

new callable

wrap

@NonNull
default <V> @NonNull Supplier<V> wrap(@NonNull
 @NonNull Supplier<V> supplier)

Wrap supplier for this context to be propagated in.

Type Parameters:

V - The supplier return type

Parameters:

supplier - The supplier

Returns:

new supplier

propagate

@NonNull
default <V> V propagate(@NonNull
 @NonNull Supplier<V> supplier)

Propagate the context for the supplier.

Type Parameters:

V - The supplier return type

Parameters:

supplier - The supplier

Returns:

new supplier