Package io.micrometer.context

Class ContextScheduledExecutorService

java.lang.Object

io.micrometer.context.ContextExecutorService<ScheduledExecutorService>

io.micrometer.context.ContextScheduledExecutorService

All Implemented Interfaces:

AutoCloseable, Executor, ExecutorService, ScheduledExecutorService

public final class ContextScheduledExecutorService
extends ContextExecutorService<ScheduledExecutorService>
implements ScheduledExecutorService

Wraps a ScheduledExecutorService 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

Method Summary

Modifier and Type	Method	Description
ScheduledFuture<?>	schedule(Runnable command, long delay, TimeUnit unit)
<V> ScheduledFuture<V>	schedule(Callable<V> callable, long delay, TimeUnit unit)
ScheduledFuture<?>	scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)
ScheduledFuture<?>	scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)
static ScheduledExecutorService	wrap(ScheduledExecutorService service)	Deprecated. use wrap(ScheduledExecutorService, Supplier)
static ScheduledExecutorService	wrap(ScheduledExecutorService service, ContextSnapshotFactory contextSnapshotFactory)	Wrap the given ScheduledExecutorService in order to propagate context to any executed task through the given ContextSnapshotFactory.
static ScheduledExecutorService	wrap(ScheduledExecutorService service, Supplier<ContextSnapshot> supplier)	Wrap the given ScheduledExecutorService in order to propagate context to any executed task through the given ContextSnapshot supplier.

Methods inherited from class io.micrometer.context.ContextExecutorService

awaitTermination, capture, execute, getExecutorService, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isTerminated, shutdown, shutdownNow, submit, submit, submit, wrap, wrap, wrap

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.Executor

execute

Methods inherited from interface java.util.concurrent.ExecutorService

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

Method Details

schedule

public ScheduledFuture<?> schedule(Runnable command,
 long delay,
 TimeUnit unit)

Specified by:

schedule in interface ScheduledExecutorService

schedule

public <V> ScheduledFuture<V> schedule(Callable<V> callable,
 long delay,
 TimeUnit unit)

Specified by:

schedule in interface ScheduledExecutorService

scheduleAtFixedRate

public ScheduledFuture<?> scheduleAtFixedRate(Runnable command,
 long initialDelay,
 long period,
 TimeUnit unit)

Specified by:

scheduleAtFixedRate in interface ScheduledExecutorService

scheduleWithFixedDelay

public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
 long initialDelay,
 long delay,
 TimeUnit unit)

Specified by:

scheduleWithFixedDelay in interface ScheduledExecutorService

wrap

public static ScheduledExecutorService wrap(ScheduledExecutorService service,
 ContextSnapshotFactory contextSnapshotFactory)

Wrap the given ScheduledExecutorService 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(ScheduledExecutorService, Supplier).

Parameters:

service - the executorService to wrap

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

Returns:

ScheduledExecutorService wrapper

Since:

1.1.2

wrap

public static ScheduledExecutorService wrap(ScheduledExecutorService service,
 Supplier<ContextSnapshot> supplier)

Wrap the given ScheduledExecutorService 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(ScheduledExecutorService, ContextSnapshotFactory) variant can be used.

Parameters:

service - the executorService to wrap

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

Returns:

ScheduledExecutorService wrapper

wrap

@Deprecated
public static ScheduledExecutorService wrap(ScheduledExecutorService service)

Deprecated.

use wrap(ScheduledExecutorService, Supplier)

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

Parameters:

service - the executorService to wrap

Returns:

ScheduledExecutorService wrapper