Package io.micronaut.context.propagation.instrument.execution

Class ContextPropagatingExecutorService

java.lang.Object

io.micronaut.context.propagation.instrument.execution.ContextPropagatingExecutorService

All Implemented Interfaces:

InstrumentedExecutor, InstrumentedExecutorService, RunnableInstrumenter, AutoCloseable, Executor, ExecutorService

Direct Known Subclasses:

ContextPropagatingScheduledExecutorService

@Internal
public class ContextPropagatingExecutorService
extends Object
implements InstrumentedExecutorService

Wraps ExecutorService to instrument it for propagating the PropagatedContext across threads.

Since:

4.9.0

Author:

Hauke Lange

Constructor Summary

Constructors

Constructor	Description
ContextPropagatingExecutorService(ExecutorService target)
ContextPropagatingExecutorService(ExecutorService target, @Nullable PropagatedContext propagatedContext)

Method Summary

Modifier and Type	Method	Description
ExecutorService	getTarget()	Implementors can override to specify the target ExecutorService.
Runnable	instrument(Runnable task)	Implementors can override to instrument a Runnable.
<T> Callable<T>	instrument(Callable<T> task)	Instruments the given callable task.
static boolean	isInstrumented(ExecutorService executorService)	Checks if the given ExecutorService is instrumented with ContextPropagatingExecutorService.
static Optional<ExecutorService>	unwrap(ExecutorService executorService)	Unwraps the target ExecutorService from the given InstrumentedExecutorService if it is instrumented with ContextPropagatingExecutorService.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.ExecutorService

close

Methods inherited from interface io.micronaut.scheduling.instrument.InstrumentedExecutor

execute

Methods inherited from interface io.micronaut.scheduling.instrument.InstrumentedExecutorService

awaitTermination, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isTerminated, shutdown, shutdownNow, submit, submit, submit

Constructor Details

ContextPropagatingExecutorService

public ContextPropagatingExecutorService(ExecutorService target)

ContextPropagatingExecutorService

public ContextPropagatingExecutorService(ExecutorService target,
 @Nullable
 @Nullable PropagatedContext propagatedContext)

Method Details

getTarget

public ExecutorService getTarget()

Description copied from interface: InstrumentedExecutorService

Implementors can override to specify the target ExecutorService.

Specified by:

getTarget in interface InstrumentedExecutor

Specified by:

getTarget in interface InstrumentedExecutorService

Returns:

The target ExecutorService

instrument

public <T> Callable<T> instrument(Callable<T> task)

Description copied from interface: InstrumentedExecutorService

Instruments the given callable task.

Specified by:

instrument in interface InstrumentedExecutorService

Type Parameters:

T - The generic return type

Parameters:

task - the task to instrument

Returns:

The callable

instrument

public Runnable instrument(Runnable task)

Description copied from interface: RunnableInstrumenter

Implementors can override to instrument a Runnable.

Specified by:

instrument in interface RunnableInstrumenter

Parameters:

task - The command to instrument

Returns:

The instrumented runnable

unwrap

public static Optional<ExecutorService> unwrap(ExecutorService executorService)

Unwraps the target ExecutorService from the given InstrumentedExecutorService if it is instrumented with ContextPropagatingExecutorService.

Parameters:

executorService - The instrumented executor service

Returns:

The target executor service of the ContextPropagatingScheduledExecutorService or empty if not found

isInstrumented

public static boolean isInstrumented(ExecutorService executorService)

Checks if the given ExecutorService is instrumented with ContextPropagatingExecutorService.

Parameters:

executorService - The executor service to check

Returns:

true if it is instrumented, false otherwise