クラス TaskletStep
java.lang.ObjectSE
org.springframework.batch.core.step.AbstractStep
org.springframework.batch.core.step.tasklet.TaskletStep
- 実装されたすべてのインターフェース:
Step
、org.springframework.beans.factory.Aware
、org.springframework.beans.factory.BeanNameAware
、org.springframework.beans.factory.InitializingBean
Tasklet
への呼び出しとしてステップを実行する単純な実装。おそらく繰り返され、各呼び出しはトランザクションで囲まれています。構造は、ループ内にトランザクション境界を持つループの構造です。ループは、ステップ演算(setStepOperations(RepeatOperations)
)によって制御されます。クライアントは、ステップ操作でインターセプターを使用して、ステップ全体で反復をインターセプトまたはリッスンすることができます。たとえば、ステップが完了したときにコールバックを取得できます。個々のタスクのレベルでコールバックが必要な場合は、チャンク操作のインターセプターを指定できます。
- 作成者:
- Dave Syer, Lucas Ward, Ben Hale, Robert Kasanicky, Michael Minella, Will Schipp, Mahmoud Ben Hassine
フィールドサマリー
インターフェース org.springframework.batch.core.Step から継承されたフィールド
STEP_TYPE_KEY
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明void
protected void
close
(ExecutionContext ctx) リソースを閉じるか解放するために、ステップの最後(finally ブロックの最後)でコラボレーターにコールバックを提供するサブクラスの拡張ポイント。protected SemaphoreSE
ロックの動作を操作してさまざまな病理をシミュレートできるように、主にテスト目的の拡張ポイント。protected void
doExecute
(StepExecution stepExecution) ステップを処理し、そのコンテキストを更新して、呼び出し側が進行状況を監視できるようにします。タスクレットを取得する -JobOperator のヘルパーメソッドprotected void
open
(ExecutionContext ctx) ステップを開始するときにサブクラスがコラボレーターにコールバックを提供し、リソースを開いたり取得したりするための拡張ポイント。void
registerChunkListener
(ChunkListener listener) ステップ実行の適切な段階でコールバックのチャンクリスナーを登録します。void
registerStream
(ItemStream stream) ストリームインターフェースへのコールバック用に単一のItemStream
を登録します。void
setChunkListeners
(ChunkListener[] listeners) 各オブジェクトをリスナーとして登録します。void
setInterruptionPolicy
(StepInterruptionPolicy interruptionPolicy) StepInterruptionPolicy
の Setter。void
setStepOperations
(RepeatOperations stepOperations) バッチ処理の外側のループに使用するRepeatOperations
。void
setStreams
(ItemStream[] streams) ステップの適切なタイミングで、コールバック用の各ストリームを登録します。void
setTasklet
(Tasklet tasklet) Tasklet
のパブリック setter。void
setTransactionAttribute
(org.springframework.transaction.interceptor.TransactionAttribute transactionAttribute) TransactionAttribute
の公開 setter。void
setTransactionManager
(org.springframework.transaction.PlatformTransactionManager transactionManager) PlatformTransactionManager
の公開 setter。クラス org.springframework.batch.core.step.AbstractStep から継承されたメソッド
doExecutionRegistration, doExecutionRelease, execute, getCompositeListener, getJobRepository, getName, getStartLimit, isAllowStartIfComplete, registerStepExecutionListener, setAllowStartIfComplete, setBeanName, setJobRepository, setMeterRegistry, setName, setObservationConvention, setObservationRegistry, setStartLimit, setStepExecutionListeners, toString
フィールドの詳細
TASKLET_TYPE_KEY
- 関連事項:
コンストラクターの詳細
TaskletStep
public TaskletStep()デフォルトコンストラクター。TaskletStep
- パラメーター:
name
-TaskletStep
の名前
メソッドの詳細
afterPropertiesSet
- 次で指定:
- インターフェース
org.springframework.beans.factory.InitializingBean
のafterPropertiesSet
- オーバーライド:
- クラス
AbstractStep
のafterPropertiesSet
- 例外:
ExceptionSE
setTransactionManager
public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager) PlatformTransactionManager
の公開 setter。- パラメーター:
transactionManager
- 設定するトランザクションマネージャー
setTransactionAttribute
public void setTransactionAttribute(org.springframework.transaction.interceptor.TransactionAttribute transactionAttribute) TransactionAttribute
の公開 setter。- パラメーター:
transactionAttribute
- 設定するTransactionAttribute
setTasklet
Tasklet
のパブリック setter。- パラメーター:
tasklet
- 設定するTasklet
registerChunkListener
ステップ実行の適切な段階でコールバックのチャンクリスナーを登録します。- パラメーター:
listener
-ChunkListener
setChunkListeners
各オブジェクトをリスナーとして登録します。- パラメーター:
listeners
- 既知の型のリスナーオブジェクトの配列。
setStreams
ステップの適切なタイミングで、コールバック用の各ストリームを登録します。ItemReader
とItemWriter
は自動的に登録されますが、ここで登録しても問題ありません。リーダーとライターの注入された依存関係は自動的に登録されないため、それ自体がItemStream
である別のオブジェクトへの委譲を使用してItemWriter
を実装する場合は、ここで委譲を登録する必要があります。- パラメーター:
streams
-ItemStream
オブジェクトの配列。
registerStream
ストリームインターフェースへのコールバック用に単一のItemStream
を登録します。- パラメーター:
stream
-ItemStream
のインスタンス
setStepOperations
バッチ処理の外側のループに使用するRepeatOperations
。発信者がファクトリを通じて設定する必要があります。デフォルトはプレーンRepeatTemplate
です。- パラメーター:
stepOperations
-RepeatOperations
インスタンス。
setInterruptionPolicy
StepInterruptionPolicy
の Setter。このポリシーは、ジョブの実行を中断するために外部リクエストが行われたかどうかを確認するために使用されます。- パラメーター:
interruptionPolicy
-StepInterruptionPolicy
doExecute
ステップを処理し、そのコンテキストを更新して、呼び出し側が進行状況を監視できるようにします。ステップはチャンクに分割され、それぞれがトランザクションで実行されます。ステップとその実行および実行コンテキストには、すべて最新のBatchStatus
が与えられ、JobRepository
は結果を格納するために使用されます。ステップの実行を管理する現在のコンテキストには、さまざまなレポート情報も追加されます。これらの情報は通常、ステップのExecutionContext
を介して呼び出し元が利用できます。- 次で指定:
- クラス
AbstractStep
のdoExecute
- パラメーター:
stepExecution
- 現在のステップのコンテキスト- 例外:
JobInterruptedException
- ステップまたはチャンクが中断された場合RuntimeExceptionSE
- チャンクの実行中に例外が発生した場合ExceptionSE
- 実装によってスローされたチェック済み例外
createSemaphore
ロックの動作を操作してさまざまな病理をシミュレートできるように、主にテスト目的の拡張ポイント。- 戻り値:
- JobRepository へのアクセスをロックするためのセマフォ
close
クラスからコピーされた説明:AbstractStep
リソースを閉じるか解放するために、ステップの最後(finally ブロックの最後)でコラボレーターにコールバックを提供するサブクラスの拡張ポイント。デフォルトでは何もしません。- オーバーライド:
- クラス
AbstractStep
のclose
- パラメーター:
ctx
- 使用するExecutionContext
- 例外:
ExceptionSE
- 実装によってスローされたチェック済み例外
open
クラスからコピーされた説明:AbstractStep
ステップを開始するときにサブクラスがコラボレーターにコールバックを提供し、リソースを開いたり取得したりするための拡張ポイント。デフォルトでは何もしません。- オーバーライド:
- クラス
AbstractStep
のopen
- パラメーター:
ctx
- 使用するExecutionContext
- 例外:
ExceptionSE
- 実装によってスローされたチェック済み例外
getTasklet
タスクレットを取得する -JobOperator のヘルパーメソッド- 戻り値:
- このステップ内で実行されている
Tasklet
インスタンス