クラス AbstractJob

メソッドの詳細

• setJobParametersValidator

  public void setJobParametersValidator(JobParametersValidator jobParametersValidator)

  ジョブパラメーターのバリデータ。デフォルトはバニラ DefaultJobParametersValidator です。

  パラメーター:

  jobParametersValidator - バリデーターインスタンス

• afterPropertiesSet

  public void afterPropertiesSet() throws ExceptionSE

  必須プロパティをアサートする: JobRepository。

  次で指定:

  インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet 

  例外:

  ExceptionSE

  関連事項:

  • InitializingBean.afterPropertiesSet()

• setBeanName

  public void setBeanName(StringSE name)

  name プロパティがまだ設定されていない場合は設定します。Spring コンテナー内のコールバックの順序のため、name プロパティが存在する場合は、最初に設定されます。Bean 定義の継承には注意が必要です。親 Bean に名前がある場合、その子にも明示的な名前が必要です。そうでない場合、一意ではありません。

  次で指定:

  インターフェース org.springframework.beans.factory.BeanNameAware の setBeanName 

  関連事項:

  • BeanNameAware.setBeanName(java.lang.String)

• setName

  public void setName(StringSE name)

  name プロパティを設定します。このオブジェクトが Spring Bean の場合、常にデフォルト値をオーバーライドします。

  パラメーター:

  name - ジョブに関連付ける名前。

  関連事項:

  • setBeanName(java.lang.String)

• getName

  public StringSE getName()

  次で指定:

  インターフェース Job の getName 

• getStep

  public abstract Step getStep(StringSE stepName)

  指定された名前のステップを取得します。指定された名前のステップがない場合は、null を返します。

  次で指定:

  インターフェース StepLocator の getStep 

  パラメーター:

  stepName - ステップの名前

  戻り値:

  ステップ

• getStepNames

  public abstract CollectionSE<StringSE> getStepNames()

  ステップ名を取得します。

  次で指定:

  インターフェース StepLocator の getStepNames 

  戻り値:

  ステップ名

• getJobParametersValidator

  public JobParametersValidator 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 です。

  関連事項:

  • Job.isRestartable()

• setJobParametersIncrementer

  public void setJobParametersIncrementer(JobParametersIncrementer jobParametersIncrementer)

  JobParametersIncrementer のパブリック setter。

  パラメーター:

  jobParametersIncrementer - 設定する JobParametersIncrementer

• getJobParametersIncrementer

  @Nullable public JobParametersIncrementer getJobParametersIncrementer()

  インターフェースからコピーされた説明: Job

  クライアントがシーケンス内の次の実行のために新しいパラメーターを生成する必要がある場合は、このインクリメンターを使用できます。このジョブに自然なシーケンスがない場合、戻り値は null になることがあります。

  次で指定:

  インターフェース Job の getJobParametersIncrementer 

  戻り値:

  新しいパラメーターを作成するために使用されるインクリメンター。デフォルトは null です。

• setJobExecutionListeners

  public void setJobExecutionListeners(JobExecutionListener[] listeners)

  JobExecutionListener を挿入するためのパブリック setter。それらはすべて、ジョブの適切な時点でリスナーコールバックが与えられます。

  パラメーター:

  listeners - 設定するリスナー。

• registerJobExecutionListener

  public void registerJobExecutionListener(JobExecutionListener listener)

  JobExecutionListener コールバックに単一のリスナーを登録します。

  パラメーター:

  listener - JobExecutionListener

• setJobRepository

  public void setJobRepository(JobRepository jobRepository)

  ジョブの存続期間中にバッチメタドメイン（ジョブ、ステップ、実行）の状態を管理するために必要な JobRepository のパブリック setter。

  パラメーター:

  jobRepository - ジョブの実行中に使用するリポジトリ

• getJobRepository

  protected JobRepository getJobRepository()

  サブクラスがジョブリポジトリにアクセスするための簡易メソッド。

  戻り値:

  jobRepository

• doExecute

  protected abstract void doExecute(JobExecution execution) throws JobExecutionException

  サブクラスが処理ロジックに集中し、リスナーとリポジトリ呼び出しを無視できるようにする拡張ポイント。実装は通常、ステップの順序に関係し、実際のステップ処理を handleStep(Step, JobExecution) に委譲します。

  パラメーター:

  execution - 現在の JobExecution

  例外:

  JobExecutionException - 致命的なバッチフレームワークエラーを通知する (ビジネスまたは検証の例外ではない)

• execute

  public final void execute(JobExecution execution)

  指定されたジョブを実行し、すべてのリスナーとリポジトリの呼び出しを処理し、実際の処理を doExecute(JobExecution) に委譲します。

  次で指定:

  インターフェース Job の execute 

  パラメーター:

  execution - JobExecution

  例外:

  StartLimitExceededException - いずれかのステップの開始制限を超えた場合

  関連事項:

  • Job.execute(JobExecution)

• 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

  protected ExitStatus getDefaultExitStatusForFailure(ThrowableSE ex, JobExecution execution)

  throwable から ExitStatus へのデフォルトのマッピング。

  パラメーター:

  ex - 失敗の原因

  execution - JobExecution インスタンス。

  戻り値:

  ExitStatus

• setObservationConvention

  public void setObservationConvention(BatchJobObservationConvention observationConvention)

• setObservationRegistry

  public void setObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)

• setMeterRegistry

  public void setMeterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry)

• toString

  public StringSE toString()

  オーバーライド:

  クラス ObjectSE の toString