jp.terasoluna.fw.batch.openapi
クラス JobContext

java.lang.Object
  上位を拡張 jp.terasoluna.fw.batch.openapi.JobContext
すべての実装されたインタフェース:
java.io.Serializable
直系の既知のサブクラス:
AsyncJobContext

public class JobContext
extends java.lang.Object
implements java.io.Serializable

基本ジョブコンテキストクラス。

対象データ取得処理、ビジネスロジック、前処理/後処理で共有され、 フレームワークにより基本属性が設定される。
個別のジョブを定義する際に、開発者がそのジョブの引継ぎ情報の項目に対応して カスタム属性を拡張して定義することができる。

拡張ジョブコンテキストのBean定義例

開発者が拡張したジョブコンテキストをジョブBean定義ファイルに設定する。

     <bean id="jobContext"
              class="jp.terasoluna.fw.batch.sample.checksample.SampleJobContext" />
 

関連項目:
直列化された形式

入れ子のクラスの概要
static class JobContext.START_TYPE
          ジョブ起動種別。
 
フィールドの概要
protected  java.lang.String jobId
          ジョブID。
protected  java.lang.String jobRequestNo
          ジョブリクエスト番号。
protected  java.lang.String[] parameter
          起動時の引数。
protected  java.lang.String partitionKey
          分割ジョブのパーティションキー。
protected  int partitionNo
          分割ジョブのパーティション番号。
protected  boolean restartable
          リスタート可能フラグ。
protected  boolean restarted
          リスタート実行フラグ。
protected  int restartPoint
          リスタートポイント。
private static long serialVersionUID
          Serializable用バージョンID。
protected  JobContext.START_TYPE startType
          ジョブ起動種別。
 
コンストラクタの概要
JobContext()
           
 
メソッドの概要
 JobContext getChildJobContext(java.lang.Object partitionKey)
          パーティションキーが設定される子ジョブコンテキストを返却する。
 java.lang.String getJobId()
          ジョブIDを返却する。
 java.lang.String getJobRequestNo()
          ジョブ依頼番号を返却する。
 java.lang.String[] getParameter()
          起動時の引数を返却する。
 java.lang.String getPartitionKey()
          パーティションキーを取得する。
 int getPartitionNo()
          パーティション番号を返却する。
 int getRestartPoint()
          リスタートポイントを返却する。
 JobContext.START_TYPE getStartType()
          起動種別を返却する。
 boolean isRestartable()
          実行中のジョブがリスタート可能なジョブとして設定されているかを取得する。
 boolean isRestarted()
          リスタート実行フラグを取得する。
 void setJobId(java.lang.String jobId)
          ジョブIDを設定する。
 void setJobRequestNo(java.lang.String jobRequestNo)
          ジョブ依頼番号を設定する。
 void setParameter(java.lang.String[] arg)
          起動時の引数をジョブコンテキストに設定する。
 void setPartitionKey(java.lang.String partitionKey)
          パーティションキーを設定する。
 void setPartitionNo(int partitionNo)
          パーティション番号を設定する。
 void setRestartable(boolean restartable)
          実行中のジョブがリスタート可能なジョブかどうかを設定する。
 void setRestarted(boolean restarted)
          リスタート実行フラグを設定する。
 void setRestartPoint(int restartPoint)
          リスタートポイントを設定する。
 void setStartType(JobContext.START_TYPE startType)
          起動種別を設定する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

serialVersionUID

private static final long serialVersionUID
Serializable用バージョンID。

関連項目:
定数フィールド値

jobId

protected java.lang.String jobId
ジョブID。


jobRequestNo

protected java.lang.String jobRequestNo
ジョブリクエスト番号。


partitionKey

protected java.lang.String partitionKey
分割ジョブのパーティションキー。


partitionNo

protected int partitionNo
分割ジョブのパーティション番号。


restartable

protected boolean restartable
リスタート可能フラグ。


restarted

protected boolean restarted
リスタート実行フラグ。


restartPoint

protected int restartPoint
リスタートポイント。


startType

protected JobContext.START_TYPE startType
ジョブ起動種別。


parameter

protected java.lang.String[] parameter
起動時の引数。

コンストラクタの詳細

JobContext

public JobContext()
メソッドの詳細

getChildJobContext

public JobContext getChildJobContext(java.lang.Object partitionKey)
パーティションキーが設定される子ジョブコンテキストを返却する。
分割ジョブ時、親ジョブから呼ばれる。
パーティション番号はハンドラから設定される。

パラメータ:
partitionKey - パーティションキー
戻り値:
子ジョブのジョブコンテキスト
例外:
java.lang.IllegalArgumentException - パーティションキーがNULLまたは空白文字列

getJobId

public java.lang.String getJobId()
ジョブIDを返却する。

戻り値:
ジョブID

getJobRequestNo

public java.lang.String getJobRequestNo()
ジョブ依頼番号を返却する。

戻り値:
ジョブ依頼番号

getPartitionKey

public java.lang.String getPartitionKey()
パーティションキーを取得する。

戻り値:
文字例のパーティションキー

getPartitionNo

public int getPartitionNo()
パーティション番号を返却する。

戻り値:
パーティション番号

getRestartPoint

public int getRestartPoint()
リスタートポイントを返却する。

戻り値:
リスタートポイント

getStartType

public JobContext.START_TYPE getStartType()
起動種別を返却する。

戻り値:
起動種別

getParameter

public java.lang.String[] getParameter()
起動時の引数を返却する。

戻り値:
起動時の引数

isRestartable

public boolean isRestartable()
実行中のジョブがリスタート可能なジョブとして設定されているかを取得する。

戻り値:
リスタート可能なジョブであれば true

isRestarted

public boolean isRestarted()
リスタート実行フラグを取得する。

戻り値:
リスタート実行フラグ。 スタートポイントから再開されたジョブの実行である場合には、 true

setJobId

public void setJobId(java.lang.String jobId)
ジョブIDを設定する。

パラメータ:
jobId - ジョブID

setJobRequestNo

public void setJobRequestNo(java.lang.String jobRequestNo)
ジョブ依頼番号を設定する。

パラメータ:
jobRequestNo - ジョブ依頼番号

setParameter

public void setParameter(java.lang.String[] arg)
起動時の引数をジョブコンテキストに設定する。

パラメータ:
arg - 起動時に指定した第3引数以降の値

setPartitionNo

public void setPartitionNo(int partitionNo)
パーティション番号を設定する。

パラメータ:
partitionNo - パーティション番号

setRestartable

public void setRestartable(boolean restartable)
実行中のジョブがリスタート可能なジョブかどうかを設定する。

フレームワークによってジョブ初期化時に設定される

パラメータ:
restartable - リスタート可能なジョブであれば true

setRestarted

public void setRestarted(boolean restarted)
リスタート実行フラグを設定する。

リスタート実行フラグは、フレームワークによってジョブ初期化時に設定され る

パラメータ:
restarted - スタートポイントから再開されたジョブの実行である場合には、 true

setRestartPoint

public void setRestartPoint(int restartPoint)
リスタートポイントを設定する。

リスタートポイントは、フレームワークによってジョブ初期化時に設定され る

パラメータ:
restartPoint - リスタートポイント

setStartType

public void setStartType(JobContext.START_TYPE startType)
起動種別を設定する。

起動種別は、フレームワークによってジョブ初期化時に設定される

パラメータ:
startType - 起動種別

setPartitionKey

public void setPartitionKey(java.lang.String partitionKey)
パーティションキーを設定する。

パーティションキーは、分割ジョブ時、フレームワークによって子ジョブの ジョブコンテキストに設定される

パラメータ:
partitionKey - パーティションキー