org.springframework.scheduling

Interface TaskScheduler

All Known Implementing Classes:

ConcurrentTaskScheduler, DefaultManagedTaskScheduler, ThreadPoolTaskScheduler, TimerManagerTaskScheduler

public interface TaskScheduler

Task scheduler interface that abstracts the scheduling of Runnables based on different kinds of triggers.

This interface is separate from SchedulingTaskExecutor since it usually represents for 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.

Since:

3.0

Author:

Juergen Hoeller

See Also:

TaskExecutor, ScheduledExecutorService, ThreadPoolTaskScheduler

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.ScheduledFuture<?>	schedule(java.lang.Runnable task, java.util.Date startTime) Schedule the given Runnable, invoking it at the specified execution time.
default java.util.concurrent.ScheduledFuture<?>	schedule(java.lang.Runnable task, java.time.Instant startTime) Schedule the given Runnable, invoking it at the specified execution time.
java.util.concurrent.ScheduledFuture<?>	schedule(java.lang.Runnable task, Trigger trigger) Schedule the given Runnable, invoking it whenever the trigger indicates a next execution time.
java.util.concurrent.ScheduledFuture<?>	scheduleAtFixedRate(java.lang.Runnable task, java.util.Date startTime, long period) Schedule the given Runnable, invoking it at the specified execution time and subsequently with the given period.
default java.util.concurrent.ScheduledFuture<?>	scheduleAtFixedRate(java.lang.Runnable task, java.time.Duration period) Schedule the given Runnable, starting as soon as possible and invoking it with the given period.
default java.util.concurrent.ScheduledFuture<?>	scheduleAtFixedRate(java.lang.Runnable task, java.time.Instant startTime, java.time.Duration period) Schedule the given Runnable, invoking it at the specified execution time and subsequently with the given period.
java.util.concurrent.ScheduledFuture<?>	scheduleAtFixedRate(java.lang.Runnable task, long period) Schedule the given Runnable, starting as soon as possible and invoking it with the given period.
java.util.concurrent.ScheduledFuture<?>	scheduleWithFixedDelay(java.lang.Runnable task, java.util.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 java.util.concurrent.ScheduledFuture<?>	scheduleWithFixedDelay(java.lang.Runnable task, java.time.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 java.util.concurrent.ScheduledFuture<?>	scheduleWithFixedDelay(java.lang.Runnable task, java.time.Instant startTime, java.time.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.
java.util.concurrent.ScheduledFuture<?>	scheduleWithFixedDelay(java.lang.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.

Method Detail

schedule

@Nullable
java.util.concurrent.ScheduledFuture<?> schedule(java.lang.Runnable task,
                                                           Trigger trigger)

Schedule the given 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.

Parameters:

task - the Runnable to execute whenever the trigger fires

trigger - an implementation of the Trigger interface, e.g. a CronTrigger object wrapping a cron expression

Returns:

a ScheduledFuture 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))

Throws:

TaskRejectedException - if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

See Also:

CronTrigger

schedule

default java.util.concurrent.ScheduledFuture<?> schedule(java.lang.Runnable task,
                                                         java.time.Instant startTime)

Schedule the given Runnable, invoking it at the specified execution time.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters:

task - the Runnable to execute whenever the trigger fires

startTime - 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)

Returns:

a ScheduledFuture representing pending completion of the task

Throws:

TaskRejectedException - if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

Since:

5.0

See Also:

schedule(Runnable, Date)

schedule

java.util.concurrent.ScheduledFuture<?> schedule(java.lang.Runnable task,
                                                 java.util.Date startTime)

Schedule the given Runnable, invoking it at the specified execution time.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters:

task - the Runnable to execute whenever the trigger fires

startTime - 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)

Returns:

a ScheduledFuture representing pending completion of the task

Throws:

TaskRejectedException - if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

scheduleAtFixedRate

default java.util.concurrent.ScheduledFuture<?> scheduleAtFixedRate(java.lang.Runnable task,
                                                                    java.time.Instant startTime,
                                                                    java.time.Duration period)

Schedule the given 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.

Parameters:

task - the Runnable to execute whenever the trigger fires

startTime - 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

Returns:

a ScheduledFuture representing pending completion of the task

Throws:

TaskRejectedException - if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

Since:

5.0

See Also:

scheduleAtFixedRate(Runnable, Date, long)

scheduleAtFixedRate

java.util.concurrent.ScheduledFuture<?> scheduleAtFixedRate(java.lang.Runnable task,
                                                            java.util.Date startTime,
                                                            long period)

Schedule the given 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.

Parameters:

task - the Runnable to execute whenever the trigger fires

startTime - 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)

Returns:

a ScheduledFuture representing pending completion of the task

Throws:

TaskRejectedException - if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

scheduleAtFixedRate

default java.util.concurrent.ScheduledFuture<?> scheduleAtFixedRate(java.lang.Runnable task,
                                                                    java.time.Duration period)

Schedule the given 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.

Parameters:

task - the Runnable to execute whenever the trigger fires

period - the interval between successive executions of the task

Returns:

a ScheduledFuture representing pending completion of the task

Throws:

TaskRejectedException - if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

Since:

5.0

See Also:

scheduleAtFixedRate(Runnable, long)

scheduleAtFixedRate

java.util.concurrent.ScheduledFuture<?> scheduleAtFixedRate(java.lang.Runnable task,
                                                            long period)

Schedule the given 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.

Parameters:

task - the Runnable to execute whenever the trigger fires

period - the interval between successive executions of the task (in milliseconds)

Returns:

a ScheduledFuture representing pending completion of the task

Throws:

TaskRejectedException - if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

scheduleWithFixedDelay

default java.util.concurrent.ScheduledFuture<?> scheduleWithFixedDelay(java.lang.Runnable task,
                                                                       java.time.Instant startTime,
                                                                       java.time.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.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters:

task - the Runnable to execute whenever the trigger fires

startTime - 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

Returns:

a ScheduledFuture representing pending completion of the task

Throws:

TaskRejectedException - if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

Since:

5.0

See Also:

scheduleWithFixedDelay(Runnable, Date, long)

scheduleWithFixedDelay

java.util.concurrent.ScheduledFuture<?> scheduleWithFixedDelay(java.lang.Runnable task,
                                                               java.util.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.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters:

task - the Runnable to execute whenever the trigger fires

startTime - 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)

Returns:

a ScheduledFuture representing pending completion of the task

Throws:

TaskRejectedException - if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

scheduleWithFixedDelay

default java.util.concurrent.ScheduledFuture<?> scheduleWithFixedDelay(java.lang.Runnable task,
                                                                       java.time.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.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters:

task - the Runnable to execute whenever the trigger fires

delay - the delay between the completion of one execution and the start of the next

Returns:

a ScheduledFuture representing pending completion of the task

Throws:

TaskRejectedException - if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

Since:

5.0

See Also:

scheduleWithFixedDelay(Runnable, long)

scheduleWithFixedDelay

java.util.concurrent.ScheduledFuture<?> scheduleWithFixedDelay(java.lang.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.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters:

task - the Runnable to execute whenever the trigger fires

delay - the delay between the completion of one execution and the start of the next (in milliseconds)

Returns:

a ScheduledFuture representing pending completion of the task

Throws:

TaskRejectedException - if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)