クラス ScheduledTaskRegistrar
java.lang.ObjectSE
org.springframework.scheduling.config.ScheduledTaskRegistrar
- 実装されたすべてのインターフェース:
DisposableBean
、InitializingBean
、ScheduledTaskHolder
- 既知の直属サブクラス
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
- 関連事項:
フィールドサマリー
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明void
addCronTask
(RunnableSE task, StringSE expression) 指定された cronexpression
ごとにトリガーされるRunnable
SE タスクを追加します。void
addCronTask
(CronTask task) CronTask
を追加します。void
addFixedDelayTask
(RunnableSE task, long interval) 使用すべきではありません。void
addFixedDelayTask
(RunnableSE task, DurationSE interval) 指定された固定遅延でトリガーされる Runnable タスクを追加します。void
固定遅延IntervalTask
を追加します。void
addFixedRateTask
(RunnableSE task, long interval) 使用すべきではありません。6.0 現在、addFixedRateTask(Runnable, Duration)
を推奨void
addFixedRateTask
(RunnableSE task, DurationSE interval) 指定された固定レート間隔でトリガーされるRunnable
タスクを追加します。void
addFixedRateTask
(IntervalTask task) 固定レートIntervalTask
を追加します。void
addOneTimeTask
(RunnableSE task, DurationSE initialDelay) 指定された初期遅延後に 1 回トリガーされる実行可能タスクを追加します。void
addOneTimeTask
(DelayedTask task) ワンタイムDelayedTask
を追加します。void
addTriggerTask
(RunnableSE task, Trigger trigger) 指定されたTrigger
ごとにトリガーされる Runnable タスクを追加します。void
addTriggerTask
(TriggerTask task) TriggerTask
を追加します。void
Bean 構築時にscheduleTasks()
を呼び出します。void
destroy()
Bean の破棄時に、包含BeanFactory
によって呼び出されます。cron タスクを、CronTask
オブジェクトの変更不可能なリストとして取得します。IntervalTask
オブジェクトの変更不可能なリストとして固定遅延タスクを取得します。IntervalTask
オブジェクトの変更不可能なリストとして固定レートタスクを取得します。io.micrometer.observation.ObservationRegistry
このレジストラのObservationRegistry
を返します。このレジストラによってスケジュールされたすべてのローカルに登録されたタスクを返します。このレジストラのTaskScheduler
インスタンスを返します(null
の場合があります)。TriggerTask
オブジェクトの変更不可能なリストとしてトリガータスクを取得します。boolean
hasTasks()
このScheduledTaskRegistrar
にタスクが登録されているかどうかを返します。scheduleCronTask
(CronTask task) 可能な場合はすぐに、またはスケジューラの初期化時に、指定された cron タスクをスケジュールします。可能な場合はすぐに、またはスケジューラの初期化時に、指定された固定遅延タスクをスケジュールします。可能な場合はすぐに、またはスケジューラの初期化時に、指定された固定レートタスクをスケジュールします。指定された 1 回限りのタスクを、可能であればすぐに、またはスケジューラーの初期化時にスケジュールします。protected void
可能な場合はすぐに、またはスケジューラーの初期化時に、指定されたトリガータスクをスケジュールします。void
setCronTasks
(MapSE<RunnableSE, StringSE> cronTasks) トリガーされたタスクを Runnable のマップ(タスク)および cron 式として指定します。void
setCronTasksList
(ListSE<CronTask> cronTasks) CronTask
オブジェクトのリストとしてトリガーされたタスクを指定します。void
setFixedDelayTasks
(MapSE<RunnableSE, LongSE> fixedDelayTasks) トリガーされたタスクを Runnable のマップ(タスク)および固定遅延値として指定します。void
setFixedDelayTasksList
(ListSE<IntervalTask> fixedDelayTasks) 固定遅延タスクをIntervalTask
オブジェクトのリストとして指定します。void
setFixedRateTasks
(MapSE<RunnableSE, LongSE> fixedRateTasks) トリガーされたタスクを Runnables(タスク)および固定レート値のマップとして指定します。void
setFixedRateTasksList
(ListSE<IntervalTask> fixedRateTasks) IntervalTask
オブジェクトのリストとして固定レートタスクを指定します。void
setObservationRegistry
(io.micrometer.observation.ObservationRegistry observationRegistry) スケジュールされたタスクの観察を記録するようにObservationRegistry
を構成します。void
setScheduler
(ObjectSE scheduler) スケジュールされたタスクを登録するようにTaskScheduler
を設定するか、TaskScheduler
としてラップされるScheduledExecutorService
SE を設定します。void
setTaskScheduler
(TaskScheduler taskScheduler) TaskScheduler
を設定して、スケジュールされたタスクを登録します。void
setTriggerTasks
(MapSE<RunnableSE, Trigger> triggerTasks) トリガーされたタスクを Runnable のマップ(タスク)およびトリガーオブジェクト(通常、Trigger
インターフェースのカスタム実装)として指定します。void
setTriggerTasksList
(ListSE<TriggerTask> triggerTasks) TriggerTask
オブジェクトのリストとしてトリガーされたタスクを指定します。
フィールドの詳細
CRON_DISABLED
無効なトリガーを示す特別な cron 式値: "-"。これは主に、提供された
expression
の値が外部ソースから取得されるときにaddCronTask(Runnable, String)
で使用するためのものです — たとえば、Environment
のプロパティから。- 導入:
- 5.2
- 関連事項:
コンストラクターの詳細
ScheduledTaskRegistrar
public ScheduledTaskRegistrar()
メソッドの詳細
setTaskScheduler
TaskScheduler
を設定して、スケジュールされたタスクを登録します。setScheduler
スケジュールされたタスクを登録するようにTaskScheduler
を設定するか、TaskScheduler
としてラップされるScheduledExecutorService
SE を設定します。getScheduler
このレジストラのTaskScheduler
インスタンスを返します(null
の場合があります)。setObservationRegistry
public void setObservationRegistry(@Nullable io.micrometer.observation.ObservationRegistry observationRegistry) スケジュールされたタスクの観察を記録するようにObservationRegistry
を構成します。- 導入:
- 6.1
getObservationRegistry
このレジストラのObservationRegistry
を返します。- 導入:
- 6.1
setTriggerTasks
トリガーされたタスクを Runnable のマップ(タスク)およびトリガーオブジェクト(通常、Trigger
インターフェースのカスタム実装)として指定します。setTriggerTasksList
TriggerTask
オブジェクトのリストとしてトリガーされたタスクを指定します。<task:*>
名前空間の解析で主に使用されます。- 導入:
- 3.2
- 関連事項:
getTriggerTaskList
TriggerTask
オブジェクトの変更不可能なリストとしてトリガータスクを取得します。- 戻り値:
- タスクのリスト (非
null
) - 導入:
- 4.2
setCronTasks
トリガーされたタスクを Runnable のマップ(タスク)および cron 式として指定します。- 関連事項:
setCronTasksList
CronTask
オブジェクトのリストとしてトリガーされたタスクを指定します。<task:*>
名前空間の解析で主に使用されます。- 導入:
- 3.2
- 関連事項:
getCronTaskList
cron タスクを、CronTask
オブジェクトの変更不可能なリストとして取得します。- 戻り値:
- タスクのリスト (非
null
) - 導入:
- 4.2
setFixedRateTasks
トリガーされたタスクを Runnables(タスク)および固定レート値のマップとして指定します。setFixedRateTasksList
IntervalTask
オブジェクトのリストとして固定レートタスクを指定します。<task:*>
名前空間の解析で主に使用されます。- 導入:
- 3.2
- 関連事項:
getFixedRateTaskList
IntervalTask
オブジェクトの変更不可能なリストとして固定レートタスクを取得します。- 戻り値:
- タスクのリスト (非
null
) - 導入:
- 4.2
setFixedDelayTasks
トリガーされたタスクを Runnable のマップ(タスク)および固定遅延値として指定します。setFixedDelayTasksList
固定遅延タスクをIntervalTask
オブジェクトのリストとして指定します。<task:*>
名前空間の解析で主に使用されます。- 導入:
- 3.2
- 関連事項:
getFixedDelayTaskList
IntervalTask
オブジェクトの変更不可能なリストとして固定遅延タスクを取得します。- 戻り値:
- タスクのリスト (非
null
) - 導入:
- 4.2
addTriggerTask
指定されたTrigger
ごとにトリガーされる Runnable タスクを追加します。addTriggerTask
TriggerTask
を追加します。addCronTask
指定された cronexpression
ごとにトリガーされるRunnable
SE タスクを追加します。Spring Framework 5.2 では、
expression
がCRON_DISABLED
と等しい場合、このメソッドはタスクを登録しません。addCronTask
CronTask
を追加します。- 導入:
- 3.2
addFixedRateTask
使用すべきではありません。6.0 現在、addFixedRateTask(Runnable, Duration)
を推奨指定された固定レート間隔でトリガーされるRunnable
タスクを追加します。addFixedRateTask
指定された固定レート間隔でトリガーされるRunnable
タスクを追加します。addFixedRateTask
固定レートIntervalTask
を追加します。addFixedDelayTask
使用すべきではありません。6.0 現在、addFixedDelayTask(Runnable, Duration)
を推奨指定された固定遅延でトリガーされる Runnable タスクを追加します。addFixedDelayTask
指定された固定遅延でトリガーされる Runnable タスクを追加します。addFixedDelayTask
固定遅延IntervalTask
を追加します。addOneTimeTask
指定された初期遅延後に 1 回トリガーされる実行可能タスクを追加します。- 導入:
- 6.1
- 関連事項:
addOneTimeTask
ワンタイムDelayedTask
を追加します。hasTasks
public boolean hasTasks()このScheduledTaskRegistrar
にタスクが登録されているかどうかを返します。- 導入:
- 3.2
afterPropertiesSet
public void afterPropertiesSet()Bean 構築時にscheduleTasks()
を呼び出します。- 次で指定:
- インターフェース
InitializingBean
のafterPropertiesSet
scheduleTasks
protected void scheduleTasks()scheduleTriggerTask
可能な場合はすぐに、またはスケジューラーの初期化時に、指定されたトリガータスクをスケジュールします。- 戻り値:
- スケジュールされたタスクのハンドル。キャンセルできます
- 導入:
- 4.3
scheduleCronTask
可能な場合はすぐに、またはスケジューラの初期化時に、指定された cron タスクをスケジュールします。- 戻り値:
- スケジュールされたタスクのハンドル。キャンセルできます (または、以前に登録されたタスクを処理する場合は
null
) - 導入:
- 4.3
scheduleFixedRateTask
可能な場合はすぐに、またはスケジューラの初期化時に、指定された固定レートタスクをスケジュールします。- 戻り値:
- スケジュールされたタスクのハンドル。キャンセルできます (または、以前に登録されたタスクを処理する場合は
null
) - 導入:
- 5.0.2
scheduleFixedDelayTask
可能な場合はすぐに、またはスケジューラの初期化時に、指定された固定遅延タスクをスケジュールします。- 戻り値:
- スケジュールされたタスクのハンドル。キャンセルできます (または、以前に登録されたタスクを処理する場合は
null
) - 導入:
- 5.0.2
scheduleOneTimeTask
指定された 1 回限りのタスクを、可能であればすぐに、またはスケジューラーの初期化時にスケジュールします。- 戻り値:
- スケジュールされたタスクのハンドル。キャンセルできます (または、以前に登録されたタスクを処理する場合は
null
) - 導入:
- 6.1
getScheduledTasks
このレジストラによってスケジュールされたすべてのローカルに登録されたタスクを返します。destroy
public void destroy()インターフェースからコピーされた説明:DisposableBean
Bean の破棄時に、包含BeanFactory
によって呼び出されます。- 次で指定:
- インターフェース
DisposableBean
のdestroy
addFixedDelayTask(Runnable, Duration)
を推奨