クラス AbstractStep
java.lang.ObjectSE
org.springframework.batch.core.step.AbstractStep
- 実装されたすべてのインターフェース:
Step
、org.springframework.beans.factory.Aware
、org.springframework.beans.factory.BeanNameAware
、org.springframework.beans.factory.InitializingBean
- 既知の直属サブクラス
DelegateStep
、FlowStep
、JobStep
、PartitionStep
、TaskletStep
public abstract class AbstractStep
extends ObjectSE
implements Step, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.BeanNameAware
リスナーの登録や呼び出しなど、サブクラスに共通の動作を提供する
Step
実装。- 作成者:
- Dave Syer, Ben Hale, Robert Kasanicky, Michael Minella, Chris Schaefer, Mahmoud Ben Hassine
フィールドサマリー
インターフェース org.springframework.batch.core.Step から継承されたフィールド
STEP_TYPE_KEY
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明void
protected void
close
(ExecutionContext ctx) リソースを閉じるか解放するために、ステップの最後(finally ブロックの最後)でコラボレーターにコールバックを提供するサブクラスの拡張ポイント。protected abstract void
doExecute
(StepExecution stepExecution) ビジネスロジックを実行するサブクラスの拡張ポイント。protected void
doExecutionRegistration
(StepExecution stepExecution) StepScope
によるプロパティ解決のためにStepExecution
を登録しますprotected void
最新のStepExecution
をリリースfinal void
execute
(StepExecution stepExecution) ステップ実行ロジックのテンプレートメソッド - リソースの初期化(open(ExecutionContext)
)、実行ロジック(doExecute(StepExecution)
)およびリソースのクローズ(close(ExecutionContext)
)の抽象メソッドを呼び出します。protected StepExecutionListener
protected JobRepository
getName()
int
boolean
protected void
open
(ExecutionContext ctx) ステップを開始するときにサブクラスがコラボレーターにコールバックを提供し、リソースを開いたり取得したりするための拡張ポイント。void
ステップ実行の適切な段階で、コールバックのステップリスナーを登録します。void
setAllowStartIfComplete
(boolean allowStartIfComplete) ステップがすでに完了している場合にステップを再開するかどうかを決定するフラグのパブリック setter。void
setBeanName
(StringSE name) name プロパティがまだ設定されていない場合は設定します。void
setJobRepository
(JobRepository jobRepository) JobRepository
のパブリック setter。void
setMeterRegistry
(io.micrometer.core.instrument.MeterRegistry meterRegistry) void
name プロパティを設定します。void
setObservationConvention
(BatchStepObservationConvention observationConvention) void
setObservationRegistry
(io.micrometer.observation.ObservationRegistry observationRegistry) void
setStartLimit
(int startLimit) startLimit 用のパブリック setter。void
setStepExecutionListeners
(StepExecutionListener[] listeners) 各オブジェクトをリスナーとして登録します。toString()
コンストラクターの詳細
AbstractStep
public AbstractStep()デフォルトコンストラクター。AbstractStep
name プロパティのみを設定するための便利なコンストラクター。- パラメーター:
name
- ステップの名前
メソッドの詳細
afterPropertiesSet
- 次で指定:
- インターフェース
org.springframework.beans.factory.InitializingBean
のafterPropertiesSet
- 例外:
ExceptionSE
getName
setName
name プロパティを設定します。このオブジェクトが Spring Bean の場合、常にデフォルト値をオーバーライドします。- パラメーター:
name
-Step
の名前。- 関連事項:
setBeanName
name プロパティがまだ設定されていない場合は設定します。Spring コンテナー内のコールバックの順序のため、name プロパティが存在する場合は、最初に設定されます。Bean 定義の継承には注意が必要です。親 Bean に名前がある場合、その子にも明示的な名前が必要です。そうでない場合、一意ではありません。- 次で指定:
- インターフェース
org.springframework.beans.factory.BeanNameAware
のsetBeanName
- 関連事項:
BeanNameAware.setBeanName(java.lang.String)
getStartLimit
public int getStartLimit()- 次で指定:
- インターフェース
Step
のgetStartLimit
- 戻り値:
- 同じジョブインスタンスに対してステップを (再) 開始できる回数。デフォルトは
Integer.MAX_VALUE
setStartLimit
public void setStartLimit(int startLimit) startLimit 用のパブリック setter。- パラメーター:
startLimit
- 設定する startLimit
isAllowStartIfComplete
public boolean isAllowStartIfComplete()- 次で指定:
- インターフェース
Step
のisAllowStartIfComplete
- 戻り値:
true
は、すでに完了としてマークされているステップを再度開始できる場合。デフォルトはfalse
です。
setAllowStartIfComplete
public void setAllowStartIfComplete(boolean allowStartIfComplete) ステップがすでに完了している場合にステップを再開するかどうかを決定するフラグのパブリック setter。デフォルトは false です。- パラメーター:
allowStartIfComplete
- 設定するフラグの値
doExecute
ビジネスロジックを実行するサブクラスの拡張ポイント。サブクラスは、戻る前にStepExecution
にExitStatus
を設定する必要があります。- パラメーター:
stepExecution
- 現在のステップのコンテキスト- 例外:
ExceptionSE
- 実装によってスローされたチェック済み例外
open
ステップを開始するときにサブクラスがコラボレーターにコールバックを提供し、リソースを開いたり取得したりするための拡張ポイント。デフォルトでは何もしません。- パラメーター:
ctx
- 使用するExecutionContext
- 例外:
ExceptionSE
- 実装によってスローされたチェック済み例外
close
リソースを閉じるか解放するために、ステップの最後(finally ブロックの最後)でコラボレーターにコールバックを提供するサブクラスの拡張ポイント。デフォルトでは何もしません。- パラメーター:
ctx
- 使用するExecutionContext
- 例外:
ExceptionSE
- 実装によってスローされたチェック済み例外
execute
public final void execute(StepExecution stepExecution) throws JobInterruptedException, UnexpectedJobExecutionException ステップ実行ロジックのテンプレートメソッド - リソースの初期化(open(ExecutionContext)
)、実行ロジック(doExecute(StepExecution)
)およびリソースのクローズ(close(ExecutionContext)
)の抽象メソッドを呼び出します。- 次で指定:
- インターフェース
Step
のexecute
- パラメーター:
stepExecution
- 実行するステップを表すエンティティ。- 例外:
JobInterruptedException
- ステップが外部から中断された場合。UnexpectedJobExecutionException
doExecutionRelease
protected void doExecutionRelease()最新のStepExecution
をリリースdoExecutionRegistration
StepScope
によるプロパティ解決のためにStepExecution
を登録します- パラメーター:
stepExecution
- StepScoped Bean を水和するときに使用する StepExecution
registerStepExecutionListener
ステップ実行の適切な段階で、コールバックのステップリスナーを登録します。- パラメーター:
listener
-StepExecutionListener
setStepExecutionListeners
各オブジェクトをリスナーとして登録します。- パラメーター:
listeners
- 既知の型のリスナーオブジェクトの配列。
getCompositeListener
- 戻り値:
- 登録されたすべてのリスナーに委譲する複合リスナー。
setJobRepository
JobRepository
のパブリック setter。- パラメーター:
jobRepository
- 必須の依存関係です(デフォルトなし)。
getJobRepository
toString
setObservationConvention
setObservationRegistry
public void setObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry) setMeterRegistry
public void setMeterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry)