public interface TaskScheduler
Runnables based on different kinds of triggers.
This interface is separate from SchedulingTaskExecutor since it
usually represents a different kind of backend, i.e. a thread pool with
different characteristics and capabilities. Implementations may implement
both interfaces if they can handle both kinds of execution characteristics.
The 'default' implementation is
ThreadPoolTaskScheduler,
wrapping a native ScheduledExecutorService
and adding extended trigger capabilities.
This interface is roughly equivalent to a JSR-236
ManagedScheduledExecutorService as supported in Java EE 7
environments but aligned with Spring's TaskExecutor model.
TaskExecutor,
ScheduledExecutorService,
ThreadPoolTaskScheduler| Modifier and Type | Method and Description |
|---|---|
default Clock |
getClock()
Return the clock to use for scheduling purposes.
|
ScheduledFuture<?> |
schedule(Runnable task,
Date startTime)
Schedule the given
Runnable, invoking it at the specified execution time. |
default ScheduledFuture<?> |
schedule(Runnable task,
Instant startTime)
Schedule the given
Runnable, invoking it at the specified execution time. |
ScheduledFuture<?> |
schedule(Runnable task,
Trigger trigger)
Schedule the given
Runnable, invoking it whenever the trigger
indicates a next execution time. |
ScheduledFuture<?> |
scheduleAtFixedRate(Runnable task,
Date startTime,
long period)
Schedule the given
Runnable, invoking it at the specified execution time
and subsequently with the given period. |
default ScheduledFuture<?> |
scheduleAtFixedRate(Runnable task,
Duration period)
Schedule the given
Runnable, starting as soon as possible and
invoking it with the given period. |
default ScheduledFuture<?> |
scheduleAtFixedRate(Runnable task,
Instant startTime,
Duration period)
Schedule the given
Runnable, invoking it at the specified execution time
and subsequently with the given period. |
ScheduledFuture<?> |
scheduleAtFixedRate(Runnable task,
long period)
Schedule the given
Runnable, starting as soon as possible and
invoking it with the given period. |
ScheduledFuture<?> |
scheduleWithFixedDelay(Runnable task,
Date startTime,
long delay)
Schedule the given
Runnable, invoking it at the specified execution time
and subsequently with the given delay between the completion of one execution
and the start of the next. |
default ScheduledFuture<?> |
scheduleWithFixedDelay(Runnable task,
Duration delay)
Schedule the given
Runnable, starting as soon as possible and invoking it with
the given delay between the completion of one execution and the start of the next. |
default ScheduledFuture<?> |
scheduleWithFixedDelay(Runnable task,
Instant startTime,
Duration delay)
Schedule the given
Runnable, invoking it at the specified execution time
and subsequently with the given delay between the completion of one execution
and the start of the next. |
ScheduledFuture<?> |
scheduleWithFixedDelay(Runnable task,
long delay)
Schedule the given
Runnable, starting as soon as possible and invoking it with
the given delay between the completion of one execution and the start of the next. |
default Clock getClock()
Clock.systemDefaultZone()@Nullable ScheduledFuture<?> schedule(Runnable task, Trigger trigger)
Runnable, invoking it whenever the trigger
indicates a next execution time.
Execution will end once the scheduler shuts down or the returned
ScheduledFuture gets cancelled.
task - the Runnable to execute whenever the trigger firestrigger - an implementation of the Trigger interface,
e.g. a CronTrigger object
wrapping a cron expressionScheduledFuture representing pending completion of the task,
or null if the given Trigger object never fires (i.e. returns
null from Trigger.nextExecutionTime(org.springframework.scheduling.TriggerContext))TaskRejectedException - if the given task was not accepted
for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)CronTriggerdefault ScheduledFuture<?> schedule(Runnable task, Instant startTime)
Runnable, invoking it at the specified execution time.
Execution will end once the scheduler shuts down or the returned
ScheduledFuture gets cancelled.
task - the Runnable to execute whenever the trigger firesstartTime - the desired execution time for the task
(if this is in the past, the task will be executed immediately, i.e. as soon as possible)ScheduledFuture representing pending completion of the taskTaskRejectedException - if the given task was not accepted
for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)schedule(Runnable, Date)ScheduledFuture<?> schedule(Runnable task, Date startTime)
Runnable, invoking it at the specified execution time.
Execution will end once the scheduler shuts down or the returned
ScheduledFuture gets cancelled.
task - the Runnable to execute whenever the trigger firesstartTime - the desired execution time for the task
(if this is in the past, the task will be executed immediately, i.e. as soon as possible)ScheduledFuture representing pending completion of the taskTaskRejectedException - if the given task was not accepted
for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)default ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Instant startTime, Duration period)
Runnable, invoking it at the specified execution time
and subsequently with the given period.
Execution will end once the scheduler shuts down or the returned
ScheduledFuture gets cancelled.
task - the Runnable to execute whenever the trigger firesstartTime - the desired first execution time for the task
(if this is in the past, the task will be executed immediately, i.e. as soon as possible)period - the interval between successive executions of the taskScheduledFuture representing pending completion of the taskTaskRejectedException - if the given task was not accepted
for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)scheduleAtFixedRate(Runnable, Date, long)ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Date startTime, long period)
Runnable, invoking it at the specified execution time
and subsequently with the given period.
Execution will end once the scheduler shuts down or the returned
ScheduledFuture gets cancelled.
task - the Runnable to execute whenever the trigger firesstartTime - the desired first execution time for the task
(if this is in the past, the task will be executed immediately, i.e. as soon as possible)period - the interval between successive executions of the task (in milliseconds)ScheduledFuture representing pending completion of the taskTaskRejectedException - if the given task was not accepted
for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)default ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Duration period)
Runnable, starting as soon as possible and
invoking it with the given period.
Execution will end once the scheduler shuts down or the returned
ScheduledFuture gets cancelled.
task - the Runnable to execute whenever the trigger firesperiod - the interval between successive executions of the taskScheduledFuture representing pending completion of the taskTaskRejectedException - if the given task was not accepted
for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)scheduleAtFixedRate(Runnable, long)ScheduledFuture<?> scheduleAtFixedRate(Runnable task, long period)
Runnable, starting as soon as possible and
invoking it with the given period.
Execution will end once the scheduler shuts down or the returned
ScheduledFuture gets cancelled.
task - the Runnable to execute whenever the trigger firesperiod - the interval between successive executions of the task (in milliseconds)ScheduledFuture representing pending completion of the taskTaskRejectedException - if the given task was not accepted
for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)default ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Instant startTime, Duration delay)
Runnable, invoking it at the specified execution time
and subsequently with the given delay between the completion of one execution
and the start of the next.
Execution will end once the scheduler shuts down or the returned
ScheduledFuture gets cancelled.
task - the Runnable to execute whenever the trigger firesstartTime - the desired first execution time for the task
(if this is in the past, the task will be executed immediately, i.e. as soon as possible)delay - the delay between the completion of one execution and the start of the nextScheduledFuture representing pending completion of the taskTaskRejectedException - if the given task was not accepted
for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)scheduleWithFixedDelay(Runnable, Date, long)ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Date startTime, long delay)
Runnable, invoking it at the specified execution time
and subsequently with the given delay between the completion of one execution
and the start of the next.
Execution will end once the scheduler shuts down or the returned
ScheduledFuture gets cancelled.
task - the Runnable to execute whenever the trigger firesstartTime - the desired first execution time for the task
(if this is in the past, the task will be executed immediately, i.e. as soon as possible)delay - the delay between the completion of one execution and the start of the next
(in milliseconds)ScheduledFuture representing pending completion of the taskTaskRejectedException - if the given task was not accepted
for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)default ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Duration delay)
Runnable, starting as soon as possible and invoking it with
the given delay between the completion of one execution and the start of the next.
Execution will end once the scheduler shuts down or the returned
ScheduledFuture gets cancelled.
task - the Runnable to execute whenever the trigger firesdelay - the delay between the completion of one execution and the start of the nextScheduledFuture representing pending completion of the taskTaskRejectedException - if the given task was not accepted
for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)scheduleWithFixedDelay(Runnable, long)ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, long delay)
Runnable, starting as soon as possible and invoking it with
the given delay between the completion of one execution and the start of the next.
Execution will end once the scheduler shuts down or the returned
ScheduledFuture gets cancelled.
task - the Runnable to execute whenever the trigger firesdelay - the delay between the completion of one execution and the start of the next
(in milliseconds)ScheduledFuture representing pending completion of the taskTaskRejectedException - if the given task was not accepted
for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)