AbstractJob (Spring Batch API)

java.lang.Object
- org.springframework.batch.core.job.AbstractJob

実装されたすべてのインターフェース:
Job, StepLocator, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean
既知の直属サブクラス
FlowJob, SimpleJob
```
public abstract class AbstractJob
extends java.lang.Object
implements Job, StepLocator, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean
```
Job インターフェースの抽象実装。ここでは、JobRepository、JobExecutionListener、さまざまな構成パラメーターなどの一般的な依存関係を設定します。一般的なエラー処理とリスナー呼び出しアクティビティは、実装から抽象化されています。
作成者:
Lucas Ward, Dave Syer, Mahmoud Ben Hassine

フィールドサマリー
フィールド
修飾子と型フィールドと説明
protected static org.apache.commons.logging.Log logger

フィールド
修飾子と型	フィールドと説明
`protected static org.apache.commons.logging.Log`	`logger`

コンストラクターのサマリー

コンストラクター
コンストラクターと説明
`AbstractJob()` デフォルトコンストラクター。
`AbstractJob(java.lang.String name)` 名前をすぐに追加するための便利なコンストラクター（必須ですが、最終的なものではありません）。

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` 必須プロパティをアサートする: `JobRepository`。
`protected abstract void`	`doExecute(JobExecution execution)` サブクラスが処理ロジックに集中し、リスナーとリポジトリ呼び出しを無視できるようにする拡張ポイント。
`void`	`execute(JobExecution execution)` 指定されたジョブを実行し、すべてのリスナーとリポジトリの呼び出しを処理し、実際の処理を `doExecute(JobExecution)` に委譲します。
`protected ExitStatus`	`getDefaultExitStatusForFailure(java.lang.Throwable ex, JobExecution execution)` throwable から `ExitStatus` へのデフォルトのマッピング。
`JobParametersIncrementer`	`getJobParametersIncrementer()` クライアントがシーケンスの次の実行のために新しいパラメーターを生成する必要がある場合、このインクリメンターを使用できます。
`JobParametersValidator`	`getJobParametersValidator()` `JobExecution` のジョブパラメーターのバリデーター。
`protected JobRepository`	`getJobRepository()` サブクラスがジョブリポジトリにアクセスするための簡易メソッド。
`java.lang.String`	`getName()`
`abstract Step`	`getStep(java.lang.String stepName)` 指定された名前のステップを取得します。
`abstract java.util.Collection<java.lang.String>`	`getStepNames()` ステップ名を取得します。
`protected StepExecution`	`handleStep(Step step, JobExecution execution)` 現在の `JobExecution` のコンテキストで特定のステップの処理を委譲するためのサブクラスの簡易メソッド。
`boolean`	`isRestartable()` 少なくとも原則として、このジョブを再開できるかどうかを示すフラグ。
`void`	`registerJobExecutionListener(JobExecutionListener listener)` `JobExecutionListener` コールバックに単一のリスナーを登録します。
`void`	`setBeanName(java.lang.String 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`	`setName(java.lang.String name)` name プロパティを設定します。
`void`	`setRestartable(boolean restartable)` ジョブが以前に失敗した場合でも、ジョブが再起動しないようにするブールフラグ。
`java.lang.String`	`toString()`

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- フィールドの詳細
  - logger
```
protected static final org.apache.commons.logging.Log logger
```
- コンストラクターの詳細
  - AbstractJob
```
public AbstractJob()
```
    デフォルトコンストラクター。
  - AbstractJob
```
public AbstractJob(java.lang.String name)
```
    名前をすぐに追加するための便利なコンストラクター（必須ですが、最終的なものではありません）。
    パラメーター:
    name - ジョブの名前
- メソッドの詳細
  - setJobParametersValidator
```
public void setJobParametersValidator(JobParametersValidator jobParametersValidator)
```
    ジョブパラメーターのバリデータ。デフォルトはバニラ DefaultJobParametersValidator です。
    パラメーター:
    jobParametersValidator - バリデーターインスタンス
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws java.lang.Exception
```
    必須プロパティをアサートする: JobRepository。
    次で指定:
    インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet
    例外:
    java.lang.Exception
    関連事項:
    InitializingBean.afterPropertiesSet()
  - setBeanName
```
public void setBeanName(java.lang.String name)
```
    name プロパティがまだ設定されていない場合は設定します。Spring コンテナー内のコールバックの順序のため、name プロパティが存在する場合は、最初に設定されます。Bean 定義の継承には注意が必要です。親 Bean に名前がある場合、その子にも明示的な名前が必要です。そうでない場合、一意ではありません。
    次で指定:
    インターフェース org.springframework.beans.factory.BeanNameAware の setBeanName
    関連事項:
    BeanNameAware.setBeanName(java.lang.String)
  - setName
```
public void setName(java.lang.String name)
```
    name プロパティを設定します。このオブジェクトが Spring Bean の場合、常にデフォルト値をオーバーライドします。
    パラメーター:
    name - ジョブに関連付ける名前。
    関連事項:
    setBeanName(java.lang.String)
  - getName
```
public java.lang.String getName()
```
    次で指定:
    インターフェース Job の getName
  - getStep
```
public abstract Step getStep(java.lang.String stepName)
```
    指定された名前のステップを取得します。指定された名前のステップがない場合は、null を返します。
    次で指定:
    インターフェース StepLocator の getStep
    パラメーター:
    stepName - ステップの名前
    戻り値:
    ステップ
  - getStepNames
```
public abstract java.util.Collection<java.lang.String> getStepNames()
```
    ステップ名を取得します。
    次で指定:
    インターフェース StepLocator の getStepNames
    戻り値:
    ステップ名
  - getJobParametersValidator
```
public JobParametersValidator getJobParametersValidator()
```
    インターフェースからコピーされた説明: Job
    JobExecution のジョブパラメーターのバリデーター。ジョブのクライアントは、実行前または実行中に起動のパラメーターを検証する必要がある場合があります。
    次で指定:
    インターフェース Job の getJobParametersValidator
    戻り値:
    パラメーター値をチェックするために使用できるバリデーター (非 null)
  - setRestartable
```
public void setRestartable(boolean restartable)
```
    ジョブが以前に失敗した場合でも、ジョブが再起動しないようにするブールフラグ。
    パラメーター:
    restartable - 設定するフラグの値 (デフォルト true)
  - isRestartable
```
public boolean isRestartable()
```
    インターフェースからコピーされた説明: Job
    少なくとも原則として、このジョブを再開できるかどうかを示すフラグ。
    次で指定:
    インターフェース Job の isRestartable
    戻り値:
    失敗後にこのジョブを再開できる場合は true
    関連事項:
    Job.isRestartable()
  - setJobParametersIncrementer
```
public void setJobParametersIncrementer(JobParametersIncrementer jobParametersIncrementer)
```
    JobParametersIncrementer のパブリック setter。
    パラメーター:
    jobParametersIncrementer - 設定する JobParametersIncrementer
  - getJobParametersIncrementer
```
@Nullable
public JobParametersIncrementer getJobParametersIncrementer()
```
    インターフェースからコピーされた説明: Job
    クライアントがシーケンスの次の実行のために新しいパラメーターを生成する必要がある場合、このインクリメンターを使用できます。このジョブに自然な順序がない場合、戻り値は null になります。
    次で指定:
    インターフェース Job の getJobParametersIncrementer
    戻り値:
    新しいパラメーターの作成に使用されるインクリメンター
  - 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(java.lang.Throwable ex,
                                                    JobExecution execution)
```
    throwable から ExitStatus へのデフォルトのマッピング。
    パラメーター:
    ex - 失敗の原因
    execution - JobExecution インスタンス。
    戻り値:
    ExitStatus
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    クラス java.lang.Object の toString

クラス AbstractJob

フィールドサマリー

コンストラクターのサマリー

メソッドのサマリー

クラス java.lang.Object から継承されたメソッド

フィールドの詳細

logger

コンストラクターの詳細

AbstractJob

AbstractJob

メソッドの詳細

setJobParametersValidator

afterPropertiesSet

setBeanName

setName

getName

getStep

getStepNames

getJobParametersValidator

setRestartable

isRestartable

setJobParametersIncrementer

getJobParametersIncrementer

setJobExecutionListeners

registerJobExecutionListener

setJobRepository

getJobRepository

doExecute

execute

handleStep

getDefaultExitStatusForFailure

toString