クラスの使用
org.springframework.batch.core.StepExecution
StepExecution を使用するパッケージ
パッケージ
説明
ジョブ、ステップ、構成、実行の抽象化をカバーする Spring Batch のコアドメインコンテキスト。
メタデータの閲覧をサポートするインターフェースと関連クラス。
エクスプローラー関心事の特定実装。
ジョブ関心事の特定実装。
フローインターフェース、エグゼキュータ、関連する例外を含むフロー関連の構造
フロー構造の基本的な実装
コアバッチリスナーインターフェースの一般的な実装。
このパッケージには、バッチの可観測性に関連する API が含まれています。
コンポーネントを分割するためのインターフェース。
共通パーティションコンポーネントの実装。
リポジトリの関心事のインターフェースと一般的な実装。
dao 関心事の特定実装。
リポジトリの問題の特定の実装。
Spring Batch（ジョブとステップ）の各カスタム Bean スコープのコンテキストの実装。
ステップに関する特定の実装。
アイテム指向アプローチのステップに関する特定の実装。
JobStep および関連コンポーネント。 タスクレット関連のインターフェースおよび一般的な実装。
リモートチャンキングのコンポーネント。
リモートパーティショニングコンポーネント。
Spring Integration で使用する場合、ステップに関連するクラスをサポートします。
バッチジョブ / ステップテストのユーティリティクラス。
org.springframework.batch.core 内の StepExecution 使用
StepExecution を返す org.springframework.batch.core のメソッド修飾子と型メソッド説明JobExecution.createStepExecution(StringSE stepName) 現在のジョブ実行にステップ実行を登録します。StepContribution.getStepExecution()このコントリビューションの親ステップ実行用のパブリック getter。型 StepExecution の引数を持つ型を返す org.springframework.batch.core のメソッド型 StepExecution のパラメーターを持つ org.springframework.batch.core のメソッド修飾子と型メソッド説明default ExitStatusStepExecutionListener.afterStep(StepExecution stepExecution) リスナーにステップの終了ステータスを変更する機会を与えます。default voidStepExecutionListener.beforeStep(StepExecution stepExecution) 現在のスコープのStepExecutionを使用して、リスナーの状態を初期化します。voidStep.execute(StepExecution stepExecution) ステップを処理し、提供されたStepExecutionに進行状況とステータスのメタ情報を割り当てます。型 StepExecution の型引数を持つ org.springframework.batch.core のメソッドパラメーター修飾子と型メソッド説明voidJobExecution.addStepExecutions(ListSE<StepExecution> stepExecutions) いくつかのステップ実行を追加します。型 StepExecution のパラメーターを持つ org.springframework.batch.core のコンストラクターorg.springframework.batch.core.explore 内の StepExecution 使用
修飾子と型メソッド説明JobExplorer.getStepExecution(LongSE jobExecutionId, LongSE stepExecutionId) ID と親JobExecutionID によってStepExecutionを取得します。org.springframework.batch.core.explore.support 内の StepExecution 使用
org.springframework.batch.core.job 内の StepExecution 使用
修飾子と型メソッド説明protected final StepExecutionAbstractJob.handleStep(Step step, JobExecution execution) 現在のJobExecutionのコンテキストで特定のステップの処理を委譲するためのサブクラスの簡易メソッド。SimpleStepHandler.handleStep(Step step, JobExecution execution) StepHandler.handleStep(Step step, JobExecution jobExecution) ステップを処理し、その実行を返します。型 StepExecution のパラメーターを持つ org.springframework.batch.core.job のメソッド修飾子と型メソッド説明protected booleanSimpleStepHandler.shouldStart(StepExecution lastStepExecution, JobExecution jobExecution, Step step) ステップと構成を指定して、ステップを開始する必要がある場合は true を返し、開始しない場合は false を返し、ジョブを終了する必要がある場合は例外をスローします。org.springframework.batch.core.job.flow 内の StepExecution 使用
型 StepExecution のパラメーターを持つ org.springframework.batch.core.job.flow のメソッド修飾子と型メソッド説明JobExecutionDecider.decide(JobExecution jobExecution, StepExecution stepExecution) 進行中のJobExecutionの状態に基づいて実行を分岐するための戦略。protected voidFlowStep.doExecute(StepExecution stepExecution) ステップの実行のために提供されたフローに委譲します。org.springframework.batch.core.job.flow.support 内の StepExecution 使用
型 StepExecution のパラメーターを持つ org.springframework.batch.core.job.flow.support のメソッド修飾子と型メソッド説明protected booleanSimpleFlow.isFlowContinued(State state, FlowExecutionStatus status, StepExecution stepExecution) protected StateSimpleFlow.nextState(StringSE stateName, FlowExecutionStatus status, StepExecution stepExecution) org.springframework.batch.core.listener 内の StepExecution 使用
型 StepExecution のパラメーターを持つ org.springframework.batch.core.listener のメソッド修飾子と型メソッド説明CompositeStepExecutionListener.afterStep(StepExecution stepExecution) 登録されたリスナーを逆の順序で呼び出し、Orderedを実装するリスナーを考慮して優先順位を付けます。ExecutionContextPromotionListener.afterStep(StepExecution stepExecution) MulticasterBatchListener.afterStep(StepExecution stepExecution) StepExecutionListenerSupport.afterStep(StepExecution stepExecution) 使用すべきではありません。voidCompositeStepExecutionListener.beforeStep(StepExecution stepExecution) Orderedを実装するリスナーを考慮し、優先順位を付けて、登録済みのリスナーを順番に呼び出します。voidJobParameterExecutionContextCopyListener.beforeStep(StepExecution stepExecution) voidMulticasterBatchListener.beforeStep(StepExecution stepExecution) voidStepExecutionListenerSupport.beforeStep(StepExecution stepExecution) 使用すべきではありません。org.springframework.batch.core.observability 内の StepExecution 使用
型 StepExecution のパラメーターを持つ org.springframework.batch.core.observability のコンストラクターorg.springframework.batch.core.partition 内の StepExecution 使用
型 StepExecution の引数を持つ型を返す org.springframework.batch.core.partition のメソッド修飾子と型メソッド説明PartitionHandler.handle(StepExecutionSplitter stepSplitter, StepExecution stepExecution) PartitionHandlerインターフェースのメインエントリポイント。StepExecutionSplitter.split(StepExecution stepExecution, int gridSize) 提供されたStepExecutionを、同じ親JobExecutionを持つ並列実行可能インスタンスのセットに分割します。型 StepExecution のパラメーターを持つ org.springframework.batch.core.partition のメソッド修飾子と型メソッド説明PartitionHandler.handle(StepExecutionSplitter stepSplitter, StepExecution stepExecution) PartitionHandlerインターフェースのメインエントリポイント。StepExecutionSplitter.split(StepExecution stepExecution, int gridSize) 提供されたStepExecutionを、同じ親JobExecutionを持つ並列実行可能インスタンスのセットに分割します。org.springframework.batch.core.partition.support 内の StepExecution 使用
型 StepExecution の引数を持つ型を返す org.springframework.batch.core.partition.support のメソッド修飾子と型メソッド説明protected FutureTaskSE<StepExecution>TaskExecutorPartitionHandler.createTask(Step step, StepExecution stepExecution) 指定された実行のコンテキストで指定されたステップを実行するタスクを作成します。protected abstract SetSE<StepExecution>AbstractPartitionHandler.doHandle(StepExecution managerStepExecution, SetSE<StepExecution> partitionStepExecutions) 指定されたStepExecutionインスタンスを実行し、それらの更新されたビューを返します。protected SetSE<StepExecution>TaskExecutorPartitionHandler.doHandle(StepExecution managerStepExecution, SetSE<StepExecution> partitionStepExecutions) AbstractPartitionHandler.handle(StepExecutionSplitter stepSplitter, StepExecution managerStepExecution) SimpleStepExecutionSplitter.split(StepExecution stepExecution, int gridSize) 型 StepExecution のパラメーターを持つ org.springframework.batch.core.partition.support のメソッド修飾子と型メソッド説明voidDefaultStepExecutionAggregator.aggregate(StepExecution result, CollectionSE<StepExecution> executions) 入力実行を結果StepExecutionに集約します。voidRemoteStepExecutionAggregator.aggregate(StepExecution result, CollectionSE<StepExecution> executions) 入力がJobExplorerからリフレッシュされると、入力の実行を結果StepExecutionに集約し、デリゲートアグリゲーターに委譲します。voidStepExecutionAggregator.aggregate(StepExecution result, CollectionSE<StepExecution> executions) 入力を受け取って集約し、集約を結果に入れます。protected FutureTaskSE<StepExecution>TaskExecutorPartitionHandler.createTask(Step step, StepExecution stepExecution) 指定された実行のコンテキストで指定されたステップを実行するタスクを作成します。protected voidPartitionStep.doExecute(StepExecution stepExecution) 提供されたPartitionHandlerに実行を委譲します。protected abstract SetSE<StepExecution>AbstractPartitionHandler.doHandle(StepExecution managerStepExecution, SetSE<StepExecution> partitionStepExecutions) 指定されたStepExecutionインスタンスを実行し、それらの更新されたビューを返します。protected SetSE<StepExecution>TaskExecutorPartitionHandler.doHandle(StepExecution managerStepExecution, SetSE<StepExecution> partitionStepExecutions) AbstractPartitionHandler.handle(StepExecutionSplitter stepSplitter, StepExecution managerStepExecution) protected booleanSimpleStepExecutionSplitter.isStartable(StepExecution stepExecution, ExecutionContext context) ステップ実行が開始可能かどうかを確認します。SimpleStepExecutionSplitter.split(StepExecution stepExecution, int gridSize) 型 StepExecution の型引数を持つ org.springframework.batch.core.partition.support のメソッドパラメーター修飾子と型メソッド説明voidDefaultStepExecutionAggregator.aggregate(StepExecution result, CollectionSE<StepExecution> executions) 入力実行を結果StepExecutionに集約します。voidRemoteStepExecutionAggregator.aggregate(StepExecution result, CollectionSE<StepExecution> executions) 入力がJobExplorerからリフレッシュされると、入力の実行を結果StepExecutionに集約し、デリゲートアグリゲーターに委譲します。voidStepExecutionAggregator.aggregate(StepExecution result, CollectionSE<StepExecution> executions) 入力を受け取って集約し、集約を結果に入れます。protected abstract SetSE<StepExecution>AbstractPartitionHandler.doHandle(StepExecution managerStepExecution, SetSE<StepExecution> partitionStepExecutions) 指定されたStepExecutionインスタンスを実行し、それらの更新されたビューを返します。protected SetSE<StepExecution>TaskExecutorPartitionHandler.doHandle(StepExecution managerStepExecution, SetSE<StepExecution> partitionStepExecutions) org.springframework.batch.core.repository 内の StepExecution 使用
型 StepExecution のパラメーターを持つ org.springframework.batch.core.repository のメソッド修飾子と型メソッド説明voidJobRepository.add(StepExecution stepExecution) StepExecutionとそのExecutionContextを保存します。default voidJobRepository.deleteStepExecution(StepExecution stepExecution) ステップ実行をその実行コンテキストとともに削除します。voidJobRepository.update(StepExecution stepExecution) StepExecutionを更新します（ただし、ExecutionContextは更新しません）。voidJobRepository.updateExecutionContext(StepExecution stepExecution) 指定されたStepExecutionの更新されたExecutionContextを永続化します。型 StepExecution の型引数を持つ org.springframework.batch.core.repository のメソッドパラメーター修飾子と型メソッド説明voidJobRepository.addAll(CollectionSE<StepExecution> stepExecutions) StepExecutionと各ExecutionContextのコレクションを保存します。org.springframework.batch.core.repository.dao 内の StepExecution 使用
修飾子と型メソッド説明JdbcStepExecutionDao.getLastStepExecution(JobInstance jobInstance, StringSE stepName) default StepExecutionStepExecutionDao.getLastStepExecution(JobInstance jobInstance, StringSE stepName) 指定されたJobInstanceの最後のStepExecutionを、作成時間、ID の順に並べて取得します。JdbcStepExecutionDao.getStepExecution(JobExecution jobExecution, LongSE stepExecutionId) StepExecutionDao.getStepExecution(JobExecution jobExecution, LongSE stepExecutionId) その ID からStepExecutionを取得します。型 StepExecution のパラメーターを持つ org.springframework.batch.core.repository.dao のメソッド修飾子と型メソッド説明default voidExecutionContextDao.deleteExecutionContext(StepExecution stepExecution) 指定されたStepExecutionの実行コンテキストを削除します。voidJdbcExecutionContextDao.deleteExecutionContext(StepExecution stepExecution) 指定されたStepExecutionの実行コンテキストを削除します。voidJdbcStepExecutionDao.deleteStepExecution(StepExecution stepExecution) 指定されたステップ実行を削除します。default voidStepExecutionDao.deleteStepExecution(StepExecution stepExecution) 指定されたステップ実行を削除します。ExecutionContextDao.getExecutionContext(StepExecution stepExecution) JdbcExecutionContextDao.getExecutionContext(StepExecution stepExecution) voidExecutionContextDao.saveExecutionContext(StepExecution stepExecution) 指定された stepExecution に関連付けられた実行コンテキストを永続化します。コンテキストの永続エントリはまだ存在していないはずです。voidJdbcExecutionContextDao.saveExecutionContext(StepExecution stepExecution) voidJdbcStepExecutionDao.saveStepExecution(StepExecution stepExecution) StepExecution を保存します。voidStepExecutionDao.saveStepExecution(StepExecution stepExecution) 指定された StepExecution を保存します。voidExecutionContextDao.updateExecutionContext(StepExecution stepExecution) 指定された stepExecution に関連付けられた実行コンテキストの更新を永続化します。voidJdbcExecutionContextDao.updateExecutionContext(StepExecution stepExecution) voidJdbcStepExecutionDao.updateStepExecution(StepExecution stepExecution) voidStepExecutionDao.updateStepExecution(StepExecution stepExecution) 指定された StepExecution を更新します型 StepExecution の型引数を持つ org.springframework.batch.core.repository.dao のメソッドパラメーター修飾子と型メソッド説明voidExecutionContextDao.saveExecutionContexts(CollectionSE<StepExecution> stepExecutions) 特定のコレクション内の各 stepExecution に関連付けられた実行コンテキストを永続化します。コンテキストの永続エントリはまだ存在していないはずです。voidJdbcExecutionContextDao.saveExecutionContexts(CollectionSE<StepExecution> stepExecutions) voidJdbcStepExecutionDao.saveStepExecutions(CollectionSE<StepExecution> stepExecutions) StepExecutions のバッチ挿入voidStepExecutionDao.saveStepExecutions(CollectionSE<StepExecution> stepExecutions) StepExecution の指定されたコレクションをバッチとして保存します。org.springframework.batch.core.repository.support 内の StepExecution 使用
型 StepExecution のパラメーターを持つ org.springframework.batch.core.repository.support のメソッド修飾子と型メソッド説明voidSimpleJobRepository.add(StepExecution stepExecution) voidSimpleJobRepository.deleteStepExecution(StepExecution stepExecution) voidSimpleJobRepository.update(StepExecution stepExecution) voidSimpleJobRepository.updateExecutionContext(StepExecution stepExecution) 型 StepExecution の型引数を持つ org.springframework.batch.core.repository.support のメソッドパラメーターorg.springframework.batch.core.resource 内の StepExecution 使用
型 StepExecution のパラメーターを持つ org.springframework.batch.core.resource のメソッド修飾子と型メソッド説明voidStepExecutionSimpleCompletionPolicy.beforeStep(StepExecution stepExecution) JobParametersから取得したコミット間隔でSimpleCompletionPolicyをセットアップします。org.springframework.batch.core.scope.context 内の StepExecution 使用
型 StepExecution のパラメーターを持つ org.springframework.batch.core.scope.context のメソッド修飾子と型メソッド説明voidStepScopeManager.execute(Step step, StepExecution stepExecution) static StepContextStepSynchronizationManager.register(StepExecution stepExecution) コンテキストを現在のスレッドに登録します。常に一致するStepSynchronizationManager.close()呼び出しを finally ブロックに入れて、囲んでいるブロックで正しいコンテキストが使用できるようにします。型 StepExecution のパラメーターを持つ org.springframework.batch.core.scope.context のコンストラクター修飾子コンストラクター説明StepContext(StepExecution stepExecution) このStepExecutionのStepContextの新しいインスタンスを作成します。StepContextRepeatCallback(StepExecution stepExecution) org.springframework.batch.core.step 内の StepExecution 使用
型 StepExecution のパラメーターを持つ org.springframework.batch.core.step のメソッド修飾子と型メソッド説明NoWorkFoundStepExecutionListener.afterStep(StepExecution stepExecution) voidStepInterruptionPolicy.checkInterrupted(StepExecution stepExecution) ジョブは中断されましたか？ もしそうなら、JobInterruptedExceptionを投げます。voidThreadStepInterruptionPolicy.checkInterrupted(StepExecution stepExecution) 現在のスレッドが中断されているかどうかを確認することにより、現在のジョブライフサイクルが中断されているかどうかを返します。protected abstract voidAbstractStep.doExecute(StepExecution stepExecution) ビジネスロジックを実行するサブクラスの拡張ポイント。protected voidAbstractStep.doExecutionRegistration(StepExecution stepExecution) StepScopeによるプロパティ解決のためにStepExecutionを登録しますfinal voidAbstractStep.execute(StepExecution stepExecution) ステップ実行ロジックのテンプレートメソッド - リソースの初期化（AbstractStep.open(ExecutionContext)）、実行ロジック（AbstractStep.doExecute(StepExecution)）およびリソースのクローズ（AbstractStep.close(ExecutionContext)）の抽象メソッドを呼び出します。org.springframework.batch.core.step.item 内の StepExecution 使用
型 StepExecution のパラメーターを持つ org.springframework.batch.core.step.item のメソッド修飾子と型メソッド説明protected voidSimpleChunkProcessor.stopTimer(io.micrometer.core.instrument.Timer.Sample sample, StepExecution stepExecution, StringSE metricName, StringSE status, StringSE description) org.springframework.batch.core.step.job 内の StepExecution 使用
型 StepExecution のパラメーターを持つ org.springframework.batch.core.step.job のメソッド修飾子と型メソッド説明protected voidJobStep.doExecute(StepExecution stepExecution) JobLauncherに委譲することによって提供されるジョブを実行して、重複した実行を防止します。DefaultJobParametersExtractor.getJobParameters(Job job, StepExecution stepExecution) JobParametersExtractor.getJobParameters(Job job, StepExecution stepExecution) ステップ実行から、たとえば実行コンテキストや他のプロパティからジョブパラメーターを抽出します。org.springframework.batch.core.step.tasklet 内の StepExecution 使用
型 StepExecution のパラメーターを持つ org.springframework.batch.core.step.tasklet のメソッド修飾子と型メソッド説明voidSystemCommandTasklet.beforeStep(StepExecution stepExecution) システムコマンド実行中の割り込みチェックのためにStepExecutionへの参照を取得します。protected voidTaskletStep.doExecute(StepExecution stepExecution) ステップを処理し、そのコンテキストを更新して、呼び出し側が進行状況を監視できるようにします。org.springframework.batch.integration.chunk 内の StepExecution 使用
型 StepExecution のパラメーターを持つ org.springframework.batch.integration.chunk のメソッド修飾子と型メソッド説明ChunkMessageChannelItemWriter.afterStep(StepExecution stepExecution) voidChunkMessageChannelItemWriter.beforeStep(StepExecution stepExecution) voidChunkMessageChannelItemWriter.LocalState.setStepExecution(StepExecution stepExecution) org.springframework.batch.integration.partition 内の StepExecution 使用
型 StepExecution の引数を持つ型を返す org.springframework.batch.integration.partition のメソッド修飾子と型メソッド説明protected SetSE<StepExecution>MessageChannelPartitionHandler.doHandle(StepExecution managerStepExecution, SetSE<StepExecution> partitionStepExecutions) StepExecutionRequestオブジェクトをMessagingTemplateのリクエストチャネルに送信し、その結果を応答チャネルでStepExecutionのリストとして受信します。型 StepExecution のパラメーターを持つ org.springframework.batch.integration.partition のメソッド修飾子と型メソッド説明protected SetSE<StepExecution>MessageChannelPartitionHandler.doHandle(StepExecution managerStepExecution, SetSE<StepExecution> partitionStepExecutions) StepExecutionRequestオブジェクトをMessagingTemplateのリクエストチャネルに送信し、その結果を応答チャネルでStepExecutionのリストとして受信します。型 StepExecution の型引数を持つ org.springframework.batch.integration.partition のメソッドパラメーター修飾子と型メソッド説明protected SetSE<StepExecution>MessageChannelPartitionHandler.doHandle(StepExecution managerStepExecution, SetSE<StepExecution> partitionStepExecutions) StepExecutionRequestオブジェクトをMessagingTemplateのリクエストチャネルに送信し、その結果を応答チャネルでStepExecutionのリストとして受信します。org.springframework.batch.integration.step 内の StepExecution 使用
型 StepExecution のパラメーターを持つ org.springframework.batch.integration.step のメソッド修飾子と型メソッド説明protected voidDelegateStep.doExecute(StepExecution stepExecution) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。org.springframework.batch.test 内の StepExecution 使用
StepExecution を返す org.springframework.batch.test のメソッド修飾子と型メソッド説明static StepExecutionMetaDataInstanceFactory.createStepExecution()デフォルトのパラメーターを使用してStepExecutionを作成します。static StepExecutionMetaDataInstanceFactory.createStepExecution(StringSE stepName, LongSE executionId) 提供されたパラメーターを使用してStepExecutionを作成します。static StepExecutionMetaDataInstanceFactory.createStepExecution(JobExecution jobExecution, StringSE stepName, LongSE executionId) 提供されたパラメーターを使用してStepExecutionを作成します。static StepExecutionMetaDataInstanceFactory.createStepExecution(JobParameters jobParameters) StepExecutionとそのすべての親エンティティをデフォルト値で作成しますが、提供されているJobParametersを使用します。static StepExecutionMetaDataInstanceFactory.createStepExecution(JobParameters jobParameters, ExecutionContext executionContext) static StepExecutionMetaDataInstanceFactory.createStepExecution(ExecutionContext executionContext) StepExecutionとそのすべての親エンティティをデフォルト値で作成しますが、提供されているExecutionContextを使用します。protected StepExecutionStepScopeTestExecutionListener.getStepExecution(org.springframework.test.context.TestContext testContext) StepExecutionをテストケースのフィールドとして検出するか、利用できない場合は作成します。型 StepExecution のパラメーターを持つ org.springframework.batch.test のメソッド修飾子と型メソッド説明static <T> TStepScopeTestUtils.doInStepScope(StepExecution stepExecution, CallableSE<T> callable) static <T> TExecutionContextTestUtils.getValueFromStep(StepExecution stepExecution, StringSE key)