クラス StepExecutionSimpleCompletionPolicy
java.lang.ObjectSE
org.springframework.batch.core.resource.StepExecutionSimpleCompletionPolicy
- 実装されたすべてのインターフェース:
StepExecutionListener
、StepListener
、CompletionPolicy
public class StepExecutionSimpleCompletionPolicy
extends ObjectSE
implements StepExecutionListener, CompletionPolicy
ステップの開始をリッスンすることにより、JobParameters
からコミット間隔を取得する CompletionPolicy
。CompletionPolicy
を使用できる場所であればどこでも(通常はステップのチャンクレベルで)使用し、StepExecutionListener
として周囲のステップに注入します。N.B. ステップが開始された後にのみ、完了ポリシーが使用可能になります。
遅延バインディング式(#{jobParameters['commit.interval']}
など)である commit-interval を使用してチャンクを宣言する方が簡単で、おそらく望ましいでしょう。その機能は Spring Batch 2.1.7 から利用できます。
- 作成者:
- Dave Syer, Mahmoud Ben Hassine
- 関連事項:
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明void
beforeStep
(StepExecution stepExecution) JobParameters
から取得したコミット間隔でSimpleCompletionPolicy
をセットアップします。boolean
isComplete
(RepeatContext context) コールバックが完了するのを待たずに、ポリシーが内部状態に従って完了を通知できるようにします。boolean
isComplete
(RepeatContext context, RepeatStatus result) コールバックからの最新の結果を考慮して、バッチが完了したかどうかを判断します。void
setKeyName
(StringSE keyName) コミット間隔を含むJobParameters
の Long 値のキー名のパブリック setter。start
(RepeatContext parent) バッチを実行するための新しいコンテキストを作成します。toString()
設定されている場合はラップされたCompletionPolicy
にデリゲートし、そうでない場合はsetKeyName(String)
の値を返します。void
update
(RepeatContext context) 実装に現在のバッチの状態を更新する機会を与えます。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE
インターフェース org.springframework.batch.core.StepExecutionListener から継承されたメソッド
afterStep
コンストラクターの詳細
StepExecutionSimpleCompletionPolicy
public StepExecutionSimpleCompletionPolicy()
メソッドの詳細
setKeyName
コミット間隔を含むJobParameters
の Long 値のキー名のパブリック setter。デフォルトは "commit.interval" です。- パラメーター:
keyName
- 設定する keyName
beforeStep
JobParameters
から取得したコミット間隔でSimpleCompletionPolicy
を設定します。指定されたキー名を持つ Long パラメーターがある場合は、このパラメーターの intValue が使用されます。ない場合は例外がスローされます。- 次で指定:
- インターフェース
StepExecutionListener
のbeforeStep
- パラメーター:
stepExecution
-StepExecution
のインスタンス。- 関連事項:
isComplete
インターフェースからコピーされた説明:CompletionPolicy
コールバックからの最新の結果を考慮して、バッチが完了したかどうかを判断します。このメソッドが true を返す場合、CompletionPolicy.isComplete(RepeatContext)
も同じである必要があります(ただし、必ずしもその逆ではないため、ここでの答えは結果に依存するため)。- 次で指定:
- インターフェース
CompletionPolicy
のisComplete
- パラメーター:
context
- 現在のバッチコンテキスト。result
- 最新のバッチアイテム処理の結果。- 戻り値:
- コミット間隔に達した場合、または結果が完了を示している場合は true
- 関連事項:
isComplete
インターフェースからコピーされた説明:CompletionPolicy
コールバックが完了するのを待たずに、ポリシーが内部状態に従って完了を通知できるようにします。- 次で指定:
- インターフェース
CompletionPolicy
のisComplete
- パラメーター:
context
- 現在のバッチコンテキスト。- 戻り値:
- コミット間隔に達した場合
- 関連事項:
start
インターフェースからコピーされた説明:CompletionPolicy
バッチを実行するための新しいコンテキストを作成します。NB 実装は、このメソッドから親を返すべきではありません。ポリシーの特定のニーズを満たすために、新しいコンテキストを作成する必要があります。これを行う最善の方法は、既存の実装をオーバーライドし、RepeatContext
を使用して属性に状態を格納することです。- 次で指定:
- インターフェース
CompletionPolicy
のstart
- パラメーター:
parent
- 進行中の場合は現在のコンテキスト。- 戻り値:
- 新しい
RepeatContext
- 関連事項:
update
インターフェースからコピーされた説明:CompletionPolicy
実装に現在のバッチの状態を更新する機会を与えます。コールバックが起動された後、コールバックごとに 1 回呼び出されますが、必ずしも完了した後ではありません(バッチが非同期の場合)。- 次で指定:
- インターフェース
CompletionPolicy
のupdate
- パラメーター:
context
- start によって返される値。- 関連事項:
toString
設定されている場合はラップされたCompletionPolicy
にデリゲートし、そうでない場合はsetKeyName(String)
の値を返します。