クラス AbstractJob
java.lang.ObjectSE
org.springframework.batch.core.job.AbstractJob
- 実装されたすべてのインターフェース:
Job
、StepLocator
、org.springframework.beans.factory.Aware
、org.springframework.beans.factory.BeanNameAware
、org.springframework.beans.factory.InitializingBean
public abstract class AbstractJob
extends ObjectSE
implements Job, StepLocator, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean
Job
インターフェースの抽象実装。ここでは、JobRepository
、JobExecutionListener
、さまざまな構成パラメーターなどの一般的な依存関係を設定します。一般的なエラー処理とリスナー呼び出しアクティビティは、実装から抽象化されています。- 作成者:
- Lucas Ward, Dave Syer, Mahmoud Ben Hassine
フィールドサマリー
フィールドコンストラクターのサマリー
コンストラクター方法の概要
修飾子と型メソッド説明void
必須プロパティをアサートする:JobRepository
。protected abstract void
doExecute
(JobExecution execution) サブクラスが処理ロジックに集中し、リスナーとリポジトリ呼び出しを無視できるようにする拡張ポイント。final void
execute
(JobExecution execution) 指定されたジョブを実行し、すべてのリスナーとリポジトリの呼び出しを処理し、実際の処理をdoExecute(JobExecution)
に委譲します。protected ExitStatus
getDefaultExitStatusForFailure
(ThrowableSE ex, JobExecution execution) throwable からExitStatus
へのデフォルトのマッピング。クライアントがシーケンス内の次の実行のために新しいパラメーターを生成する必要がある場合は、このインクリメンターを使用できます。JobExecution
のジョブパラメーターのバリデーター。protected JobRepository
サブクラスがジョブリポジトリにアクセスするための簡易メソッド。getName()
abstract Step
指定された名前のステップを取得します。abstract CollectionSE<StringSE>
ステップ名を取得します。protected final StepExecution
handleStep
(Step step, JobExecution execution) 現在のJobExecution
のコンテキストで特定のステップの処理を委譲するためのサブクラスの簡易メソッド。boolean
少なくとも原則として、このジョブを再開できるかどうかを示すフラグ。void
JobExecutionListener
コールバックに単一のリスナーを登録します。void
setBeanName
(StringSE name) name プロパティがまだ設定されていない場合は設定します。void
setJobExecutionListeners
(JobExecutionListener[] listeners) JobExecutionListener
を挿入するためのパブリック setter。void
setJobParametersIncrementer
(JobParametersIncrementer jobParametersIncrementer) JobParametersIncrementer
のパブリック setter。void
setJobParametersValidator
(JobParametersValidator jobParametersValidator) ジョブパラメーターのバリデータ。void
setJobRepository
(JobRepository jobRepository) ジョブの存続期間中にバッチメタドメイン(ジョブ、ステップ、実行)の状態を管理するために必要なJobRepository
のパブリック setter。void
setMeterRegistry
(io.micrometer.core.instrument.MeterRegistry meterRegistry) void
name プロパティを設定します。void
setObservationConvention
(BatchJobObservationConvention observationConvention) void
setObservationRegistry
(io.micrometer.observation.ObservationRegistry observationRegistry) void
setRestartable
(boolean restartable) ジョブが以前に失敗した場合でも、ジョブが再起動しないようにするブールフラグ。toString()
フィールドの詳細
logger
protected static final org.apache.commons.logging.Log logger
コンストラクターの詳細
AbstractJob
public AbstractJob()デフォルトコンストラクター。AbstractJob
名前をすぐに追加するための便利なコンストラクター(必須ですが、最終的なものではありません)。- パラメーター:
name
- ジョブの名前
メソッドの詳細
setJobParametersValidator
ジョブパラメーターのバリデータ。デフォルトはバニラDefaultJobParametersValidator
です。- パラメーター:
jobParametersValidator
- バリデーターインスタンス
afterPropertiesSet
必須プロパティをアサートする:JobRepository
。- 次で指定:
- インターフェース
org.springframework.beans.factory.InitializingBean
のafterPropertiesSet
- 例外:
ExceptionSE
- 関連事項:
InitializingBean.afterPropertiesSet()
setBeanName
name プロパティがまだ設定されていない場合は設定します。Spring コンテナー内のコールバックの順序のため、name プロパティが存在する場合は、最初に設定されます。Bean 定義の継承には注意が必要です。親 Bean に名前がある場合、その子にも明示的な名前が必要です。そうでない場合、一意ではありません。- 次で指定:
- インターフェース
org.springframework.beans.factory.BeanNameAware
のsetBeanName
- 関連事項:
BeanNameAware.setBeanName(java.lang.String)
setName
name プロパティを設定します。このオブジェクトが Spring Bean の場合、常にデフォルト値をオーバーライドします。- パラメーター:
name
- ジョブに関連付ける名前。- 関連事項:
getName
getStep
指定された名前のステップを取得します。指定された名前のステップがない場合は、null を返します。- 次で指定:
- インターフェース
StepLocator
のgetStep
- パラメーター:
stepName
- ステップの名前- 戻り値:
- ステップ
getStepNames
ステップ名を取得します。- 次で指定:
- インターフェース
StepLocator
のgetStepNames
- 戻り値:
- ステップ名
getJobParametersValidator
インターフェースからコピーされた説明:Job
JobExecution
のジョブパラメーターのバリデータ。Job
のクライアントは、起動時または実行前または実行中にパラメーターを検証する必要がある場合があります。- 次で指定:
- インターフェース
Job
のgetJobParametersValidator
- 戻り値:
- パラメーター値をチェックするために使用できるバリデーター (決して
null
ではありません)。デフォルトはDefaultJobParametersValidator
です。
setRestartable
public void setRestartable(boolean restartable) ジョブが以前に失敗した場合でも、ジョブが再起動しないようにするブールフラグ。- パラメーター:
restartable
- 設定するフラグの値 (デフォルト true)
isRestartable
public boolean isRestartable()インターフェースからコピーされた説明:Job
少なくとも原則として、このジョブを再開できるかどうかを示すフラグ。- 次で指定:
- インターフェース
Job
のisRestartable
- 戻り値:
- 失敗後にこのジョブを再開できる場合は true。デフォルトは
true
です。 - 関連事項:
setJobParametersIncrementer
JobParametersIncrementer
のパブリック setter。- パラメーター:
jobParametersIncrementer
- 設定するJobParametersIncrementer
getJobParametersIncrementer
インターフェースからコピーされた説明:Job
クライアントがシーケンス内の次の実行のために新しいパラメーターを生成する必要がある場合は、このインクリメンターを使用できます。このジョブに自然なシーケンスがない場合、戻り値はnull
になることがあります。- 次で指定:
- インターフェース
Job
のgetJobParametersIncrementer
- 戻り値:
- 新しいパラメーターを作成するために使用されるインクリメンター。デフォルトは
null
です。
setJobExecutionListeners
JobExecutionListener
を挿入するためのパブリック setter。それらはすべて、ジョブの適切な時点でリスナーコールバックが与えられます。- パラメーター:
listeners
- 設定するリスナー。
registerJobExecutionListener
JobExecutionListener
コールバックに単一のリスナーを登録します。- パラメーター:
listener
-JobExecutionListener
setJobRepository
ジョブの存続期間中にバッチメタドメイン(ジョブ、ステップ、実行)の状態を管理するために必要なJobRepository
のパブリック setter。- パラメーター:
jobRepository
- ジョブの実行中に使用するリポジトリ
getJobRepository
サブクラスがジョブリポジトリにアクセスするための簡易メソッド。- 戻り値:
- jobRepository
doExecute
サブクラスが処理ロジックに集中し、リスナーとリポジトリ呼び出しを無視できるようにする拡張ポイント。実装は通常、ステップの順序に関係し、実際のステップ処理をhandleStep(Step, JobExecution)
に委譲します。- パラメーター:
execution
- 現在のJobExecution
- 例外:
JobExecutionException
- 致命的なバッチフレームワークエラーを通知する (ビジネスまたは検証の例外ではない)
execute
指定されたジョブを実行し、すべてのリスナーとリポジトリの呼び出しを処理し、実際の処理をdoExecute(JobExecution)
に委譲します。- 次で指定:
- インターフェース
Job
のexecute
- パラメーター:
execution
-JobExecution
- 例外:
StartLimitExceededException
- いずれかのステップの開始制限を超えた場合- 関連事項:
handleStep
protected final StepExecution handleStep(Step step, JobExecution execution) throws JobInterruptedException, JobRestartException, StartLimitExceededException サブクラスが現在のJobExecution
のコンテキストで特定のステップの処理を委譲するための簡易メソッド。このメソッドのクライアントは、JobRepository
にアクセスする必要はありません。また、再起動時に実行コンテキストに入力したり、中断された状態(ジョブまたはステップの実行中)を検出したりする必要もありません。- パラメーター:
step
- 実行するStep
execution
- 現在のJobExecution
- 戻り値:
- このステップに対応する
StepExecution
- 例外:
JobInterruptedException
-JobExecution
が中断された場合、特にBatchStatus.ABANDONED
またはBatchStatus.STOPPING
が検出された場合StartLimitExceededException
- このステップの開始制限を超えている場合JobRestartException
- ジョブが以前の失敗と矛盾した状態にある場合
getDefaultExitStatusForFailure
throwable からExitStatus
へのデフォルトのマッピング。- パラメーター:
ex
- 失敗の原因execution
-JobExecution
インスタンス。- 戻り値:
ExitStatus
setObservationConvention
setObservationRegistry
public void setObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry) setMeterRegistry
public void setMeterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry) toString