パッケージ org.springframework.scheduling

インターフェース TaskScheduler

すべての既知の実装クラス:
ConcurrentTaskScheduler、DefaultManagedTaskScheduler、NoOpTaskScheduler、SimpleAsyncTaskScheduler、TaskSchedulerRouter、ThreadPoolTaskScheduler
public interface TaskScheduler
さまざまな種類のトリガーに基づいて RunnablesSE のスケジューリングを抽象化するタスクスケジューラインターフェース。

このインターフェースは通常、異なる種類のバックエンド (つまり、異なる特性と機能を持つスレッドプール) を表すため、SchedulingTaskExecutor とは別のものです。両方の種類の実行特性を処理できる場合、実装は両方のインターフェースを実装できます。

'default' 実装は ThreadPoolTaskScheduler であり、ネイティブ ScheduledExecutorServiceSE をラップし、拡張トリガー機能を追加します。

このインターフェースは、Jakarta EE 環境でサポートされている JSR-236 ManagedScheduledExecutorService とほぼ同等ですが、Spring の TaskExecutor モデルと整合しています。

導入:
3.0
作成者:
Juergen Hoeller
関連事項:

  • メソッドの詳細

    • getClock

      default ClockSE getClock()
      スケジューリングの目的で使用する監視を返します。
      導入:
      5.3
      関連事項:

    • schedule

      @Nullable ScheduledFutureSE<?> schedule(RunnableSE task, Trigger trigger)
      指定された RunnableSE をスケジュールし、トリガーが次の実行時間を示すたびに呼び出します。

      スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

      パラメーター:
      task - トリガーが起動するたびに実行する Runnable
      trigger - Trigger インターフェースの実装。cron 式をラップする CronTrigger オブジェクト
      戻り値:
      タスクの実行保留を表す ScheduledFutureSE、または指定されたトリガーオブジェクトが決して起動しない場合は null (つまり、Trigger.nextExecution(org.springframework.scheduling.TriggerContext) から null を返します)
      例外:
      TaskRejectedException - 特定のタスクが内部的な理由で受け入れられなかった場合 (たとえばプールのオーバーロード処理ポリシーまたは進行中のプールのシャットダウン)
      関連事項:

    • schedule

      ScheduledFutureSE<?> schedule(RunnableSE task, InstantSE startTime)
      指定された RunnableSE をスケジュールし、指定された実行時間に呼び出します。

      スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

      パラメーター:
      task - トリガーが起動するたびに実行する Runnable
      startTime - タスクの望ましい実行時間 (これが過去の場合、タスクはすぐに、つまりできるだけ早く実行されます)
      戻り値:
      タスクの保留中の実行を表す ScheduledFutureSE
      例外:
      TaskRejectedException - 特定のタスクが内部的な理由で受け入れられなかった場合 (たとえばプールのオーバーロード処理ポリシーまたは進行中のプールのシャットダウン)
      導入:
      5.0

    • schedule

      @DeprecatedSE(since="6.0") default ScheduledFutureSE<?> schedule(RunnableSE task, DateSE startTime)
      使用すべきではありません。
      6.0 現在、schedule(Runnable, Instant) を推奨
      指定された RunnableSE をスケジュールし、指定された実行時間に呼び出します。

      スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

      パラメーター:
      task - トリガーが起動するたびに実行する Runnable
      startTime - タスクの望ましい実行時間 (これが過去の場合、タスクはすぐに、つまりできるだけ早く実行されます)
      戻り値:
      タスクの保留中の実行を表す ScheduledFutureSE
      例外:
      TaskRejectedException - 特定のタスクが内部的な理由で受け入れられなかった場合 (たとえばプールのオーバーロード処理ポリシーまたは進行中のプールのシャットダウン)

    • scheduleAtFixedRate

      ScheduledFutureSE<?> scheduleAtFixedRate(RunnableSE task, InstantSE startTime, DurationSE period)
      指定された RunnableSE をスケジュールし、指定された実行時間に呼び出し、その後、指定された期間で呼び出します。

      スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

      パラメーター:
      task - トリガーが起動するたびに実行する Runnable
      startTime - タスクに必要な最初の実行時間 (これが過去の場合、タスクはすぐに、つまりできるだけ早く実行されます)
      period - タスクの連続した実行の間隔
      戻り値:
      タスクの保留中の実行を表す ScheduledFutureSE
      例外:
      TaskRejectedException - 特定のタスクが内部的な理由で受け入れられなかった場合 (たとえばプールのオーバーロード処理ポリシーまたは進行中のプールのシャットダウン)
      導入:
      5.0

    • scheduleAtFixedRate

      @DeprecatedSE(since="6.0") default ScheduledFutureSE<?> scheduleAtFixedRate(RunnableSE task, DateSE startTime, long period)
      使用すべきではありません。
      6.0 現在、scheduleAtFixedRate(Runnable, Instant, Duration) を推奨
      指定された RunnableSE をスケジュールし、指定された実行時間に呼び出し、その後、指定された期間で呼び出します。

      スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

      パラメーター:
      task - トリガーが起動するたびに実行する Runnable
      startTime - タスクに必要な最初の実行時間 (これが過去の場合、タスクはすぐに、つまりできるだけ早く実行されます)
      period - タスクの連続した実行の間隔 (ミリ秒単位)
      戻り値:
      タスクの保留中の実行を表す ScheduledFutureSE
      例外:
      TaskRejectedException - 特定のタスクが内部的な理由で受け入れられなかった場合 (たとえばプールのオーバーロード処理ポリシーまたは進行中のプールのシャットダウン)

    • scheduleAtFixedRate

      ScheduledFutureSE<?> scheduleAtFixedRate(RunnableSE task, DurationSE period)
      指定された RunnableSE をスケジュールします。できるだけ早く開始し、指定された期間で呼び出します。

      スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

      パラメーター:
      task - トリガーが起動するたびに実行する Runnable
      period - タスクの連続した実行の間隔
      戻り値:
      タスクの保留中の実行を表す ScheduledFutureSE
      例外:
      TaskRejectedException - 特定のタスクが内部的な理由で受け入れられなかった場合 (たとえばプールのオーバーロード処理ポリシーまたは進行中のプールのシャットダウン)
      導入:
      5.0

    • scheduleAtFixedRate

      @DeprecatedSE(since="6.0") default ScheduledFutureSE<?> scheduleAtFixedRate(RunnableSE task, long period)
      使用すべきではありません。
      6.0 現在、scheduleAtFixedRate(Runnable, Duration) を推奨
      指定された RunnableSE をスケジュールします。できるだけ早く開始し、指定された期間で呼び出します。

      スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

      パラメーター:
      task - トリガーが起動するたびに実行する Runnable
      period - タスクの連続した実行の間隔 (ミリ秒単位)
      戻り値:
      タスクの保留中の実行を表す ScheduledFutureSE
      例外:
      TaskRejectedException - 特定のタスクが内部的な理由で受け入れられなかった場合 (たとえばプールのオーバーロード処理ポリシーまたは進行中のプールのシャットダウン)

    • scheduleWithFixedDelay

      ScheduledFutureSE<?> scheduleWithFixedDelay(RunnableSE task, InstantSE startTime, DurationSE delay)
      指定された RunnableSE をスケジュールし、指定された実行時間に呼び出し、その後、1 つの実行が完了してから次の実行が開始されるまでの間に指定された遅延で呼び出します。

      スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

      パラメーター:
      task - トリガーが起動するたびに実行する Runnable
      startTime - タスクに必要な最初の実行時間 (これが過去の場合、タスクはすぐに、つまりできるだけ早く実行されます)
      delay - ある実行の補完から次の実行の開始までの遅延
      戻り値:
      タスクの保留中の実行を表す ScheduledFutureSE
      例外:
      TaskRejectedException - 特定のタスクが内部的な理由で受け入れられなかった場合 (たとえばプールのオーバーロード処理ポリシーまたは進行中のプールのシャットダウン)
      導入:
      5.0

    • scheduleWithFixedDelay

      @DeprecatedSE(since="6.0") default ScheduledFutureSE<?> scheduleWithFixedDelay(RunnableSE task, DateSE startTime, long delay)
      使用すべきではありません。
      6.0 現在、scheduleWithFixedDelay(Runnable, Instant, Duration) を推奨
      指定された RunnableSE をスケジュールし、指定された実行時間に呼び出し、その後、1 つの実行が完了してから次の実行が開始されるまでの間に指定された遅延で呼び出します。

      スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

      パラメーター:
      task - トリガーが起動するたびに実行する Runnable
      startTime - タスクに必要な最初の実行時間 (これが過去の場合、タスクはすぐに、つまりできるだけ早く実行されます)
      delay - ある実行の補完から次の実行の開始までの遅延 (ミリ秒単位)
      戻り値:
      タスクの保留中の実行を表す ScheduledFutureSE
      例外:
      TaskRejectedException - 特定のタスクが内部的な理由で受け入れられなかった場合 (たとえばプールのオーバーロード処理ポリシーまたは進行中のプールのシャットダウン)

    • scheduleWithFixedDelay

      ScheduledFutureSE<?> scheduleWithFixedDelay(RunnableSE task, DurationSE delay)
      指定された RunnableSE をスケジュールします。できるだけ早く開始し、1 つの実行が完了してから次の実行が開始されるまでの間に指定された遅延で呼び出します。

      スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

      パラメーター:
      task - トリガーが起動するたびに実行する Runnable
      delay - ある実行の補完から次の実行の開始までの遅延
      戻り値:
      タスクの保留中の実行を表す ScheduledFutureSE
      例外:
      TaskRejectedException - 特定のタスクが内部的な理由で受け入れられなかった場合 (たとえばプールのオーバーロード処理ポリシーまたは進行中のプールのシャットダウン)
      導入:
      5.0

    • scheduleWithFixedDelay

      @DeprecatedSE(since="6.0") default ScheduledFutureSE<?> scheduleWithFixedDelay(RunnableSE task, long delay)
      使用すべきではありません。
      6.0 現在、scheduleWithFixedDelay(Runnable, Duration) を推奨
      指定された RunnableSE をスケジュールします。できるだけ早く開始し、1 つの実行が完了してから次の実行が開始されるまでの間に指定された遅延で呼び出します。

      スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

      パラメーター:
      task - トリガーが起動するたびに実行する Runnable
      delay - ある実行の補完から次の実行の開始までの遅延 (ミリ秒単位)
      戻り値:
      タスクの保留中の実行を表す ScheduledFutureSE
      例外:
      TaskRejectedException - 特定のタスクが内部的な理由で受け入れられなかった場合 (たとえばプールのオーバーロード処理ポリシーまたは進行中のプールのシャットダウン)