Package nablarch.fw.batch.ee

Class JobExecutor

java.lang.Object
nablarch.fw.batch.ee.JobExecutor
public class JobExecutor extends Object
JOB の実行をするクラス

JOBを実行し、終了するまで待機して以下の戻り値を返す。

  • 正常終了：0 - 終了ステータスが "WARNING" 以外の場合で、バッチステータスが BatchStatus.COMPLETEDの場合
  • 異常終了：1 - 終了ステータスが "WARNING" 以外の場合で、バッチステータスが BatchStatus.COMPLETED 以外の場合
  • 警告終了：2 - 終了ステータスが "WARNING" の場合
なお、JOBの終了待ちの間に中断された場合は、異常終了のコードを返す。

バリデーションエラーなど警告すべき事項が発生している場合に、警告終了させることができる。 警告終了の方法はchunkまたはbatchlet内で、JobContext.setExitStatus(String)を 呼び出し "WARNING" を終了ステータスとして設定する。警告終了時は、バッチステータスは任意の値を許可するため、 chunkまたはbatchlet内で、 例外を送出しバッチステータスが BatchStatus.FAILED となる場合であっても、 終了ステータスに “WARNING” を設定していれば、警告終了する。

Author:
T.Shimoda

  • Constructor Summary

    Constructors
    Constructor
    Description
    JobExecutor(String jobXmlName, Properties properties)
    コンストラクタ

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    execute()
    JOBを実行する。JOBが終了または中断されるまで待機する。
    int
    execute(long mills)
    JOBを実行する。JOBが終了または中断されるまで待機する。 指定したミリ秒間隔で終了しているかどうかのチェックを行う。
    jakarta.batch.runtime.JobExecution
    getJobExecution()
    JOBの実行情報を返す。 開始時刻や終了時刻などJOBの詳細を取得したい場合にこのAPIから取得する。
    String
    getJobXmlName()
    JOB XMLファイル名を返す。

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • JobExecutor

      public JobExecutor(String jobXmlName, Properties properties)
      コンストラクタ
      Parameters:
      jobXmlName - JOB XMLファイル名
      properties - properties

  • Method Details

    • getJobXmlName

      public String getJobXmlName()
      JOB XMLファイル名を返す。
      Returns:
      JOB XMLファイル名

    • getJobExecution

      public jakarta.batch.runtime.JobExecution getJobExecution()
      JOBの実行情報を返す。 開始時刻や終了時刻などJOBの詳細を取得したい場合にこのAPIから取得する。
      Returns:
      JOBの実行情報、開始前はnullを返す。

    • execute

      public int execute()
      JOBを実行する。JOBが終了または中断されるまで待機する。
      Returns:
      終了コード

    • execute

      public int execute(long mills)
      JOBを実行する。JOBが終了または中断されるまで待機する。 指定したミリ秒間隔で終了しているかどうかのチェックを行う。
      Parameters:
      mills - 終了をチェックするミリ秒の間隔
      Returns:
      終了コード
      Throws:
      IllegalArgumentException - ミリ秒が0以下の場合