context-propagation 1.1.0 · io.micrometer.context.ContextExecutorService

Modifier and Type	Field and Description
private final Supplier<ContextSnapshot>	contextSnapshot
private final EXECUTOR	executorService

Access	Constructor and Description
protected	ContextExecutorService(EXECUTOR the `ExecutorService` to delegate to executorService, Supplier<ContextSnapshot> supplier of the `ContextSnapshot` - instruction on who to retrieve `ContextSnapshot` when tasks are scheduled contextSnapshot) Create an instance of `ContextScheduledExecutorService`.

Method Summary

Modifier and Type	Method and Description
public boolean	awaitTermination(long the maximum time to wait timeout, TimeUnit the time unit of the timeout argument unit) Implements java.util.concurrent.ExecutorService.awaitTermination. Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.
protected ContextSnapshot	capture()
public void	execute(Runnable the runnable task command) Implements java.util.concurrent.Executor.execute. Executes the given command at some time in the future.
protected EXECUTOR	getExecutorService()
public <T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> the collection of tasks tasks) Implements java.util.concurrent.ExecutorService.invokeAll. Executes the given tasks, returning a list of Futures holding their status and results when all complete.
public <T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> the collection of tasks tasks, long the maximum time to wait timeout, TimeUnit the time unit of the timeout argument unit) Implements java.util.concurrent.ExecutorService.invokeAll. Executes the given tasks, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first.
public <T> T	invokeAny(Collection<? extends Callable<T>> the collection of tasks tasks) Implements java.util.concurrent.ExecutorService.invokeAny. Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do.
public <T> T	invokeAny(Collection<? extends Callable<T>> the collection of tasks tasks, long the maximum time to wait timeout, TimeUnit the time unit of the timeout argument unit) Implements java.util.concurrent.ExecutorService.invokeAny. Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do before the given timeout elapses.
public boolean	isShutdown() Implements java.util.concurrent.ExecutorService.isShutdown. Returns `true` if this executor has been shut down.
public boolean	isTerminated() Implements java.util.concurrent.ExecutorService.isTerminated. Returns `true` if all tasks have completed following shut down.
public void	shutdown() Implements java.util.concurrent.ExecutorService.shutdown. Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
public List<Runnable>	shutdownNow() Implements java.util.concurrent.ExecutorService.shutdownNow. Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution.
public <T> Future<T>	submit(Callable<T> the task to submit task) Implements java.util.concurrent.ExecutorService.submit. Submits a value-returning task for execution and returns a Future representing the pending results of the task.
public <T> Future<T>	submit(Runnable the task to submit task, T the result to return result) Implements java.util.concurrent.ExecutorService.submit. Submits a Runnable task for execution and returns a Future representing that task.
public Future<?>	submit(Runnable the task to submit task) Implements java.util.concurrent.ExecutorService.submit. Submits a Runnable task for execution and returns a Future representing that task.
public static ExecutorService	wrap(ExecutorService the executorService to wrap service, Supplier<ContextSnapshot> supplier for capturing a `ContextSnapshot` at the point when tasks are scheduled snapshotSupplier) Wrap the given `ExecutorService` in order to propagate context to any executed task through the given `ContextSnapshot` supplier.
public static ExecutorService	wrap(ExecutorService the executorService to wrap service) Deprecated use `wrap(ExecutorService, Supplier)` Variant of `wrap(ExecutorService, Supplier)` that uses `ContextSnapshot#captureAll(Object.`

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

contextSnapshot	back to summary
private final Supplier<ContextSnapshot> contextSnapshot

executorService	back to summary
private final EXECUTOR executorService

ContextExecutorService	back to summary
protected ContextExecutorService(EXECUTOR executorService, Supplier<ContextSnapshot> contextSnapshot) Create an instance of `ContextScheduledExecutorService`. Parameters executorService:EXECUTOR the `ExecutorService` to delegate to contextSnapshot:Supplier<ContextSnapshot> supplier of the `ContextSnapshot` - instruction on who to retrieve `ContextSnapshot` when tasks are scheduled

Method Detail

awaitTermination back to summary

awaitTermination	back to summary
public boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException Implements java.util.concurrent.ExecutorService.awaitTermination. Doc from java.util.concurrent.ExecutorService.awaitTermination. Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first. Parameters timeout:long the maximum time to wait unit:TimeUnit the time unit of the timeout argument Returns:boolean `true` if this executor terminated and `false` if the timeout elapsed before termination Annotations @Override Exceptions InterruptedException: if interrupted while waiting

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

Implements java.util.concurrent.ExecutorService.awaitTermination.

Doc from java.util.concurrent.ExecutorService.awaitTermination.

Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Parameters

timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Returns:boolean

true if this executor terminated and false if the timeout elapsed before termination

Annotations

@Override

Exceptions

InterruptedException:: if interrupted while waiting

capture	back to summary
protected ContextSnapshot capture()

execute back to summary

execute	back to summary
public void execute(Runnable command) Implements java.util.concurrent.Executor.execute. Doc from java.util.concurrent.Executor.execute. Executes the given command at some time in the future. The command may execute in a new thread, in a pooled thread, or in the calling thread, at the discretion of the `Executor` implementation. Parameters command:Runnable the runnable task Annotations @Override

public void execute(Runnable command)

Implements java.util.concurrent.Executor.execute.

Doc from java.util.concurrent.Executor.execute.

Executes the given command at some time in the future. The command may execute in a new thread, in a pooled thread, or in the calling thread, at the discretion of the Executor implementation.

Parameters

command:Runnable: the runnable task

Annotations

@Override

getExecutorService	back to summary
protected EXECUTOR getExecutorService()

invokeAll back to summary

invokeAll	back to summary
public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks) throws InterruptedException Implements java.util.concurrent.ExecutorService.invokeAll. Doc from java.util.concurrent.ExecutorService.invokeAll. Executes the given tasks, returning a list of Futures holding their status and results when all complete. `Future#isDone` is `true` for each element of the returned list. Note that a completed task could have terminated either normally or by throwing an exception. The results of this method are undefined if the given collection is modified while this operation is in progress. Parameters <T> the type of the values returned from the tasks tasks:Collection<? extends Callable<T>> the collection of tasks Returns:List<Future<T>> a list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list, each of which has completed Annotations @Override Exceptions InterruptedException: if interrupted while waiting, in which case unfinished tasks are cancelled

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

Implements java.util.concurrent.ExecutorService.invokeAll.

Doc from java.util.concurrent.ExecutorService.invokeAll.

Executes the given tasks, returning a list of Futures holding their status and results when all complete. Future#isDone is true for each element of the returned list. Note that a completed task could have terminated either normally or by throwing an exception. The results of this method are undefined if the given collection is modified while this operation is in progress.

Parameters

<T>: the type of the values returned from the tasks
tasks:Collection<? extends Callable<T>>: the collection of tasks

Returns:List<Future<T>>

a list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list, each of which has completed

Annotations

@Override

Exceptions

InterruptedException:: if interrupted while waiting, in which case unfinished tasks are cancelled

invokeAll back to summary

invokeAll	back to summary
public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) throws InterruptedException Implements java.util.concurrent.ExecutorService.invokeAll. Doc from java.util.concurrent.ExecutorService.invokeAll. Executes the given tasks, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first. `Future#isDone` is `true` for each element of the returned list. Upon return, tasks that have not completed are cancelled. Note that a completed task could have terminated either normally or by throwing an exception. The results of this method are undefined if the given collection is modified while this operation is in progress. Parameters <T> the type of the values returned from the tasks tasks:Collection<? extends Callable<T>> the collection of tasks timeout:long the maximum time to wait unit:TimeUnit the time unit of the timeout argument Returns:List<Future<T>> a list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list. If the operation did not time out, each task will have completed. If it did time out, some of these tasks will not have completed. Annotations @Override Exceptions InterruptedException: if interrupted while waiting, in which case unfinished tasks are cancelled

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

Implements java.util.concurrent.ExecutorService.invokeAll.

Doc from java.util.concurrent.ExecutorService.invokeAll.

Executes the given tasks, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first. Future#isDone is true for each element of the returned list. Upon return, tasks that have not completed are cancelled. Note that a completed task could have terminated either normally or by throwing an exception. The results of this method are undefined if the given collection is modified while this operation is in progress.

Parameters

<T>: the type of the values returned from the tasks
tasks:Collection<? extends Callable<T>>: the collection of tasks
timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Returns:List<Future<T>>

a list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list. If the operation did not time out, each task will have completed. If it did time out, some of these tasks will not have completed.

Annotations

@Override

Exceptions

InterruptedException:: if interrupted while waiting, in which case unfinished tasks are cancelled

invokeAny	back to summary
public <T> T invokeAny(Collection<? extends Callable<T>> tasks) throws InterruptedException, ExecutionException Implements java.util.concurrent.ExecutorService.invokeAny. Doc from java.util.concurrent.ExecutorService.invokeAny. Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do. Upon normal or exceptional return, tasks that have not completed are cancelled. The results of this method are undefined if the given collection is modified while this operation is in progress. Parameters <T> the type of the values returned from the tasks tasks:Collection<? extends Callable<T>> the collection of tasks Returns:T the result returned by one of the tasks Annotations @Override Exceptions InterruptedException: if interrupted while waiting ExecutionException: if no task successfully completes

invokeAny

back to summary

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

Implements java.util.concurrent.ExecutorService.invokeAny.

Doc from java.util.concurrent.ExecutorService.invokeAny.

Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do. Upon normal or exceptional return, tasks that have not completed are cancelled. The results of this method are undefined if the given collection is modified while this operation is in progress.

Parameters

<T>: the type of the values returned from the tasks
tasks:Collection<? extends Callable<T>>: the collection of tasks

Returns:T

the result returned by one of the tasks

Annotations

@Override

Exceptions

InterruptedException:: if interrupted while waiting
ExecutionException:: if no task successfully completes

invokeAny	back to summary
public <T> T invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException Implements java.util.concurrent.ExecutorService.invokeAny. Doc from java.util.concurrent.ExecutorService.invokeAny. Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do before the given timeout elapses. Upon normal or exceptional return, tasks that have not completed are cancelled. The results of this method are undefined if the given collection is modified while this operation is in progress. Parameters <T> the type of the values returned from the tasks tasks:Collection<? extends Callable<T>> the collection of tasks timeout:long the maximum time to wait unit:TimeUnit the time unit of the timeout argument Returns:T the result returned by one of the tasks Annotations @Override Exceptions InterruptedException: if interrupted while waiting ExecutionException: if no task successfully completes TimeoutException: if the given timeout elapses before any task successfully completes

invokeAny

back to summary

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

Implements java.util.concurrent.ExecutorService.invokeAny.

Doc from java.util.concurrent.ExecutorService.invokeAny.

Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do before the given timeout elapses. Upon normal or exceptional return, tasks that have not completed are cancelled. The results of this method are undefined if the given collection is modified while this operation is in progress.

Parameters

<T>: the type of the values returned from the tasks
tasks:Collection<? extends Callable<T>>: the collection of tasks
timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Returns:T

the result returned by one of the tasks

Annotations

@Override

Exceptions

InterruptedException:: if interrupted while waiting
ExecutionException:: if no task successfully completes
TimeoutException:: if the given timeout elapses before any task successfully completes

isShutdown back to summary

isShutdown	back to summary
public boolean isShutdown() Implements java.util.concurrent.ExecutorService.isShutdown. Doc from java.util.concurrent.ExecutorService.isShutdown. Returns `true` if this executor has been shut down. Returns:boolean `true` if this executor has been shut down Annotations @Override

public boolean isShutdown()

Implements java.util.concurrent.ExecutorService.isShutdown.

Doc from java.util.concurrent.ExecutorService.isShutdown.

Returns true if this executor has been shut down.

Returns:boolean

true if this executor has been shut down

Annotations

@Override

isTerminated back to summary

isTerminated	back to summary
public boolean isTerminated() Implements java.util.concurrent.ExecutorService.isTerminated. Doc from java.util.concurrent.ExecutorService.isTerminated. Returns `true` if all tasks have completed following shut down. Note that `isTerminated` is never `true` unless either `shutdown` or `shutdownNow` was called first. Returns:boolean `true` if all tasks have completed following shut down Annotations @Override

public boolean isTerminated()

Implements java.util.concurrent.ExecutorService.isTerminated.

Doc from java.util.concurrent.ExecutorService.isTerminated.

Returns true if all tasks have completed following shut down. Note that isTerminated is never true unless either shutdown or shutdownNow was called first.

Returns:boolean

true if all tasks have completed following shut down

Annotations

@Override

shutdown back to summary

shutdown	back to summary
public void shutdown() Implements java.util.concurrent.ExecutorService.shutdown. Doc from java.util.concurrent.ExecutorService.shutdown. Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down. This method does not wait for previously submitted tasks to complete execution. Use `awaitTermination` to do that. Annotations @Override

public void shutdown()

Implements java.util.concurrent.ExecutorService.shutdown.

Doc from java.util.concurrent.ExecutorService.shutdown.

Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down.

This method does not wait for previously submitted tasks to complete execution. Use awaitTermination to do that.

Annotations

@Override

shutdownNow back to summary

shutdownNow	back to summary
public List<Runnable> shutdownNow() Implements java.util.concurrent.ExecutorService.shutdownNow. Doc from java.util.concurrent.ExecutorService.shutdownNow. Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution. This method does not wait for actively executing tasks to terminate. Use `awaitTermination` to do that. There are no guarantees beyond best-effort attempts to stop processing actively executing tasks. For example, typical implementations will cancel via `Thread#interrupt`, so any task that fails to respond to interrupts may never terminate. Returns:List<Runnable> list of tasks that never commenced execution Annotations @Override

public List<Runnable> shutdownNow()

Implements java.util.concurrent.ExecutorService.shutdownNow.

Doc from java.util.concurrent.ExecutorService.shutdownNow.

Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution.

This method does not wait for actively executing tasks to terminate. Use awaitTermination to do that.

There are no guarantees beyond best-effort attempts to stop processing actively executing tasks. For example, typical implementations will cancel via Thread#interrupt, so any task that fails to respond to interrupts may never terminate.

Returns:List<Runnable>

list of tasks that never commenced execution

Annotations

@Override

submit back to summary

submit	back to summary
public <T> Future<T> submit(Callable<T> task) Implements java.util.concurrent.ExecutorService.submit. Doc from java.util.concurrent.ExecutorService.submit. Submits a value-returning task for execution and returns a Future representing the pending results of the task. The Future's `get` method will return the task's result upon successful completion. If you would like to immediately block waiting for a task, you can use constructions of the form `result = exec.submit(aCallable).get();` Note The `Executors` class includes a set of methods that can convert some other common closure-like objects, for example, `java.security.PrivilegedAction` to `Callable` form so they can be submitted. Parameters <T> the type of the task's result task:Callable<T> the task to submit Returns:Future<T> a Future representing pending completion of the task Annotations @Override

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

Implements java.util.concurrent.ExecutorService.submit.

Doc from java.util.concurrent.ExecutorService.submit.

Submits a value-returning task for execution and returns a Future representing the pending results of the task. The Future's get method will return the task's result upon successful completion.

If you would like to immediately block waiting for a task, you can use constructions of the form result = exec.submit(aCallable).get();

Note

The Executors class includes a set of methods that can convert some other common closure-like objects, for example, java.security.PrivilegedAction to Callable form so they can be submitted.

Parameters

<T>: the type of the task's result
task:Callable<T>: the task to submit

Returns:Future<T>

a Future representing pending completion of the task

Annotations

@Override

submit back to summary

submit	back to summary
public <T> Future<T> submit(Runnable task, T result) Implements java.util.concurrent.ExecutorService.submit. Doc from java.util.concurrent.ExecutorService.submit. Submits a Runnable task for execution and returns a Future representing that task. The Future's `get` method will return the given result upon successful completion. Parameters <T> the type of the result task:Runnable the task to submit result:T the result to return Returns:Future<T> a Future representing pending completion of the task Annotations @Override

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

Implements java.util.concurrent.ExecutorService.submit.

Doc from java.util.concurrent.ExecutorService.submit.

Submits a Runnable task for execution and returns a Future representing that task. The Future's get method will return the given result upon successful completion.

Parameters

<T>: the type of the result
task:Runnable: the task to submit
result:T: the result to return

Returns:Future<T>

a Future representing pending completion of the task

Annotations

@Override

submit back to summary

submit	back to summary
public Future<?> submit(Runnable task) Implements java.util.concurrent.ExecutorService.submit. Doc from java.util.concurrent.ExecutorService.submit. Submits a Runnable task for execution and returns a Future representing that task. The Future's `get` method will return `null` upon successful completion. Parameters task:Runnable the task to submit Returns:Future<?> a Future representing pending completion of the task Annotations @Override

public Future<?> submit(Runnable task)

Implements java.util.concurrent.ExecutorService.submit.

Doc from java.util.concurrent.ExecutorService.submit.

Submits a Runnable task for execution and returns a Future representing that task. The Future's get method will return null upon successful completion.

Parameters

task:Runnable: the task to submit

Returns:Future<?>

a Future representing pending completion of the task

Annotations

@Override

wrap back to summary

wrap	back to summary
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. Parameters service:ExecutorService the executorService to wrap snapshotSupplier:Supplier<ContextSnapshot> supplier for capturing a `ContextSnapshot` at the point when tasks are scheduled

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.

Parameters

service:ExecutorService: the executorService to wrap
snapshotSupplier:Supplier<ContextSnapshot>: supplier for capturing a ContextSnapshot at the point when tasks are scheduled

wrap back to summary

wrap	back to summary
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:ExecutorService the executorService to wrap Annotations @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:ExecutorService: the executorService to wrap

Annotations

@Deprecated

public Class ContextExecutorService<EXECUTOR extends java.util.concurrent.ExecutorService>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail