クラス SimpleJobOperator
java.lang.ObjectSE
org.springframework.batch.core.launch.support.SimpleJobOperator
- 実装されたすべてのインターフェース:
JobOperator
,org.springframework.beans.factory.InitializingBean
public class SimpleJobOperator
extends ObjectSE
implements JobOperator, org.springframework.beans.factory.InitializingBean
JobOperator インターフェースのシンプルな実装。実装が組み合わせる機能の量により、次の依存関係が必要です。 このクラスを
JobOperatorFactoryBean
でインスタンス化して、ジョブオペレーターの周囲にトランザクションプロキシを作成できます。- 導入:
- 2.0
- 作成者:
- Dave Syer, Lucas Ward, Will Schipp, Mahmoud Ben Hassine
- 関連事項:
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明abandon
(long jobExecutionId) JobExecution
を ABANDONED としてマークします。void
必須プロパティを確認してください。getExecutions
(long instanceId) 特定のJobInstance
に関連付けられたJobExecutions
を、作成順(したがって、通常は実行順)でリストします。getJobInstance
(StringSE jobName, JobParameters jobParameters) getJobInstances
(StringSE jobName, int start, int count) 指定されたジョブ名のJobInstances
を、作成とは逆の順序で(したがって、通常は最初に実行されたときに)リストします。JobOperator.start(String, Properties)
で起動できる使用可能なジョブ名をリストします。getParameters
(long executionId) 人間が読める文字列としてJobParameters
を取得します (改行で区切られたキー = 値のペア)。getRunningExecutions
(StringSE jobName) 指定されたジョブ名で実行中のすべてのJobExecutions
の ID 値を取得します。getStepExecutionSummaries
(long executionId) JobExecution
に属するStepExecution
インスタンスを、指定された ID で要約し、ステータス、開始時刻、終了時刻などの詳細を示します。getSummary
(long executionId) 提供された ID でJobExecution
を要約し、ステータス、開始時間と終了時間などの詳細を示します。restart
(long executionId) 失敗または停止したJobExecution
を再起動します。void
setJobExplorer
(JobExplorer jobExplorer) JobExplorer
のパブリック setter。void
setJobLauncher
(JobLauncher jobLauncher) JobLauncher
のパブリック setter。void
setJobParametersConverter
(JobParametersConverter jobParametersConverter) JobParametersConverter
のパブリック setter。void
setJobRegistry
(ListableJobLocator jobRegistry) ListableJobLocator
のパブリック setter。void
setJobRepository
(JobRepository jobRepository) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。start
(StringSE jobName, PropertiesSE parameters) 指定されたパラメーターを使用して、ジョブの新しいインスタンスを開始します。startNextInstance
(StringSE jobName) 指定されたジョブに接続されたJobParametersIncrementer
によって決定されるJobInstance
のシーケンスで次を起動します。boolean
stop
(long executionId) 指定された ID を使用してJobExecution
に停止シグナルを送信します。
コンストラクターの詳細
SimpleJobOperator
public SimpleJobOperator()
メソッドの詳細
afterPropertiesSet
必須プロパティを確認してください。- 次で指定:
- インターフェース
org.springframework.beans.factory.InitializingBean
のafterPropertiesSet
- 例外:
ExceptionSE
- 関連事項:
InitializingBean.afterPropertiesSet()
setJobParametersConverter
JobParametersConverter
のパブリック setter。- パラメーター:
jobParametersConverter
- 設定するJobParametersConverter
setJobRegistry
ListableJobLocator
のパブリック setter。- パラメーター:
jobRegistry
- 設定するListableJobLocator
setJobExplorer
JobExplorer
のパブリック setter。- パラメーター:
jobExplorer
- 設定するJobExplorer
setJobRepository
setJobLauncher
JobLauncher
のパブリック setter。- パラメーター:
jobLauncher
- 設定するJobLauncher
getExecutions
インターフェースからコピーされた説明:JobOperator
特定のJobInstance
に関連付けられたJobExecutions
を、作成順(したがって、通常は実行順)でリストします。- 次で指定:
- インターフェース
JobOperator
のgetExecutions
- パラメーター:
instanceId
-JobInstance
の ID- 戻り値:
- このインスタンスに関連付けられているすべての
JobExecutions
の ID 値 - 例外:
NoSuchJobInstanceException
-instanceId
に関連付けられたJobInstance
が見つからない場合。
getJobNames
インターフェースからコピーされた説明:JobOperator
JobOperator.start(String, Properties)
で起動できる使用可能なジョブ名をリストします。- 次で指定:
- インターフェース
JobOperator
のgetJobNames
- 戻り値:
- ジョブ名のセット
getJobInstances
public ListSE<LongSE> getJobInstances(StringSE jobName, int start, int count) throws NoSuchJobException インターフェースからコピーされた説明:JobOperator
指定されたジョブ名のJobInstances
を、作成とは逆の順序で(したがって、通常は最初に実行されたときに)リストします。- 次で指定:
- インターフェース
JobOperator
のgetJobInstances
- パラメーター:
jobName
- すべてのインスタンスが持つジョブ名start
- インスタンスの開始インデックスcount
- 返す値の最大数- 戻り値:
JobInstances
の ID 値- 例外:
NoSuchJobException
- jobName のJobInstance
が存在しない場合にスローされます。
getJobInstance
- 次で指定:
- インターフェース
JobOperator
のgetJobInstance
- パラメーター:
jobName
-String
SE ジョブの名前。jobParameters
- ジョブインスタンスのJobParameters
パラメーター。- 戻り値:
- 指定された名前とパラメーターを持つ
JobInstance
、またはnull
。
getParameters
インターフェースからコピーされた説明:JobOperator
人間が読める文字列としてJobParameters
を取得します (改行で区切られたキー = 値のペア)。- 次で指定:
- インターフェース
JobOperator
のgetParameters
- パラメーター:
executionId
- 既存のJobExecution
の ID- 戻り値:
- 関連するインスタンスを起動するために使用されたジョブパラメーター
- 例外:
NoSuchJobExecutionException
- ID がJobExecution
に関連付けられていなかった場合
getRunningExecutions
インターフェースからコピーされた説明:JobOperator
指定されたジョブ名で実行中のすべてのJobExecutions
の ID 値を取得します。- 次で指定:
- インターフェース
JobOperator
のgetRunningExecutions
- パラメーター:
jobName
- 検索するジョブの名前- 戻り値:
- 実行中の
JobExecution
インスタンスの ID 値 - 例外:
NoSuchJobException
- そのジョブ名を持つJobExecutions
がない場合
getStepExecutionSummaries
public MapSE<LongSE,StringSE> getStepExecutionSummaries(long executionId) throws NoSuchJobExecutionException インターフェースからコピーされた説明:JobOperator
JobExecution
に属するStepExecution
インスタンスを、指定された ID で要約し、ステータス、開始時刻、終了時刻などの詳細を示します。- 次で指定:
- インターフェース
JobOperator
のgetStepExecutionSummaries
- パラメーター:
executionId
- 既存のJobExecution
の ID- 戻り値:
- ステップ実行 ID と文字列へのマップで、実行の状態を要約したもの
- 例外:
NoSuchJobExecutionException
- 指定された ID のJobExecution
がない場合
getSummary
インターフェースからコピーされた説明:JobOperator
提供された ID でJobExecution
を要約し、ステータス、開始時間と終了時間などの詳細を示します。- 次で指定:
- インターフェース
JobOperator
のgetSummary
- パラメーター:
executionId
- 既存のJobExecution
の ID- 戻り値:
- ジョブ実行の状態を要約した文字列
- 例外:
NoSuchJobExecutionException
- 指定された ID のJobExecution
がない場合
restart
public LongSE restart(long executionId) throws JobInstanceAlreadyCompleteException, NoSuchJobExecutionException, NoSuchJobException, JobRestartException, JobParametersInvalidException インターフェースからコピーされた説明:JobOperator
失敗または停止したJobExecution
を再起動します。指定された ID が存在しないか、通常の状況ですでに正常に完了したJobInstance
に対応する場合、例外で失敗します。- 次で指定:
- インターフェース
JobOperator
のrestart
- パラメーター:
executionId
- 失敗または停止したJobExecution
の ID- 戻り値:
- 開始された
JobExecution
の ID - 例外:
JobInstanceAlreadyCompleteException
- ジョブがすでに正常に完了した場合NoSuchJobExecutionException
- ID がJobExecution
に関連付けられていなかった場合NoSuchJobException
-JobExecution
は見つかったが、対応するJob
が起動に使用できなくなった場合JobRestartException
- 再起動時に特定できないエラーが発生した場合 (たとえば破損または一貫性のない再起動データ)JobParametersInvalidException
- パラメーターがこのジョブに有効でない場合
start
@DeprecatedSE(since="5.0.1", forRemoval=true) public LongSE start(StringSE jobName, StringSE parameters) throws NoSuchJobException, JobInstanceAlreadyExistsException, JobParametersInvalidException 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。インターフェースからコピーされた説明:JobOperator
指定されたパラメーターを使用して、ジョブの新しいインスタンスを開始します。- 次で指定:
- インターフェース
JobOperator
のstart
- パラメーター:
jobName
- 起動するJob
の名前parameters
- 起動するためのパラメーター (改行で区切られたキー = 値のペア)- 戻り値:
- 起動された
JobExecution
の ID - 例外:
NoSuchJobException
- 指定された名前のJob
がない場合JobInstanceAlreadyExistsException
- この名前とパラメーターのジョブインスタンスがすでに存在する場合JobParametersInvalidException
- ジョブパラメーターのいずれかが無効な場合にスローされます。
start
public LongSE start(StringSE jobName, PropertiesSE parameters) throws NoSuchJobException, JobInstanceAlreadyExistsException, JobParametersInvalidException インターフェースからコピーされた説明:JobOperator
指定されたパラメーターを使用して、ジョブの新しいインスタンスを開始します。- 次で指定:
- インターフェース
JobOperator
のstart
- パラメーター:
jobName
- 起動するJob
の名前parameters
- 起動するためのパラメーター- 戻り値:
- 起動された
JobExecution
の ID - 例外:
NoSuchJobException
- 指定された名前のJob
がない場合JobInstanceAlreadyExistsException
- この名前とパラメーターのジョブインスタンスがすでに存在する場合JobParametersInvalidException
- ジョブパラメーターのいずれかが無効な場合にスローされます。
startNextInstance
public LongSE startNextInstance(StringSE jobName) throws NoSuchJobException, UnexpectedJobExecutionException, JobParametersInvalidException インターフェースからコピーされた説明:JobOperator
指定されたジョブに接続されたJobParametersIncrementer
によって決定されるJobInstance
のシーケンスで次を起動します。前のインスタンスがまだ障害状態にある場合、このメソッドは新しいインスタンスを作成し、(JobParametersIncrementer
が機能している限り)異なるパラメーターで実行する必要があります。
以下で説明する最後の 3 つの例外は非常に起こりそうにありませんが、完全に除外することはできません。同時にこのメソッド(または類似のメソッド)を使用しようとしている他のスレッドまたはプロセスを指します。- 次で指定:
- インターフェース
JobOperator
のstartNextInstance
- パラメーター:
jobName
- 起動するジョブの名前- 戻り値:
- ジョブの起動時に作成された実行の
JobExecution
ID - 例外:
NoSuchJobException
- 利用可能なそのようなジョブ定義がない場合UnexpectedJobExecutionException
- 予期しない状況が発生した場合JobParametersInvalidException
- ジョブパラメーターの一部が無効な場合にスローされます。
stop
public boolean stop(long executionId) throws NoSuchJobExecutionException, JobExecutionNotRunningException インターフェースからコピーされた説明:JobOperator
指定された ID を使用してJobExecution
に停止シグナルを送信します。このメソッドが true を返した場合、シグナルは正常に送信されますが、ジョブが停止したことを意味するわけではありません。それを確認する唯一の方法は、ジョブの実行ステータスをポーリングすることです。- 次で指定:
- インターフェース
JobOperator
のstop
- パラメーター:
executionId
- 実行中のJobExecution
の ID- 戻り値:
- メッセージが正常に送信された場合は true (ジョブが停止したことを保証しません)
- 例外:
NoSuchJobExecutionException
- 指定された ID を持つJobExecution
がない場合JobExecutionNotRunningException
-JobExecution
が実行されていない場合 (止められない)
abandon
public JobExecution abandon(long jobExecutionId) throws NoSuchJobExecutionException, JobExecutionAlreadyRunningException インターフェースからコピーされた説明:JobOperator
JobExecution
を ABANDONED としてマークします。プロセスが停止したために停止シグナルが無視された場合、これは(STOPPED とは対照的に)ジョブを終了済みとしてマークする最良の方法です。破棄されたジョブの実行は、フレームワークによって再開できません。- 次で指定:
- インターフェース
JobOperator
のabandon
- パラメーター:
jobExecutionId
- 中止するジョブ実行 ID- 戻り値:
- 中止された
JobExecution
- 例外:
NoSuchJobExecutionException
- jobExecutionId のジョブ実行がない場合にスローされます。JobExecutionAlreadyRunningException
- ジョブが実行中の場合 (最初に停止する必要があります)