JobOperator (Jakarta EE Platform API)

```
public interface JobOperator
```
JobOperator は、バッチジョブを操作するためのインターフェースを提供します。JobOperator を介して、プログラムはジョブを開始、停止、再開できます。さらに、ジョブ履歴をインスペクションして、現在実行中のジョブと以前に実行したジョブを検出できます。JobOperator インターフェースはセキュリティ上の制約を課しません。ただし、実装者は JobOperator メソッドを選択したセキュリティスキームで自由に制限できます。実装者は、JobSecurityException を使用したセキュリティスキームによって制限されているメソッドを終了する必要があります。

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド
修飾子と型	メソッドと説明
`void`	`abandon(long executionId)` バッチステータスを ABANDONED に設定します。
`JobExecution`	`getJobExecution(long executionId)` 指定された実行 ID のジョブ実行を返します。
`ListSE<JobExecution>`	`getJobExecutions(JobInstance instance)` 指定されたジョブインスタンスに属するすべてのジョブ実行を返します。
`JobInstance`	`getJobInstance(long executionId)` 指定された実行 ID のジョブインスタンスを返します。
`int`	`getJobInstanceCount(StringSE jobName)` 特定の名前を持つジョブのインスタンスの数を返します。
`ListSE<JobInstance>`	`getJobInstances(StringSE jobName, int start, int count)` 特定の名前を持つジョブに属するすべての JobInstances を新しい順に返します。
`SetSE<StringSE>`	`getJobNames()` バッチランタイムに認識されているすべてのジョブ名のセットを返します。
`PropertiesSE`	`getParameters(long executionId)` 指定されたジョブインスタンスのジョブパラメーターを返します。
`ListSE<LongSE>`	`getRunningExecutions(StringSE jobName)` 実行を実行している指定された名前のジョブインスタンスの実行 ID を返します。
`ListSE<StepExecution>`	`getStepExecutions(long jobExecutionId)` 指定された実行 ID の StepExecutions を返します。
`long`	`restart(long executionId, PropertiesSE restartParameters)` 非同期に実行される、失敗または停止したジョブインスタンスを再起動します。
`long`	`start(StringSE jobXMLName, PropertiesSE jobParameters)` 新しいジョブインスタンスを作成し、非同期で実行されるそのインスタンスの最初の実行を開始します。
`void`	`stop(long executionId)` 実行中のジョブの実行停止リクエスト。

- メソッドの詳細
  - getJobNames
```
SetSE<StringSE> getJobNames()
                 throws JobSecurityException
```
    バッチランタイムに認識されているすべてのジョブ名のセットを返します。
    戻り値:
    ジョブ名のセット。
    例外:
    JobSecurityException - これらのパラメーターを使用したこのメソッドの実行が（一部の実装固有のメカニズムによって）認可されていないと実装が判断した場合にスローされます。
  - getJobInstanceCount
```
int getJobInstanceCount(StringSE jobName)
                 throws NoSuchJobException,
                        JobSecurityException
```
    特定の名前を持つジョブのインスタンスの数を返します。
    パラメーター:
    jobName - ジョブの名前を指定します。
    戻り値:
    名前付きジョブのインスタンスの数。
    例外:
    NoSuchJobException - jobName パラメーター値が実装のリポジトリによって認識されるジョブに対応しない場合にスローされます。
    JobSecurityException - これらのパラメーターを使用したこのメソッドの実行が（一部の実装固有のメカニズムによって）認可されていないと実装が判断した場合にスローされます。
  - getJobInstances
```
ListSE<JobInstance> getJobInstances(StringSE jobName,
                                  int start,
                                  int count)
                           throws NoSuchJobException,
                                  JobSecurityException
```
    特定の名前を持つジョブに属するすべての JobInstances を新しい順に返します。
    パラメーター:
    jobName - ジョブ名を指定します。
    start - ジョブインスタンスの最大リストから返される相対開始番号（ゼロベース）を指定します。
    count - ジョブインスタンスの最大リストの開始位置から返すジョブインスタンスの数を指定します。
    戻り値:
    JobInstances のリスト。
    例外:
    NoSuchJobException - jobName パラメーター値が実装のリポジトリによって認識されるジョブに対応しない場合にスローされます。
    JobSecurityException - これらのパラメーターを使用したこのメソッドの実行が（一部の実装固有のメカニズムによって）認可されていないと実装が判断した場合にスローされます。
  - getRunningExecutions
```
ListSE<LongSE> getRunningExecutions(StringSE jobName)
                         throws NoSuchJobException,
                                JobSecurityException
```
    実行を実行している指定された名前のジョブインスタンスの実行 ID を返します。
    パラメーター:
    jobName - ジョブ名を指定します。
    戻り値:
    実行 ID のリスト。
    例外:
    NoSuchJobException - jobName パラメーター値が実装のリポジトリによって認識されるジョブに対応しない場合にスローされます。
    JobSecurityException - これらのパラメーターを使用したこのメソッドの実行が（一部の実装固有のメカニズムによって）認可されていないと実装が判断した場合にスローされます。
  - getParameters
```
PropertiesSE getParameters(long executionId)
                  throws NoSuchJobExecutionException,
                         JobSecurityException
```
    指定されたジョブインスタンスのジョブパラメーターを返します。これらは、インスタンスが最初に start メソッドによって作成されたときに指定されたキーと値のペアです。
    パラメーター:
    executionId - パラメーターを取得する実行を指定します。
    戻り値:
    キーと値のジョブパラメーターのペアを含む Properties オブジェクト。
    例外:
    NoSuchJobExecutionException - executionId パラメーター値が実装のリポジトリによって認識される実行に対応しない場合にスローされます。
    JobSecurityException - これらのパラメーターを使用したこのメソッドの実行が（一部の実装固有のメカニズムによって）認可されていないと実装が判断した場合にスローされます。
  - start
```
long start(StringSE jobXMLName,
           PropertiesSE jobParameters)
    throws JobStartException,
           JobSecurityException
```
    新しいジョブインスタンスを作成し、非同期で実行されるそのインスタンスの最初の実行を開始します。ジョブを説明するジョブ XML は、バッチランタイムの実装で規定されている手段に従って、名前で最初に検索されることに注意してください。これは実装によって異なる場合があります。その方法でジョブ XML が見つからない場合、バッチランタイムは、現在のクラスローダーに基づいて、META-INF/batch-jobs ディレクトリから指定されたジョブ XML をリソースとして検索する必要があります。META-INF/batch-jobs ディレクトリのジョブ XML ファイルは、"name" .xml の命名規則に従います。"name" は、jobXMLName パラメーターの値です（以下を参照）。
    パラメーター:
    jobXMLName - ジョブを説明するジョブ XML の名前を指定します。
    jobParameters - ジョブ XML の属性置換のキーワードと値のペアを指定します。
    戻り値:
    ジョブ実行用の executionId。
    例外:
    JobStartException - このメソッドの他のチェックされた例外によってリストされたもの以外のエラー条件が発生した場合にスローされます。バッチランタイムの実装では、事前の検証を介して、または実行後に特定の条件を検出するという選択肢があることに注意してください。これは、1 つの実装が特定のエラー条件で JobStartException をスローする可能性がある一方で、別の実装はスローしない可能性があるという事実を打ち消します。
    JobSecurityException - これらのパラメーターを使用したこのメソッドの実行が（一部の実装固有のメカニズムによって）認可されていないと実装が判断した場合にスローされます。
  - restart
```
long restart(long executionId,
             PropertiesSE restartParameters)
      throws JobExecutionAlreadyCompleteException,
             NoSuchJobExecutionException,
             JobExecutionNotMostRecentException,
             JobRestartException,
             JobSecurityException
```
    非同期に実行される、失敗または停止したジョブインスタンスを再起動します。
    パラメーター:
    executionId - 再開する実行を指定します。この実行は、実行された最新の実行でなければなりません。
    restartParameters - ジョブ XML の属性置換のキーワードと値のペアを指定します。
    戻り値:
    新しい executionId
    例外:
    JobExecutionAlreadyCompleteException - executionId に関連付けられたジョブの実行が現在完了している場合にスローされます。
    NoSuchJobExecutionException - executionId パラメーター値が実装のリポジトリによって認識される実行に対応しない場合にスローされます。
    JobExecutionNotMostRecentException - executionId パラメーター値が対応するジョブインスタンスの最新の実行を表していない場合にスローされます。
    JobRestartException - このメソッドの他のチェックされた例外によってリストされたもの以外のエラー条件が発生した場合にスローされます。バッチランタイムの実装では、事前の検証を介して、または実行後に特定の条件を検出するという選択肢があることに注意してください。これは、1 つの実装が特定のエラー条件で JobRestartException をスローする可能性がある一方で、別の実装はスローしない可能性があるという事実を打ち消します。
    JobSecurityException - これらのパラメーターを使用したこのメソッドの実行が（一部の実装固有のメカニズムによって）認可されていないと実装が判断した場合にスローされます。
  - stop
```
void stop(long executionId)
   throws NoSuchJobExecutionException,
          JobExecutionNotRunningException,
          JobSecurityException
```
    実行中のジョブの実行停止リクエスト。このメソッドは、ジョブの実行を停止するよう通知してから戻ります。通常、ジョブの実行は停止し、非同期に実行されます。注 JobOperator は、ジョブの停止を保証できません。動作不良のバッチアプリケーションが制御を放棄しない可能性があります。
    パーティション化されたバッチレットステップの注意事項バッチレットの stop メソッドは、パーティションをアクティブに処理する各スレッドで呼び出されます。
    パラメーター:
    executionId - 停止するジョブの実行を指定します。ジョブの実行が実行されている必要があります。
    例外:
    NoSuchJobExecutionException - executionId パラメーター値が実装のリポジトリによって認識される実行に対応しない場合にスローされます。
    JobExecutionNotRunningException - 関連する実行が実行されていない場合（まだ STARTED または STARTING でない場合）にスローされます。
    JobSecurityException - これらのパラメーターを使用したこのメソッドの実行が（一部の実装固有のメカニズムによって）認可されていないと実装が判断した場合にスローされます。
  - abandon
```
void abandon(long executionId)
      throws NoSuchJobExecutionException,
             JobExecutionIsRunningException,
             JobSecurityException
```
    バッチステータスを ABANDONED に設定します。インスタンスには実行中の実行があってはなりません。
    ABANDONED 実行は再開できません。
    パラメーター:
    executionId - 破棄するジョブの実行を指定します。
    例外:
    NoSuchJobExecutionException - executionId パラメーター値が実装のリポジトリによって認識される実行に対応しない場合にスローされます。
    JobExecutionIsRunningException - executionId に関連付けられたジョブ実行が現在実行中の場合にスローされます
    JobSecurityException - これらのパラメーターを使用したこのメソッドの実行が（一部の実装固有のメカニズムによって）認可されていないと実装が判断した場合にスローされます。
  - getJobInstance
```
JobInstance getJobInstance(long executionId)
                    throws NoSuchJobExecutionException,
                           JobSecurityException
```
    指定された実行 ID のジョブインスタンスを返します。
    パラメーター:
    executionId - ジョブの実行を指定します。
    戻り値:
    ジョブインスタンス
    例外:
    NoSuchJobExecutionException - executionId パラメーター値が実装のリポジトリによって認識される実行に対応しない場合にスローされます。
    JobSecurityException - これらのパラメーターを使用したこのメソッドの実行が（一部の実装固有のメカニズムによって）認可されていないと実装が判断した場合にスローされます。
  - getJobExecutions
```
ListSE<JobExecution> getJobExecutions(JobInstance instance)
                             throws NoSuchJobInstanceException,
                                    JobSecurityException
```
    指定されたジョブインスタンスに属するすべてのジョブ実行を返します。
    パラメーター:
    instance - ジョブインスタンスを指定します。
    戻り値:
    ジョブ実行のリスト
    例外:
    NoSuchJobInstanceException - インスタンスパラメーター値が実装のリポジトリによって認識されるジョブインスタンスに対応しない場合にスローされます。
    JobSecurityException - これらのパラメーターを使用したこのメソッドの実行が（一部の実装固有のメカニズムによって）認可されていないと実装が判断した場合にスローされます。
  - getJobExecution
```
JobExecution getJobExecution(long executionId)
                      throws NoSuchJobExecutionException,
                             JobSecurityException
```
    指定された実行 ID のジョブ実行を返します。
    パラメーター:
    executionId - ジョブの実行を指定します。
    戻り値:
    ジョブ実行
    例外:
    NoSuchJobExecutionException - executionId パラメーター値が実装のリポジトリによって認識される実行に対応しない場合にスローされます。
    JobSecurityException - これらのパラメーターを使用したこのメソッドの実行が（一部の実装固有のメカニズムによって）認可されていないと実装が判断した場合にスローされます。
  - getStepExecutions
```
ListSE<StepExecution> getStepExecutions(long jobExecutionId)
                               throws NoSuchJobExecutionException,
                                      JobSecurityException
```
    指定された実行 ID の StepExecutions を返します。
    パラメーター:
    jobExecutionId - ジョブの実行を指定します。
    戻り値:
    ステップ実行 (オーダーは保証されません)
    例外:
    NoSuchJobExecutionException - jobExecutionId パラメーター値が実装のリポジトリによって認識される実行に対応しない場合にスローされます。
    JobSecurityException - これらのパラメーターを使用したこのメソッドの実行が（一部の実装固有のメカニズムによって）認可されていないと実装が判断した場合にスローされます。

インターフェース JobOperator

メソッドのサマリー

メソッドの詳細

getJobNames

getJobInstanceCount

getJobInstances

getRunningExecutions

getParameters

start

restart

stop

abandon

getJobInstance

getJobExecutions

getJobExecution

getStepExecutions