Resilience4j 2.3.0 · io.github.resilience4j.core.ContextAwareScheduledThreadPoolExecutor

Modifier and Type	Class and Description
public static class	ContextAwareScheduledThreadPoolExecutor.Builder

Modifier and Type	Field and Description
private final List<ContextPropagator<T>>	contextPropagators
private static final String	THREAD_PREFIX

Access	Constructor and Description
private	ContextAwareScheduledThreadPoolExecutor(int corePoolSize, List<ContextPropagator<T>> contextPropagators)

Method Summary

Modifier and Type	Method and Description
public List<ContextPropagator<T>>	getContextPropagators()
private Map<String, String>	getMdcContextMap()
public static ContextAwareScheduledThreadPoolExecutor.Builder	newScheduledThreadPool()
public ScheduledFuture<?>	schedule(Runnable the task to execute command, long the time from now to delay execution delay, TimeUnit the time unit of the delay parameter unit) Overrides java.util.concurrent.ScheduledThreadPoolExecutor.schedule. Implements java.util.concurrent.ScheduledExecutorService.schedule. Submits a one-shot task that becomes enabled after the given delay.
public <V> ScheduledFuture<V>	schedule(Callable<V> the function to execute callable, long the time from now to delay execution delay, TimeUnit the time unit of the delay parameter unit) Overrides java.util.concurrent.ScheduledThreadPoolExecutor.schedule. Implements java.util.concurrent.ScheduledExecutorService.schedule. Submits a value-returning one-shot task that becomes enabled after the given delay.
public ScheduledFuture<?>	scheduleAtFixedRate(Runnable the task to execute command, long the time to delay first execution initialDelay, long the period between successive executions period, TimeUnit the time unit of the initialDelay and period parameters unit) Overrides java.util.concurrent.ScheduledThreadPoolExecutor.scheduleAtFixedRate. Implements java.util.concurrent.ScheduledExecutorService.scheduleAtFixedRate. Submits a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is, executions will commence after `initialDelay`, then `initialDelay + period`, then `initialDelay + 2 * period`, and so on.
public ScheduledFuture<?>	scheduleWithFixedDelay(Runnable the task to execute command, long the time to delay first execution initialDelay, long the delay between the termination of one execution and the commencement of the next delay, TimeUnit the time unit of the initialDelay and delay parameters unit) Overrides java.util.concurrent.ScheduledThreadPoolExecutor.scheduleWithFixedDelay. Implements java.util.concurrent.ScheduledExecutorService.scheduleWithFixedDelay. Submits a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next.
private void	setMDCContext(Map<String, String> contextMap)

Inherited from java.util.concurrent.ScheduledThreadPoolExecutor:: decorateTask decorateTask execute getContinueExistingPeriodicTasksAfterShutdownPolicy getExecuteExistingDelayedTasksAfterShutdownPolicy getQueue getRemoveOnCancelPolicy setContinueExistingPeriodicTasksAfterShutdownPolicy setExecuteExistingDelayedTasksAfterShutdownPolicy setRemoveOnCancelPolicy shutdown shutdownNow submit submit submit

contextPropagators	back to summary
private final List<ContextPropagator<T>> contextPropagators

THREAD_PREFIX	back to summary
private static final String THREAD_PREFIX

ContextAwareScheduledThreadPoolExecutor	back to summary
private ContextAwareScheduledThreadPoolExecutor(int corePoolSize, List<ContextPropagator<T>> contextPropagators)

Method Detail

getContextPropagators	back to summary
public List<ContextPropagator<T>> getContextPropagators()

getMdcContextMap	back to summary
private Map<String, String> getMdcContextMap()

newScheduledThreadPool	back to summary
public static ContextAwareScheduledThreadPoolExecutor.Builder newScheduledThreadPool()

schedule back to summary

schedule	back to summary
public ScheduledFuture<?> schedule(Runnable command, long delay, TimeUnit unit) Overrides java.util.concurrent.ScheduledThreadPoolExecutor.schedule. Implements java.util.concurrent.ScheduledExecutorService.schedule. Doc from java.util.concurrent.ScheduledExecutorService.schedule. Submits a one-shot task that becomes enabled after the given delay. Parameters command:Runnable the task to execute delay:long the time from now to delay execution unit:TimeUnit the time unit of the delay parameter Returns:ScheduledFuture<?> a ScheduledFuture representing pending completion of the task and whose `get()` method will return `null` upon completion Annotations @Override

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

Overrides java.util.concurrent.ScheduledThreadPoolExecutor.schedule.

Implements java.util.concurrent.ScheduledExecutorService.schedule.

Doc from java.util.concurrent.ScheduledExecutorService.schedule.

Submits a one-shot task that becomes enabled after the given delay.

Parameters

command:Runnable: the task to execute
delay:long: the time from now to delay execution
unit:TimeUnit: the time unit of the delay parameter

Returns:ScheduledFuture<?>

a ScheduledFuture representing pending completion of the task and whose get() method will return null upon completion

Annotations

@Override

schedule	back to summary
public <V> ScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit) Overrides java.util.concurrent.ScheduledThreadPoolExecutor.schedule. Implements java.util.concurrent.ScheduledExecutorService.schedule. Doc from java.util.concurrent.ScheduledExecutorService.schedule. Submits a value-returning one-shot task that becomes enabled after the given delay. Parameters <V> the type of the callable's result callable:Callable<V> the function to execute delay:long the time from now to delay execution unit:TimeUnit the time unit of the delay parameter Returns:ScheduledFuture<V> a ScheduledFuture that can be used to extract result or cancel Annotations @Override

schedule

back to summary

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

Overrides java.util.concurrent.ScheduledThreadPoolExecutor.schedule.

Implements java.util.concurrent.ScheduledExecutorService.schedule.

Doc from java.util.concurrent.ScheduledExecutorService.schedule.

Submits a value-returning one-shot task that becomes enabled after the given delay.

Parameters

<V>: the type of the callable's result
callable:Callable<V>: the function to execute
delay:long: the time from now to delay execution
unit:TimeUnit: the time unit of the delay parameter

Returns:ScheduledFuture<V>

a ScheduledFuture that can be used to extract result or cancel

Annotations

@Override

scheduleAtFixedRate back to summary

scheduleAtFixedRate	back to summary
public ScheduledFuture<?> scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit) Overrides java.util.concurrent.ScheduledThreadPoolExecutor.scheduleAtFixedRate. Implements java.util.concurrent.ScheduledExecutorService.scheduleAtFixedRate. Doc from java.util.concurrent.ScheduledThreadPoolExecutor.scheduleAtFixedRate. Submits a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is, executions will commence after `initialDelay`, then `initialDelay + period`, then `initialDelay + 2 * period`, and so on. The sequence of task executions continues indefinitely until one of the following exceptional completions occur: The task is explicitly cancelled via the returned future. Method `shutdown` is called and the policy on whether to continue after shutdown is not set true, or method `shutdownNow` is called; also resulting in task cancellation. An execution of the task throws an exception. In this case calling `get` on the returned future will throw `ExecutionException`, holding the exception as its cause. Subsequent executions are suppressed. Subsequent calls to `isDone()` on the returned future will return `true`. If any execution of this task takes longer than its period, then subsequent executions may start late, but will not concurrently execute. Parameters command:Runnable Doc from java.util.concurrent.ScheduledExecutorService.scheduleAtFixedRate. the task to execute initialDelay:long Doc from java.util.concurrent.ScheduledExecutorService.scheduleAtFixedRate. the time to delay first execution period:long Doc from java.util.concurrent.ScheduledExecutorService.scheduleAtFixedRate. the period between successive executions unit:TimeUnit Doc from java.util.concurrent.ScheduledExecutorService.scheduleAtFixedRate. the time unit of the initialDelay and period parameters Returns:ScheduledFuture<?> Doc from java.util.concurrent.ScheduledExecutorService.scheduleAtFixedRate. a ScheduledFuture representing pending completion of the series of repeated tasks. The future's `get()` method will never return normally, and will throw an exception upon task cancellation or abnormal termination of a task execution. Annotations @Override

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

Overrides java.util.concurrent.ScheduledThreadPoolExecutor.scheduleAtFixedRate.

Implements java.util.concurrent.ScheduledExecutorService.scheduleAtFixedRate.

Doc from java.util.concurrent.ScheduledThreadPoolExecutor.scheduleAtFixedRate.

Submits a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is, executions will commence after initialDelay, then initialDelay + period, then initialDelay + 2 * period, and so on.

The sequence of task executions continues indefinitely until one of the following exceptional completions occur:

The task is explicitly cancelled via the returned future.
Method shutdown is called and the policy on whether to continue after shutdown is not set true, or method shutdownNow is called; also resulting in task cancellation.
An execution of the task throws an exception. In this case calling get on the returned future will throw ExecutionException, holding the exception as its cause.

Subsequent executions are suppressed. Subsequent calls to isDone() on the returned future will return true.

If any execution of this task takes longer than its period, then subsequent executions may start late, but will not concurrently execute.

Parameters

command:Runnable

Doc from java.util.concurrent.ScheduledExecutorService.scheduleAtFixedRate.

the task to execute

initialDelay:long

Doc from java.util.concurrent.ScheduledExecutorService.scheduleAtFixedRate.

the time to delay first execution

period:long

Doc from java.util.concurrent.ScheduledExecutorService.scheduleAtFixedRate.

the period between successive executions

unit:TimeUnit

Doc from java.util.concurrent.ScheduledExecutorService.scheduleAtFixedRate.

the time unit of the initialDelay and period parameters

Returns:ScheduledFuture<?>

Doc from java.util.concurrent.ScheduledExecutorService.scheduleAtFixedRate.

a ScheduledFuture representing pending completion of the series of repeated tasks. The future's get() method will never return normally, and will throw an exception upon task cancellation or abnormal termination of a task execution.

Annotations

@Override

scheduleWithFixedDelay back to summary

scheduleWithFixedDelay	back to summary
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit) Overrides java.util.concurrent.ScheduledThreadPoolExecutor.scheduleWithFixedDelay. Implements java.util.concurrent.ScheduledExecutorService.scheduleWithFixedDelay. Doc from java.util.concurrent.ScheduledThreadPoolExecutor.scheduleWithFixedDelay. Submits a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next. The sequence of task executions continues indefinitely until one of the following exceptional completions occur: The task is explicitly cancelled via the returned future. Method `shutdown` is called and the policy on whether to continue after shutdown is not set true, or method `shutdownNow` is called; also resulting in task cancellation. An execution of the task throws an exception. In this case calling `get` on the returned future will throw `ExecutionException`, holding the exception as its cause. Subsequent executions are suppressed. Subsequent calls to `isDone()` on the returned future will return `true`. Parameters command:Runnable Doc from java.util.concurrent.ScheduledExecutorService.scheduleWithFixedDelay. the task to execute initialDelay:long Doc from java.util.concurrent.ScheduledExecutorService.scheduleWithFixedDelay. the time to delay first execution delay:long Doc from java.util.concurrent.ScheduledExecutorService.scheduleWithFixedDelay. the delay between the termination of one execution and the commencement of the next unit:TimeUnit Doc from java.util.concurrent.ScheduledExecutorService.scheduleWithFixedDelay. the time unit of the initialDelay and delay parameters Returns:ScheduledFuture<?> Doc from java.util.concurrent.ScheduledExecutorService.scheduleWithFixedDelay. a ScheduledFuture representing pending completion of the series of repeated tasks. The future's `get()` method will never return normally, and will throw an exception upon task cancellation or abnormal termination of a task execution. Annotations @Override

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

Overrides java.util.concurrent.ScheduledThreadPoolExecutor.scheduleWithFixedDelay.

Implements java.util.concurrent.ScheduledExecutorService.scheduleWithFixedDelay.

Doc from java.util.concurrent.ScheduledThreadPoolExecutor.scheduleWithFixedDelay.

Submits a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next.

The sequence of task executions continues indefinitely until one of the following exceptional completions occur:

The task is explicitly cancelled via the returned future.
Method shutdown is called and the policy on whether to continue after shutdown is not set true, or method shutdownNow is called; also resulting in task cancellation.
An execution of the task throws an exception. In this case calling get on the returned future will throw ExecutionException, holding the exception as its cause.

Subsequent executions are suppressed. Subsequent calls to isDone() on the returned future will return true.

Parameters

command:Runnable

Doc from java.util.concurrent.ScheduledExecutorService.scheduleWithFixedDelay.

the task to execute

initialDelay:long

Doc from java.util.concurrent.ScheduledExecutorService.scheduleWithFixedDelay.

the time to delay first execution

delay:long

Doc from java.util.concurrent.ScheduledExecutorService.scheduleWithFixedDelay.

the delay between the termination of one execution and the commencement of the next

unit:TimeUnit

Doc from java.util.concurrent.ScheduledExecutorService.scheduleWithFixedDelay.

the time unit of the initialDelay and delay parameters

Returns:ScheduledFuture<?>

Doc from java.util.concurrent.ScheduledExecutorService.scheduleWithFixedDelay.

Annotations

@Override

setMDCContext	back to summary
private void setMDCContext(Map<String, String> contextMap)

Modifier and Type	Method and Description
public ContextAwareScheduledThreadPoolExecutor	build()
public ContextAwareScheduledThreadPoolExecutor.Builder	contextPropagators(ContextPropagator<T>... contextPropagators)
public ContextAwareScheduledThreadPoolExecutor.Builder	corePoolSize(int corePoolSize)

public Class ContextAwareScheduledThreadPoolExecutor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ContextAwareScheduledThreadPoolExecutor.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private List<ContextPropagator<T>>	contextPropagators
private int	corePoolSize