com.nec.webotx.batch
クラス BSJobRequestStatus

java.lang.Object
  上位を拡張 com.nec.webotx.batch.BSJobRequestStatus
すべての実装されたインタフェース:
Serializable

public class BSJobRequestStatus
extends Object
implements Serializable

WebOTX Batch Serverによるジョブ実行要求の状態をあらわします。

BSJobRequestStatusは、下記の結果が関連します

  1. ジョブリクエストの状態
    getJobRequestStatus() - ジョブの開始要求が投入されてからの実行状態
  2. バッチコンテナによるジョブの実行状態
    getExitStatusCode() - ジョブの実行結果の文字列を返します
    getBatchStatusCode() - ジョブの状態を返します。

WebOTX Batch Server V8.3では、
getExitStatusCode()として Spring BatchのExitStatus#toString()の結果を返します。
また、
getBatchStatusCode()としてSpring BatchのBatchStatus#toString()の結果を返します。

バージョン:
WebOTX Batch Server V8.3
関連項目:
直列化された形式

入れ子のクラスの概要
static class BSJobRequestStatus.Status
          Native向けのジョブリクエスト状態を表します
 
フィールドの概要
static String[] JBS_INTERNAL_INFO
          内部情報です
 
コンストラクタの概要
BSJobRequestStatus()
          BSJobRequestStatusを初期化します。
BSJobRequestStatus(com.nec.webotx.batch.core.execution.request.JobRequest request)
          指定したJobRequestから必要な情報を抽出してBSJobRequestStatusを初期化します。
 
メソッドの概要
 String getAcceptedContainerFullName()
          ジョブが実行されたバッチコンテナプロセスの名前を取得します。
 String getAcceptedContainerName()
          ジョブが実行されたバッチコンテナの名前を取得します。
 String getAcceptedDomainHome()
          ジョブが実行されたバッチドメインのDOMAIN_HOMEを取得します。
 String getAcceptedDomainName()
          ジョブが実行されたバッチドメインのドメイン名を取得します。
 String getBatchStatusCode()
          ジョブのステータスを取得します。
 String getExitDescription()
          ジョブの終了メッセージを取得します。
 String getExitStatusCode()
          ジョブのExitStatusを取得します。
 BSJobException getJobException()
          ジョブ実行中に発生した例外を取得します。
 long getJobExecutionId()
          ジョブのExceutionIDを取得します。
 long getJobInstanceId()
          ジョブのInstanceIDを取得します。
 String getJobKey()
          ジョブ名とジョブパラメータにより生成されたキーを取得します。
 JobName getJobName()
          JobNameを取得します。
 Exception getJobRequestException()
           
 String getJobRequestPath()
           
 com.nec.webotx.batch.core.execution.request.JobRequestStatus getJobRequestStatus()
           
 String getReqId()
          リクエストIDを取得します。
 BSJobRequestStatus.Status getStatus()
          ジョブリクエストのステータスを取得します。
 boolean isFailed()
           
 boolean isStarted()
          すでに開始済みと認識されているジョブかどうかを判定します。
 boolean isStopped()
          すでに停止していると認識されているジョブかどうかを判定します。
 void setJobKey(String jobKey)
          ジョブ名とジョブパラメータにより生成されたキーを設定します。
 void setJobName(JobName jobName)
          JobNameを設定します。
 void setJobName(String batchapg, String batchap, String jobname)
          バッチアプリケーショングループ名、バッチアプリケーション名、ジョブ名を指定してJobNameを設定します。
 void setJobRequestException(Exception exception)
           
 void setJobRequestPath(com.nec.webotx.batch.core.JobRequestPath jobRequestPath)
           
 void setJobRequestStatus(com.nec.webotx.batch.core.execution.request.JobRequestStatus jobRequestStatus)
           
 void setReqId(String reqId)
          リクエストIDを設定します。
 void setRuntimeJobStatus(com.nec.webotx.batch.core.execution.RuntimeJobStatus status)
          ジョブの実行状態を設定します。
 void setStatus(BSJobRequestStatus.Status status)
          ジョブリクエストのステータスを設定します。
 String toString()
           
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

JBS_INTERNAL_INFO

public static final String[] JBS_INTERNAL_INFO
内部情報です

コンストラクタの詳細

BSJobRequestStatus

public BSJobRequestStatus()
BSJobRequestStatusを初期化します。


BSJobRequestStatus

public BSJobRequestStatus(com.nec.webotx.batch.core.execution.request.JobRequest request)
指定したJobRequestから必要な情報を抽出してBSJobRequestStatusを初期化します。

内部的に利用されるメソッドです。

パラメータ:
request -
メソッドの詳細

getJobName

public JobName getJobName()
JobNameを取得します。

戻り値:
JobName

setJobName

public void setJobName(JobName jobName)
JobNameを設定します。

内部的に利用されるメソッドです。

パラメータ:
jobName - JobName

setJobName

public void setJobName(String batchapg,
                       String batchap,
                       String jobname)
バッチアプリケーショングループ名、バッチアプリケーション名、ジョブ名を指定してJobNameを設定します。

パラメータ:
batchapg - バッチアプリケーショングループ名
batchap - バッチアプリケーション名
jobname - ジョブ名

setJobRequestPath

public void setJobRequestPath(com.nec.webotx.batch.core.JobRequestPath jobRequestPath)

setJobRequestStatus

public void setJobRequestStatus(com.nec.webotx.batch.core.execution.request.JobRequestStatus jobRequestStatus)

getJobKey

public String getJobKey()
ジョブ名とジョブパラメータにより生成されたキーを取得します。

戻り値:
キー

setJobKey

public void setJobKey(String jobKey)
ジョブ名とジョブパラメータにより生成されたキーを設定します。

内部的に利用されるメソッドです。

パラメータ:
jobKey - キー

getReqId

public String getReqId()
リクエストIDを取得します。

ジョブの実行時にリクエストIDが指定されていない場合はnullを返します。

戻り値:
the reqId

setReqId

public void setReqId(String reqId)
リクエストIDを設定します。

内部的に利用されるメソッドです。

パラメータ:
reqId - リクエストID

getExitStatusCode

public String getExitStatusCode()
ジョブのExitStatusを取得します。

戻り値:
ExitStatus

getExitDescription

public String getExitDescription()
ジョブの終了メッセージを取得します。

戻り値:
終了メッセージ

getBatchStatusCode

public String getBatchStatusCode()
ジョブのステータスを取得します。

下記いずれかの文字列が返ります。


getStatus

public BSJobRequestStatus.Status getStatus()
ジョブリクエストのステータスを取得します。

戻り値:
the status
関連項目:
BSJobRequestStatus.Status

setStatus

public void setStatus(BSJobRequestStatus.Status status)
ジョブリクエストのステータスを設定します。

パラメータ:
status - the status to set

getJobException

public BSJobException getJobException()
ジョブ実行中に発生した例外を取得します。

ジョブが実行されていない場合はnullを返します。

戻り値:
ジョブ実行中に発生した例外

getJobInstanceId

public long getJobInstanceId()
ジョブのInstanceIDを取得します。

ジョブが実行されていない場合は-1Lを返します。

戻り値:
JobInstanceId

getJobExecutionId

public long getJobExecutionId()
ジョブのExceutionIDを取得します。

ジョブが実行されていない場合は-1Lを返します。

戻り値:
JobExecutionId

getAcceptedDomainName

public String getAcceptedDomainName()
ジョブが実行されたバッチドメインのドメイン名を取得します。

ジョブが実行されていない場合はnullを返します。

戻り値:
ジョブが実行されたバッチドメインのドメイン名

getAcceptedDomainHome

public String getAcceptedDomainHome()
ジョブが実行されたバッチドメインのDOMAIN_HOMEを取得します。

ジョブが実行されていない場合はnullを返します。

戻り値:
ジョブが実行されたバッチドメインのDOMAIN_HOME

getAcceptedContainerName

public String getAcceptedContainerName()
ジョブが実行されたバッチコンテナの名前を取得します。

ジョブが実行されていない場合はnullを返します。

戻り値:
ジョブが実行されたバッチコンテナの名前

getAcceptedContainerFullName

public String getAcceptedContainerFullName()
ジョブが実行されたバッチコンテナプロセスの名前を取得します。

バッチコンテナプロセスの名前は、
コンテナ名-シーケンス番号-プロセスID
により表現されます。

ジョブが実行されていない場合はnullを返します。

戻り値:
ジョブが実行されたバッチコンテナプロセスの名前

setRuntimeJobStatus

public void setRuntimeJobStatus(com.nec.webotx.batch.core.execution.RuntimeJobStatus status)
ジョブの実行状態を設定します。

内部的に利用されるメソッドです。

パラメータ:
status -

isStarted

public boolean isStarted()
すでに開始済みと認識されているジョブかどうかを判定します。

開始済みであるかどうかのみを判断し、実行中であるかどうかは問いません。
そのため、ジョブの停止後もこの値はtrueを返します。

戻り値:
ジョブを開始した場合true。

isStopped

public boolean isStopped()
すでに停止していると認識されているジョブかどうかを判定します。

Batch Statusが STARTED、STARTING以外であれば終了していると判断します。
開始済みでない場合もfalseを返します。

戻り値:
開始済みジョブが終了している場合true。

toString

public String toString()
オーバーライド:
クラス Object 内の toString

getJobRequestPath

public String getJobRequestPath()

getJobRequestStatus

public com.nec.webotx.batch.core.execution.request.JobRequestStatus getJobRequestStatus()

setJobRequestException

public void setJobRequestException(Exception exception)

getJobRequestException

public Exception getJobRequestException()

isFailed

public boolean isFailed()
戻り値:


Copyright © 2012 NEC Corporation. All Rights Reserved.