クラス ScheduledTaskRegistrar

java.lang.ObjectSE
org.springframework.scheduling.config.ScheduledTaskRegistrar
実装されたすべてのインターフェース:
DisposableBeanInitializingBeanScheduledTaskHolder
既知の直属サブクラス
ContextLifecycleScheduledTaskRegistrar

public class ScheduledTaskRegistrar extends ObjectSE implements ScheduledTaskHolder, InitializingBean, DisposableBean
通常 cron 式を使用して、タスクを TaskScheduler に登録するためのヘルパー Bean。

ScheduledTaskRegistrar は、@EnableAsync アノテーションおよびその SchedulingConfigurer コールバックインターフェースと組み合わせて使用すると、より顕著なユーザー向けのロールを果たします。

導入:
3.0
作成者:
Juergen Hoeller, Chris Beams, Tobias Montagna-Hay, Sam Brannen, Arjen Poutsma, Brian Clozel
関連事項:
  • フィールドの詳細

  • コンストラクターの詳細

    • ScheduledTaskRegistrar

      public ScheduledTaskRegistrar()
  • メソッドの詳細

    • setTaskScheduler

      public void setTaskScheduler(TaskScheduler taskScheduler)
      TaskScheduler を設定して、スケジュールされたタスクを登録します。
    • setScheduler

      public void setScheduler(@Nullable ObjectSE scheduler)
      スケジュールされたタスクを登録するように TaskScheduler を設定するか、TaskScheduler としてラップされる ScheduledExecutorServiceSE を設定します。
    • getScheduler

      @Nullable public TaskScheduler getScheduler()
      このレジストラの TaskScheduler インスタンスを返します(null の場合があります)。
    • setObservationRegistry

      public void setObservationRegistry(@Nullable io.micrometer.observation.ObservationRegistry observationRegistry)
      スケジュールされたタスクの観察を記録するように ObservationRegistry を構成します。
      導入:
      6.1
    • getObservationRegistry

      @Nullable public io.micrometer.observation.ObservationRegistry getObservationRegistry()
      このレジストラの ObservationRegistry を返します。
      導入:
      6.1
    • setTriggerTasks

      public void setTriggerTasks(MapSE<RunnableSE,Trigger> triggerTasks)
      トリガーされたタスクを Runnable のマップ(タスク)およびトリガーオブジェクト(通常、Trigger インターフェースのカスタム実装)として指定します。
    • setTriggerTasksList

      public void setTriggerTasksList(ListSE<TriggerTask> triggerTasks)
      TriggerTask オブジェクトのリストとしてトリガーされたタスクを指定します。<task:*> 名前空間の解析で主に使用されます。
      導入:
      3.2
      関連事項:
    • getTriggerTaskList

      public ListSE<TriggerTask> getTriggerTaskList()
      TriggerTask オブジェクトの変更不可能なリストとしてトリガータスクを取得します。
      戻り値:
      タスクのリスト (非 null)
      導入:
      4.2
    • setCronTasks

      public void setCronTasks(MapSE<RunnableSE,StringSE> cronTasks)
      トリガーされたタスクを Runnable のマップ(タスク)および cron 式として指定します。
      関連事項:
    • setCronTasksList

      public void setCronTasksList(ListSE<CronTask> cronTasks)
      CronTask オブジェクトのリストとしてトリガーされたタスクを指定します。<task:*> 名前空間の解析で主に使用されます。
      導入:
      3.2
      関連事項:
    • getCronTaskList

      public ListSE<CronTask> getCronTaskList()
      cron タスクを、CronTask オブジェクトの変更不可能なリストとして取得します。
      戻り値:
      タスクのリスト (非 null)
      導入:
      4.2
    • setFixedRateTasks

      public void setFixedRateTasks(MapSE<RunnableSE,LongSE> fixedRateTasks)
      トリガーされたタスクを Runnables(タスク)および固定レート値のマップとして指定します。
      関連事項:
    • setFixedRateTasksList

      public void setFixedRateTasksList(ListSE<IntervalTask> fixedRateTasks)
      IntervalTask オブジェクトのリストとして固定レートタスクを指定します。<task:*> 名前空間の解析で主に使用されます。
      導入:
      3.2
      関連事項:
    • getFixedRateTaskList

      public ListSE<IntervalTask> getFixedRateTaskList()
      IntervalTask オブジェクトの変更不可能なリストとして固定レートタスクを取得します。
      戻り値:
      タスクのリスト (非 null)
      導入:
      4.2
    • setFixedDelayTasks

      public void setFixedDelayTasks(MapSE<RunnableSE,LongSE> fixedDelayTasks)
      トリガーされたタスクを Runnable のマップ(タスク)および固定遅延値として指定します。
      関連事項:
    • setFixedDelayTasksList

      public void setFixedDelayTasksList(ListSE<IntervalTask> fixedDelayTasks)
      固定遅延タスクを IntervalTask オブジェクトのリストとして指定します。<task:*> 名前空間の解析で主に使用されます。
      導入:
      3.2
      関連事項:
    • getFixedDelayTaskList

      public ListSE<IntervalTask> getFixedDelayTaskList()
      IntervalTask オブジェクトの変更不可能なリストとして固定遅延タスクを取得します。
      戻り値:
      タスクのリスト (非 null)
      導入:
      4.2
    • addTriggerTask

      public void addTriggerTask(RunnableSE task, Trigger trigger)
      指定された Trigger ごとにトリガーされる Runnable タスクを追加します。
      関連事項:
    • addTriggerTask

      public void addTriggerTask(TriggerTask task)
      TriggerTask を追加します。
      導入:
      3.2
      関連事項:
    • addCronTask

      public void addCronTask(RunnableSE task, StringSE expression)
      指定された cron expression ごとにトリガーされる RunnableSE タスクを追加します。

      Spring Framework 5.2 では、expression が CRON_DISABLED と等しい場合、このメソッドはタスクを登録しません。

    • addCronTask

      public void addCronTask(CronTask task)
      CronTask を追加します。
      導入:
      3.2
    • addFixedRateTask

      @DeprecatedSE(since="6.0") public void addFixedRateTask(RunnableSE task, long interval)
      使用すべきではありません。
      6.0 現在、addFixedRateTask(Runnable, Duration) を推奨
      指定された固定レート間隔でトリガーされる Runnable タスクを追加します。
    • addFixedRateTask

      public void addFixedRateTask(RunnableSE task, DurationSE interval)
      指定された固定レート間隔でトリガーされる Runnable タスクを追加します。
      導入:
      6.0
      関連事項:
    • addFixedRateTask

      public void addFixedRateTask(IntervalTask task)
      固定レート IntervalTask を追加します。
      導入:
      3.2
      関連事項:
    • addFixedDelayTask

      @DeprecatedSE(since="6.0") public void addFixedDelayTask(RunnableSE task, long interval)
      使用すべきではありません。
      指定された固定遅延でトリガーされる Runnable タスクを追加します。
    • addFixedDelayTask

      public void addFixedDelayTask(RunnableSE task, DurationSE interval)
      指定された固定遅延でトリガーされる Runnable タスクを追加します。
      導入:
      6.0
      関連事項:
    • addFixedDelayTask

      public void addFixedDelayTask(IntervalTask task)
      固定遅延 IntervalTask を追加します。
      導入:
      3.2
      関連事項:
    • addOneTimeTask

      public void addOneTimeTask(RunnableSE task, DurationSE initialDelay)
      指定された初期遅延後に 1 回トリガーされる実行可能タスクを追加します。
      導入:
      6.1
      関連事項:
    • addOneTimeTask

      public void addOneTimeTask(DelayedTask task)
      ワンタイム DelayedTask を追加します。
      導入:
      6.1
      関連事項:
    • hasTasks

      public boolean hasTasks()
      この ScheduledTaskRegistrar にタスクが登録されているかどうかを返します。
      導入:
      3.2
    • afterPropertiesSet

      public void afterPropertiesSet()
      Bean 構築時に scheduleTasks() を呼び出します。
      次で指定:
      インターフェース InitializingBeanafterPropertiesSet 
    • scheduleTasks

      protected void scheduleTasks()
      基礎となるタスクスケジューラに対してすべての登録済みタスクをスケジュールします。
    • scheduleTriggerTask

      @Nullable public ScheduledTask scheduleTriggerTask(TriggerTask task)
      可能な場合はすぐに、またはスケジューラーの初期化時に、指定されたトリガータスクをスケジュールします。
      戻り値:
      スケジュールされたタスクのハンドル。キャンセルできます
      導入:
      4.3
    • scheduleCronTask

      @Nullable public ScheduledTask scheduleCronTask(CronTask task)
      可能な場合はすぐに、またはスケジューラの初期化時に、指定された cron タスクをスケジュールします。
      戻り値:
      スケジュールされたタスクのハンドル。キャンセルできます (または、以前に登録されたタスクを処理する場合は null )
      導入:
      4.3
    • scheduleFixedRateTask

      @Nullable public ScheduledTask scheduleFixedRateTask(FixedRateTask task)
      可能な場合はすぐに、またはスケジューラの初期化時に、指定された固定レートタスクをスケジュールします。
      戻り値:
      スケジュールされたタスクのハンドル。キャンセルできます (または、以前に登録されたタスクを処理する場合は null )
      導入:
      5.0.2
    • scheduleFixedDelayTask

      @Nullable public ScheduledTask scheduleFixedDelayTask(FixedDelayTask task)
      可能な場合はすぐに、またはスケジューラの初期化時に、指定された固定遅延タスクをスケジュールします。
      戻り値:
      スケジュールされたタスクのハンドル。キャンセルできます (または、以前に登録されたタスクを処理する場合は null )
      導入:
      5.0.2
    • scheduleOneTimeTask

      @Nullable public ScheduledTask scheduleOneTimeTask(OneTimeTask task)
      指定された 1 回限りのタスクを、可能であればすぐに、またはスケジューラーの初期化時にスケジュールします。
      戻り値:
      スケジュールされたタスクのハンドル。キャンセルできます (または、以前に登録されたタスクを処理する場合は null )
      導入:
      6.1
    • getScheduledTasks

      public SetSE<ScheduledTask> getScheduledTasks()
      このレジストラによってスケジュールされたすべてのローカルに登録されたタスクを返します。
      次で指定:
      インターフェース ScheduledTaskHoldergetScheduledTasks 
      導入:
      5.0.2
      関連事項:
    • destroy

      public void destroy()
      インターフェースからコピーされた説明: DisposableBean
      Bean の破棄時に、包含 BeanFactory によって呼び出されます。
      次で指定:
      インターフェース DisposableBeandestroy