Package io.micrometer.context

Class ContextExecutorService<EXECUTOR extends ExecutorService>

java.lang.Object

io.micrometer.context.ContextExecutorService<EXECUTOR>

All Implemented Interfaces:

AutoCloseable, Executor, ExecutorService

Direct Known Subclasses:

ContextScheduledExecutorService

public class ContextExecutorService<EXECUTOR extends ExecutorService>
extends Object
implements ExecutorService

Wraps an ExecutorService in order to capture context via ContextSnapshot when a task is submitted, and propagate context to the task when it is executed.

Since:

1.0.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ContextExecutorService(EXECUTOR executorService, Supplier<ContextSnapshot> contextSnapshot)	Create an instance of ContextScheduledExecutorService.

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long timeout, TimeUnit unit)
protected ContextSnapshot	capture()
void	execute(Runnable command)
protected EXECUTOR	getExecutorService()
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
List<Runnable>	shutdownNow()
Future<?>	submit(Runnable task)
<T> Future<T>	submit(Runnable task, T result)
<T> Future<T>	submit(Callable<T> task)
static ExecutorService	wrap(ExecutorService service)	Deprecated. use wrap(ExecutorService, Supplier)
static ExecutorService	wrap(ExecutorService service, ContextSnapshotFactory contextSnapshotFactory)	Wrap the given ExecutorService in order to propagate context to any executed task through the given ContextSnapshotFactory.
static ExecutorService	wrap(ExecutorService service, Supplier<ContextSnapshot> snapshotSupplier)	Wrap the given ExecutorService in order to propagate context to any executed task through the given ContextSnapshot supplier.

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

Constructor Details

ContextExecutorService

protected ContextExecutorService(EXECUTOR executorService,
 Supplier<ContextSnapshot> contextSnapshot)

Create an instance of ContextScheduledExecutorService.

Parameters:

executorService - the ExecutorService to delegate to

contextSnapshot - supplier of the ContextSnapshot - instruction on who to retrieve ContextSnapshot when tasks are scheduled

Method Details

getExecutorService

protected EXECUTOR getExecutorService()

submit

public <T> Future<T> submit(Callable<T> task)

Specified by:

submit in interface ExecutorService

submit

public <T> Future<T> submit(Runnable task,
 T result)

Specified by:

submit in interface ExecutorService

submit

public Future<?> submit(Runnable task)

Specified by:

submit in interface ExecutorService

invokeAll

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks)
                              throws InterruptedException

Specified by:

invokeAll in interface ExecutorService

Throws:

InterruptedException

invokeAll

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks,
 long timeout,
 TimeUnit unit)
                              throws InterruptedException

Specified by:

invokeAll in interface ExecutorService

Throws:

InterruptedException

invokeAny

public <T> T invokeAny(Collection<? extends Callable<T>> tasks)
                throws InterruptedException,
ExecutionException

Specified by:

invokeAny in interface ExecutorService

Throws:

InterruptedException

ExecutionException

invokeAny

public <T> T invokeAny(Collection<? extends Callable<T>> tasks,
 long timeout,
 TimeUnit unit)
                throws InterruptedException,
ExecutionException,
TimeoutException

Specified by:

invokeAny in interface ExecutorService

Throws:

InterruptedException

ExecutionException

TimeoutException

execute

public void execute(Runnable command)

Specified by:

execute in interface Executor

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface ExecutorService

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface ExecutorService

shutdown

public void shutdown()

Specified by:

shutdown in interface ExecutorService

shutdownNow

public List<Runnable> shutdownNow()

Specified by:

shutdownNow in interface ExecutorService

awaitTermination

public boolean awaitTermination(long timeout,
 TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface ExecutorService

Throws:

InterruptedException

capture

protected ContextSnapshot capture()

wrap

public static ExecutorService wrap(ExecutorService service,
 ContextSnapshotFactory contextSnapshotFactory)

Wrap the given ExecutorService in order to propagate context to any executed task through the given ContextSnapshotFactory.

This method only captures ThreadLocal value. To work with other types of contexts, use wrap(ExecutorService, Supplier).

Parameters:

service - the executorService to wrap

contextSnapshotFactory - ContextSnapshotFactory for capturing a ContextSnapshot at the point when tasks are scheduled

Returns:

ExecutorService wrapper

Since:

1.1.2

wrap

public static ExecutorService wrap(ExecutorService service,
 Supplier<ContextSnapshot> snapshotSupplier)

Wrap the given ExecutorService in order to propagate context to any executed task through the given ContextSnapshot supplier.

Typically, a ContextSnapshotFactory can be used to supply the snapshot. In the case that only ThreadLocal values are to be captured, the wrap(ExecutorService, ContextSnapshotFactory) variant can be used.

Parameters:

service - the executorService to wrap

snapshotSupplier - supplier for capturing a ContextSnapshot at the point when tasks are scheduled

Returns:

ExecutorService wrapper

wrap

@Deprecated
public static ExecutorService wrap(ExecutorService service)

Deprecated.

use wrap(ExecutorService, Supplier)

Variant of wrap(ExecutorService, Supplier) that uses ContextSnapshot.captureAll(Object...) to create the context snapshot.

Parameters:

service - the executorService to wrap

Returns:

ExecutorService wrapper