Class ScheduledTaskRegistrar

Field Detail

• CRON_DISABLED

  public static final String CRON_DISABLED

  A special cron expression value that indicates a disabled trigger: "-".

  This is primarily meant for use with addCronTask(Runnable, String) when the value for the supplied expression is retrieved from an external source — for example, from a property in the Environment.

  Since:

  5.2

  See Also:

  Scheduled.CRON_DISABLED, Constant Field Values

Constructor Detail

• ScheduledTaskRegistrar

  public ScheduledTaskRegistrar()

Method Detail

• setTaskScheduler

  public void setTaskScheduler​(TaskScheduler taskScheduler)

  Set the TaskScheduler to register scheduled tasks with.

• setScheduler

  public void setScheduler​(@Nullable
                           Object scheduler)

  Set the TaskScheduler to register scheduled tasks with, or a ScheduledExecutorService to be wrapped as a TaskScheduler.

• getScheduler

  @Nullable
  public TaskScheduler getScheduler()

  Return the TaskScheduler instance for this registrar (may be null).

• setTriggerTasks

  public void setTriggerTasks​(Map<Runnable,​Trigger> triggerTasks)

  Specify triggered tasks as a Map of Runnables (the tasks) and Trigger objects (typically custom implementations of the Trigger interface).

• setTriggerTasksList

  public void setTriggerTasksList​(List<TriggerTask> triggerTasks)

  Specify triggered tasks as a list of TriggerTask objects. Primarily used by <task:*> namespace parsing.

  Since:

  3.2

  See Also:

  ScheduledTasksBeanDefinitionParser

• getTriggerTaskList

  public List<TriggerTask> getTriggerTaskList()

  Get the trigger tasks as an unmodifiable list of TriggerTask objects.

  Returns:

  the list of tasks (never null)

  Since:

  4.2

• setCronTasks

  public void setCronTasks​(Map<Runnable,​String> cronTasks)

  Specify triggered tasks as a Map of Runnables (the tasks) and cron expressions.

  See Also:

  CronTrigger

• setCronTasksList

  public void setCronTasksList​(List<CronTask> cronTasks)

  Specify triggered tasks as a list of CronTask objects. Primarily used by <task:*> namespace parsing.

  Since:

  3.2

  See Also:

  ScheduledTasksBeanDefinitionParser

• getCronTaskList

  public List<CronTask> getCronTaskList()

  Get the cron tasks as an unmodifiable list of CronTask objects.

  Returns:

  the list of tasks (never null)

  Since:

  4.2

• setFixedRateTasks

  public void setFixedRateTasks​(Map<Runnable,​Long> fixedRateTasks)

  Specify triggered tasks as a Map of Runnables (the tasks) and fixed-rate values.

  See Also:

  TaskScheduler.scheduleAtFixedRate(Runnable, long)

• setFixedRateTasksList

  public void setFixedRateTasksList​(List<IntervalTask> fixedRateTasks)

  Specify fixed-rate tasks as a list of IntervalTask objects. Primarily used by <task:*> namespace parsing.

  Since:

  3.2

  See Also:

  ScheduledTasksBeanDefinitionParser

• getFixedRateTaskList

  public List<IntervalTask> getFixedRateTaskList()

  Get the fixed-rate tasks as an unmodifiable list of IntervalTask objects.

  Returns:

  the list of tasks (never null)

  Since:

  4.2

• setFixedDelayTasks

  public void setFixedDelayTasks​(Map<Runnable,​Long> fixedDelayTasks)

  Specify triggered tasks as a Map of Runnables (the tasks) and fixed-delay values.

  See Also:

  TaskScheduler.scheduleWithFixedDelay(Runnable, long)

• setFixedDelayTasksList

  public void setFixedDelayTasksList​(List<IntervalTask> fixedDelayTasks)

  Specify fixed-delay tasks as a list of IntervalTask objects. Primarily used by <task:*> namespace parsing.

  Since:

  3.2

  See Also:

  ScheduledTasksBeanDefinitionParser

• getFixedDelayTaskList

  public List<IntervalTask> getFixedDelayTaskList()

  Get the fixed-delay tasks as an unmodifiable list of IntervalTask objects.

  Returns:

  the list of tasks (never null)

  Since:

  4.2

• addTriggerTask

  public void addTriggerTask​(Runnable task,
                             Trigger trigger)

  Add a Runnable task to be triggered per the given Trigger.

  See Also:

  TaskScheduler.scheduleAtFixedRate(Runnable, long)

• addTriggerTask

  public void addTriggerTask​(TriggerTask task)

  Add a TriggerTask.

  Since:

  3.2

  See Also:

  TaskScheduler.scheduleAtFixedRate(Runnable, long)

• addCronTask

  public void addCronTask​(Runnable task,
                          String expression)

  Add a Runnable task to be triggered per the given cron expression.

  As of Spring Framework 5.2, this method will not register the task if the expression is equal to CRON_DISABLED.

• addCronTask

  public void addCronTask​(CronTask task)

  Add a CronTask.

  Since:

  3.2

• addFixedRateTask

  public void addFixedRateTask​(Runnable task,
                               long interval)

  Add a Runnable task to be triggered at the given fixed-rate interval.

  See Also:

  TaskScheduler.scheduleAtFixedRate(Runnable, long)

• addFixedRateTask

  public void addFixedRateTask​(IntervalTask task)

  Add a fixed-rate IntervalTask.

  Since:

  3.2

  See Also:

  TaskScheduler.scheduleAtFixedRate(Runnable, long)

• addFixedDelayTask

  public void addFixedDelayTask​(Runnable task,
                                long delay)

  Add a Runnable task to be triggered with the given fixed delay.

  See Also:

  TaskScheduler.scheduleWithFixedDelay(Runnable, long)

• addFixedDelayTask

  public void addFixedDelayTask​(IntervalTask task)

  Add a fixed-delay IntervalTask.

  Since:

  3.2

  See Also:

  TaskScheduler.scheduleWithFixedDelay(Runnable, long)

• hasTasks

  public boolean hasTasks()

  Return whether this ScheduledTaskRegistrar has any tasks registered.

  Since:

  3.2

• afterPropertiesSet

  public void afterPropertiesSet()

  Calls scheduleTasks() at bean construction time.

  Specified by:

  afterPropertiesSet in interface InitializingBean

• scheduleTasks

  protected void scheduleTasks()

  Schedule all registered tasks against the underlying task scheduler.

• scheduleTriggerTask

  @Nullable
  public ScheduledTask scheduleTriggerTask​(TriggerTask task)

  Schedule the specified trigger task, either right away if possible or on initialization of the scheduler.

  Returns:

  a handle to the scheduled task, allowing to cancel it

  Since:

  4.3

• scheduleCronTask

  @Nullable
  public ScheduledTask scheduleCronTask​(CronTask task)

  Schedule the specified cron task, either right away if possible or on initialization of the scheduler.

  Returns:

  a handle to the scheduled task, allowing to cancel it (or null if processing a previously registered task)

  Since:

  4.3

• scheduleFixedRateTask

  @Deprecated
  @Nullable
  public ScheduledTask scheduleFixedRateTask​(IntervalTask task)

  Deprecated.

  as of 5.0.2, in favor of scheduleFixedRateTask(FixedRateTask)
  Schedule the specified fixed-rate task, either right away if possible or on initialization of the scheduler.

  Returns:

  a handle to the scheduled task, allowing to cancel it (or null if processing a previously registered task)

  Since:

  4.3

• scheduleFixedRateTask

  @Nullable
  public ScheduledTask scheduleFixedRateTask​(FixedRateTask task)

  Schedule the specified fixed-rate task, either right away if possible or on initialization of the scheduler.

  Returns:

  a handle to the scheduled task, allowing to cancel it (or null if processing a previously registered task)

  Since:

  5.0.2

• scheduleFixedDelayTask

  @Deprecated
  @Nullable
  public ScheduledTask scheduleFixedDelayTask​(IntervalTask task)

  Deprecated.

  as of 5.0.2, in favor of scheduleFixedDelayTask(FixedDelayTask)
  Schedule the specified fixed-delay task, either right away if possible or on initialization of the scheduler.

  Returns:

  a handle to the scheduled task, allowing to cancel it (or null if processing a previously registered task)

  Since:

  4.3

• scheduleFixedDelayTask

  @Nullable
  public ScheduledTask scheduleFixedDelayTask​(FixedDelayTask task)

  Schedule the specified fixed-delay task, either right away if possible or on initialization of the scheduler.

  Returns:

  a handle to the scheduled task, allowing to cancel it (or null if processing a previously registered task)

  Since:

  5.0.2

• getScheduledTasks

  public Set<ScheduledTask> getScheduledTasks()

  Return all locally registered tasks that have been scheduled by this registrar.

  Specified by:

  getScheduledTasks in interface ScheduledTaskHolder

  Since:

  5.0.2

  See Also:

  addTriggerTask(java.lang.Runnable, org.springframework.scheduling.Trigger), addCronTask(java.lang.Runnable, java.lang.String), addFixedRateTask(java.lang.Runnable, long), addFixedDelayTask(java.lang.Runnable, long)

• destroy

  public void destroy()

  Description copied from interface: DisposableBean
  Invoked by the containing BeanFactory on destruction of a bean.

  Specified by:

  destroy in interface DisposableBean