public class ConcurrentTaskScheduler extends ConcurrentTaskExecutor implements TaskScheduler
java.util.concurrent.ScheduledExecutorService
and
exposes a Spring TaskScheduler
for it.
Extends ConcurrentTaskExecutor
in order to implement the
SchedulingTaskExecutor
interface as well.
Autodetects a JSR-236 ManagedScheduledExecutorService
in order to use it for trigger-based scheduling if possible, instead of Spring's
local trigger management which ends up delegating to regular delay-based scheduling
against the java.util.concurrent.ScheduledExecutorService
API. For JSR-236 style
lookup in a Java EE 7 environment, consider using DefaultManagedTaskScheduler
.
Note that there is a pre-built ThreadPoolTaskScheduler
that allows for
defining a ScheduledThreadPoolExecutor
in bean style,
exposing it as a Spring TaskScheduler
directly.
This is a convenient alternative to a raw ScheduledThreadPoolExecutor definition with
a separate definition of the present adapter class.
ScheduledExecutorService
,
ScheduledThreadPoolExecutor
,
Executors
,
DefaultManagedTaskScheduler
,
ThreadPoolTaskScheduler
ConcurrentTaskExecutor.ManagedTaskBuilder
TIMEOUT_IMMEDIATE, TIMEOUT_INDEFINITE
Constructor and Description |
---|
ConcurrentTaskScheduler()
Create a new ConcurrentTaskScheduler,
using a single thread executor as default.
|
ConcurrentTaskScheduler(Executor concurrentExecutor,
ScheduledExecutorService scheduledExecutor)
Create a new ConcurrentTaskScheduler, using the given
Executor
and ScheduledExecutorService as delegates. |
ConcurrentTaskScheduler(ScheduledExecutorService scheduledExecutor)
Create a new ConcurrentTaskScheduler, using the given
ScheduledExecutorService as shared delegate. |
Modifier and Type | Method and Description |
---|---|
ScheduledFuture<?> |
schedule(Runnable task,
Date 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. |
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. |
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. |
void |
setErrorHandler(ErrorHandler errorHandler)
Provide an
ErrorHandler strategy. |
void |
setScheduledExecutor(ScheduledExecutorService scheduledExecutor)
Specify the
ScheduledExecutorService to delegate to. |
execute, execute, getConcurrentExecutor, setConcurrentExecutor, setTaskDecorator, submit, submit, submitListenable, submitListenable
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
schedule, scheduleAtFixedRate, scheduleAtFixedRate, scheduleWithFixedDelay, scheduleWithFixedDelay
prefersShortLivedTasks
public ConcurrentTaskScheduler()
public ConcurrentTaskScheduler(ScheduledExecutorService scheduledExecutor)
ScheduledExecutorService
as shared delegate.
Autodetects a JSR-236 ManagedScheduledExecutorService
in order to use it for trigger-based scheduling if possible,
instead of Spring's local trigger management.
scheduledExecutor
- the ScheduledExecutorService
to delegate to for SchedulingTaskExecutor
as well as TaskScheduler
invocationspublic ConcurrentTaskScheduler(Executor concurrentExecutor, ScheduledExecutorService scheduledExecutor)
Executor
and ScheduledExecutorService
as delegates.
Autodetects a JSR-236 ManagedScheduledExecutorService
in order to use it for trigger-based scheduling if possible,
instead of Spring's local trigger management.
concurrentExecutor
- the Executor
to delegate to
for SchedulingTaskExecutor
invocationsscheduledExecutor
- the ScheduledExecutorService
to delegate to for TaskScheduler
invocationspublic void setScheduledExecutor(@Nullable ScheduledExecutorService scheduledExecutor)
ScheduledExecutorService
to delegate to.
Autodetects a JSR-236 ManagedScheduledExecutorService
in order to use it for trigger-based scheduling if possible,
instead of Spring's local trigger management.
Note: This will only apply to TaskScheduler
invocations.
If you want the given executor to apply to
SchedulingTaskExecutor
invocations
as well, pass the same executor reference to ConcurrentTaskExecutor.setConcurrentExecutor(java.util.concurrent.Executor)
.
public void setErrorHandler(ErrorHandler errorHandler)
ErrorHandler
strategy.@Nullable public ScheduledFuture<?> schedule(Runnable task, Trigger trigger)
TaskScheduler
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.
schedule
in interface TaskScheduler
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)
)CronTrigger
public ScheduledFuture<?> schedule(Runnable task, Date startTime)
TaskScheduler
Runnable
, invoking it at the specified execution time.
Execution will end once the scheduler shuts down or the returned
ScheduledFuture
gets cancelled.
schedule
in interface TaskScheduler
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 taskpublic ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Date startTime, long period)
TaskScheduler
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.
scheduleAtFixedRate
in interface TaskScheduler
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 taskpublic ScheduledFuture<?> scheduleAtFixedRate(Runnable task, long period)
TaskScheduler
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.
scheduleAtFixedRate
in interface TaskScheduler
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 taskpublic ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Date startTime, long delay)
TaskScheduler
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.
scheduleWithFixedDelay
in interface TaskScheduler
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 taskpublic ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, long delay)
TaskScheduler
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.
scheduleWithFixedDelay
in interface TaskScheduler
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 task