パッケージ jakarta.batch.api.chunk

インターフェース CheckpointAlgorithm

すべての既知の実装クラス:
AbstractCheckpointAlgorithm
public interface CheckpointAlgorithm
CheckpointAlgorithm は、チャンクステップ用のカスタムチェックポイントポリシーを提供します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    beginCheckpoint()
    beginCheckpoint メソッドは、次のチェックポイント間隔が始まる前 (次のチャンクトランザクションが始まる前) に呼び出されます。
    int
    checkpointTimeout()
    checkpointTimeout は、チェックポイントタイムアウトを確立する目的で、新しいチェックポイント間隔の開始時に呼び出されます。
    void
    endCheckpoint()
    endCheckpoint メソッドは、最後のチェックポイントが取得された後 (チャンクトランザクションがコミットされた後) に呼び出されます。
    boolean
    isReadyToCheckpoint()
    isReadyToCheckpoint メソッドは、各アイテムが処理された後にバッチランタイムによって呼び出され、現在のチャンクをチェックポイントする時間であるかどうかを判断します。

  • メソッドの詳細

    • checkpointTimeout

      int checkpointTimeout() throws ExceptionSE
      checkpointTimeout は、チェックポイントタイムアウトを確立するために、新しいチェックポイント間隔の開始時に呼び出されます。次のチャンクトランザクションが開始される前に呼び出されます。このメソッドは、次のチャンクトランザクションで使用されるタイムアウト値 (秒単位) である整数値を返します。このメソッドは、ジョブ定義の外部で既知の要因に基づいて、チェックポイントタイムアウトの設定を自動化できます。値 '0' は、この CheckpointAlgorithm によって最大値が設定されていないこと、つまりランタイム環境で許可される最大許容タイムアウトを意味します。
      戻り値:
      次のチェックポイント間隔に使用するタイムアウト間隔（秒単位）
      例外:
      ExceptionSE - エラーが発生した場合にスローされます。

    • beginCheckpoint

      void beginCheckpoint() throws ExceptionSE
      beginCheckpoint メソッドは、次のチェックポイント間隔が始まる前 (次のチャンクトランザクションが始まる前) に呼び出されます。
      例外:
      ExceptionSE - エラーが発生した場合にスローされます。

    • isReadyToCheckpoint

      boolean isReadyToCheckpoint() throws ExceptionSE
      isReadyToCheckpoint メソッドは、各アイテムが処理された後にバッチランタイムによって呼び出され、現在のチャンクをチェックポイントする時間であるかどうかを判断します。
      戻り値:
      今チェックポイントするかどうかを示すブール値。
      例外:
      ExceptionSE - エラーが発生した場合にスローされます。

    • endCheckpoint

      void endCheckpoint() throws ExceptionSE
      endCheckpoint メソッドは、最後のチェックポイントが取得された後 (チャンクトランザクションがコミットされた後) に呼び出されます。
      例外:
      ExceptionSE - エラーが発生した場合にスローされます。