クラス 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
- 関連事項:
フィールドのサマリー
フィールドコンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明voidaddCronTask(RunnableSE task, StringSE expression) 指定された cronexpressionごとにトリガーされるRunnableSE タスクを追加します。voidaddCronTask(CronTask task) CronTaskを追加します。voidaddFixedDelayTask(RunnableSE task, long interval) 使用すべきではありません。voidaddFixedDelayTask(RunnableSE task, DurationSE interval) 指定された固定遅延でトリガーされる Runnable タスクを追加します。void固定遅延IntervalTaskを追加します。voidaddFixedRateTask(RunnableSE task, long interval) 使用すべきではありません。6.0 現在、addFixedRateTask(Runnable, Duration)を推奨voidaddFixedRateTask(RunnableSE task, DurationSE interval) 指定された固定レート間隔でトリガーされるRunnableタスクを追加します。voidaddFixedRateTask(IntervalTask task) 固定レートIntervalTaskを追加します。voidaddOneTimeTask(RunnableSE task, DurationSE initialDelay) 指定された初期遅延後に 1 回トリガーされる実行可能タスクを追加します。voidaddOneTimeTask(DelayedTask task) ワンタイムDelayedTaskを追加します。voidaddTriggerTask(RunnableSE task, Trigger trigger) 指定されたTriggerごとにトリガーされる Runnable タスクを追加します。voidaddTriggerTask(TriggerTask task) TriggerTaskを追加します。voidBean 構築時にscheduleTasks()を呼び出します。voiddestroy()Bean の破棄時に、包含BeanFactoryによって呼び出されます。cron タスクを、CronTaskオブジェクトの変更不可能なリストとして取得します。IntervalTaskオブジェクトの変更不可能なリストとして固定遅延タスクを取得します。IntervalTaskオブジェクトの変更不可能なリストとして固定レートタスクを取得します。io.micrometer.observation.ObservationRegistryこのレジストラのObservationRegistryを返します。このレジストラによってスケジュールされたすべてのローカルに登録されたタスクを返します。このレジストラのTaskSchedulerインスタンスを返します(nullの場合があります)。TriggerTaskオブジェクトの変更不可能なリストとしてトリガータスクを取得します。booleanhasTasks()このScheduledTaskRegistrarにタスクが登録されているかどうかを返します。scheduleCronTask(CronTask task) 可能な場合はすぐに、またはスケジューラの初期化時に、指定された cron タスクをスケジュールします。可能な場合はすぐに、またはスケジューラの初期化時に、指定された固定遅延タスクをスケジュールします。可能な場合はすぐに、またはスケジューラの初期化時に、指定された固定レートタスクをスケジュールします。指定された 1 回限りのタスクを、可能であればすぐに、またはスケジューラーの初期化時にスケジュールします。protected void可能な場合はすぐに、またはスケジューラーの初期化時に、指定されたトリガータスクをスケジュールします。voidsetCronTasks(MapSE<RunnableSE, StringSE> cronTasks) トリガーされたタスクを Runnable のマップ(タスク)および cron 式として指定します。voidsetCronTasksList(ListSE<CronTask> cronTasks) CronTaskオブジェクトのリストとしてトリガーされたタスクを指定します。voidsetFixedDelayTasks(MapSE<RunnableSE, LongSE> fixedDelayTasks) トリガーされたタスクを Runnable のマップ(タスク)および固定遅延値として指定します。voidsetFixedDelayTasksList(ListSE<IntervalTask> fixedDelayTasks) 固定遅延タスクをIntervalTaskオブジェクトのリストとして指定します。voidsetFixedRateTasks(MapSE<RunnableSE, LongSE> fixedRateTasks) トリガーされたタスクを Runnables(タスク)および固定レート値のマップとして指定します。voidsetFixedRateTasksList(ListSE<IntervalTask> fixedRateTasks) IntervalTaskオブジェクトのリストとして固定レートタスクを指定します。voidsetObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry) スケジュールされたタスクの観測を記録するようにObservationRegistryを構成します。voidsetScheduler(ObjectSE scheduler) スケジュールされたタスクを登録するようにTaskSchedulerを設定するか、TaskSchedulerとしてラップされるScheduledExecutorServiceSE を設定します。voidsetTaskScheduler(TaskScheduler taskScheduler) TaskSchedulerを設定して、スケジュールされたタスクを登録します。voidsetTriggerTasks(MapSE<RunnableSE, Trigger> triggerTasks) トリガーされたタスクを Runnable のマップ(タスク)およびトリガーオブジェクト(通常、Triggerインターフェースのカスタム実装)として指定します。voidsetTriggerTasksList(ListSE<TriggerTask> triggerTasks) TriggerTaskオブジェクトのリストとしてトリガーされたタスクを指定します。
フィールドの詳細
CRON_DISABLED
無効なトリガーを示す特別な cron 式値: "-"。これは主に、提供された
expressionの値が外部ソースから取得されるときにaddCronTask(Runnable, String)で使用するためのものです — たとえば、Environmentのプロパティから。- 導入:
- 5.2
- 関連事項:
コンストラクターの詳細
ScheduledTaskRegistrar
public ScheduledTaskRegistrar()
メソッドの詳細
setTaskScheduler
TaskSchedulerを設定して、スケジュールされたタスクを登録します。setScheduler
スケジュールされたタスクを登録するようにTaskSchedulerを設定するか、TaskSchedulerとしてラップされるScheduledExecutorServiceSE を設定します。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ごとにトリガーされるRunnableSE タスクを追加します。このメソッドは、
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()インターフェースからコピーされた説明:DisposableBeanBean の破棄時に、包含BeanFactoryによって呼び出されます。- 次で指定:
- インターフェース
DisposableBeanのdestroy
addFixedDelayTask(Runnable, Duration)を推奨