|
spring-context | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.springframework.scheduling.config.ScheduledTaskRegistrar
public class ScheduledTaskRegistrar
Helper bean for registering tasks with a TaskScheduler, typically using cron
expressions.
As of Spring 3.1, ScheduledTaskRegistrar has a more prominent user-facing
role when used in conjunction with the @EnableAsync annotation and its
SchedulingConfigurer callback interface.
EnableAsync,
SchedulingConfigurer| Constructor Summary | |
|---|---|
ScheduledTaskRegistrar()
|
|
| Method Summary | |
|---|---|
void |
addCronTask(CronTask task)
Add a CronTask. |
void |
addCronTask(java.lang.Runnable task,
java.lang.String expression)
Add a Runnable task to be triggered per the given cron expression |
void |
addFixedDelayTask(IntervalTask task)
Add a fixed-delay IntervalTask. |
void |
addFixedDelayTask(java.lang.Runnable task,
long delay)
Add a Runnable task to be triggered with the given fixed delay. |
void |
addFixedRateTask(IntervalTask task)
Add a fixed-rate IntervalTask. |
void |
addFixedRateTask(java.lang.Runnable task,
long period)
Add a Runnable task to be triggered at the given fixed-rate period. |
void |
addTriggerTask(java.lang.Runnable task,
Trigger trigger)
Add a Runnable task to be triggered per the given Trigger. |
void |
addTriggerTask(TriggerTask task)
Add a TriggerTask. |
void |
afterPropertiesSet()
Schedule all registered tasks against the underlying {@linkplain #setTaskScheduler(TaskScheduler) task scheduler. |
void |
destroy()
|
TaskScheduler |
getScheduler()
Return the TaskScheduler instance for this registrar (may be null). |
boolean |
hasTasks()
Return whether this ScheduledTaskRegistrar has any tasks registered. |
void |
setCronTasks(java.util.Map<java.lang.Runnable,java.lang.String> cronTasks)
Specify triggered tasks as a Map of Runnables (the tasks) and cron expressions. |
void |
setCronTasksList(java.util.List<CronTask> cronTasks)
Specify triggered tasks as a list of CronTask objects. |
void |
setFixedDelayTasks(java.util.Map<java.lang.Runnable,java.lang.Long> fixedDelayTasks)
Specify triggered tasks as a Map of Runnables (the tasks) and fixed-delay values. |
void |
setFixedDelayTasksList(java.util.List<IntervalTask> fixedDelayTasks)
Specify fixed-delay tasks as a list of IntervalTask objects. |
void |
setFixedRateTasks(java.util.Map<java.lang.Runnable,java.lang.Long> fixedRateTasks)
Specify triggered tasks as a Map of Runnables (the tasks) and fixed-rate values. |
void |
setFixedRateTasksList(java.util.List<IntervalTask> fixedRateTasks)
Specify fixed-rate tasks as a list of IntervalTask objects. |
void |
setScheduler(java.lang.Object scheduler)
Set the TaskScheduler to register scheduled tasks with, or a
ScheduledExecutorService to be wrapped as a
TaskScheduler. |
void |
setTaskScheduler(TaskScheduler taskScheduler)
Set the TaskScheduler to register scheduled tasks with. |
void |
setTriggerTasks(java.util.Map<java.lang.Runnable,Trigger> triggerTasks)
Specify triggered tasks as a Map of Runnables (the tasks) and Trigger objects (typically custom implementations of the Trigger interface). |
void |
setTriggerTasksList(java.util.List<TriggerTask> triggerTasks)
Specify triggered tasks as a list of TriggerTask objects. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ScheduledTaskRegistrar()
| Method Detail |
|---|
public void setTaskScheduler(TaskScheduler taskScheduler)
TaskScheduler to register scheduled tasks with.
public void setScheduler(java.lang.Object scheduler)
TaskScheduler to register scheduled tasks with, or a
ScheduledExecutorService to be wrapped as a
TaskScheduler.
public TaskScheduler getScheduler()
TaskScheduler instance for this registrar (may be null).
public void setTriggerTasks(java.util.Map<java.lang.Runnable,Trigger> triggerTasks)
Trigger interface).
public void setTriggerTasksList(java.util.List<TriggerTask> triggerTasks)
TriggerTask objects. Primarily used
by <task:*> namespace parsing.
ScheduledTasksBeanDefinitionParserpublic void setCronTasks(java.util.Map<java.lang.Runnable,java.lang.String> cronTasks)
CronTriggerpublic void setCronTasksList(java.util.List<CronTask> cronTasks)
CronTask objects. Primarily used by
<task:*> namespace parsing.
ScheduledTasksBeanDefinitionParserpublic void setFixedRateTasks(java.util.Map<java.lang.Runnable,java.lang.Long> fixedRateTasks)
TaskScheduler.scheduleAtFixedRate(Runnable, long)public void setFixedRateTasksList(java.util.List<IntervalTask> fixedRateTasks)
IntervalTask objects. Primarily used
by <task:*> namespace parsing.
ScheduledTasksBeanDefinitionParserpublic void setFixedDelayTasks(java.util.Map<java.lang.Runnable,java.lang.Long> fixedDelayTasks)
TaskScheduler.scheduleWithFixedDelay(Runnable, long)public void setFixedDelayTasksList(java.util.List<IntervalTask> fixedDelayTasks)
IntervalTask objects. Primarily used
by <task:*> namespace parsing.
ScheduledTasksBeanDefinitionParser
public void addTriggerTask(java.lang.Runnable task,
Trigger trigger)
Trigger.
TaskScheduler.scheduleAtFixedRate(Runnable, long)public void addTriggerTask(TriggerTask task)
TriggerTask.
TaskScheduler.scheduleAtFixedRate(Runnable, long)
public void addCronTask(java.lang.Runnable task,
java.lang.String expression)
public void addCronTask(CronTask task)
CronTask.
public void addFixedRateTask(java.lang.Runnable task,
long period)
TaskScheduler.scheduleAtFixedRate(Runnable, long)public void addFixedRateTask(IntervalTask task)
IntervalTask.
TaskScheduler.scheduleAtFixedRate(Runnable, long)
public void addFixedDelayTask(java.lang.Runnable task,
long delay)
TaskScheduler.scheduleWithFixedDelay(Runnable, long)public void addFixedDelayTask(IntervalTask task)
IntervalTask.
TaskScheduler.scheduleWithFixedDelay(Runnable, long)public boolean hasTasks()
ScheduledTaskRegistrar has any tasks registered.
public void afterPropertiesSet()
afterPropertiesSet in interface org.springframework.beans.factory.InitializingBeanpublic void destroy()
destroy in interface org.springframework.beans.factory.DisposableBean
|
spring-context | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||