jp.terasoluna.fw.batch.standard
クラス StandardBLogicResultHandler

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

public class StandardBLogicResultHandler
extends java.lang.Object
implements BLogicResultHandler

BLogicResultHandler インタフェースの標準実装クラス。

ビジネスロジック処理結果を JobStatus に反映し、エラーである 場合にはログを出力する。


入れ子のクラスの概要
protected static class StandardBLogicResultHandler.LOG_TYPE
          ログレベル。
 
フィールドの概要
private  StandardBLogicResultHandler.LOG_TYPE bLogicErroresLogLevel
          エラーメッセージの出力ログレベル。
private  StandardBLogicResultHandler.LOG_TYPE bLogicMessagesLogLevel
          メッセージの出力ログレベル。
private static org.apache.commons.logging.Log log
          ログインスタンス。
private  MessageAccessor messageAccessor
          メッセージ取得クラスのインスタンス。
 
コンストラクタの概要
StandardBLogicResultHandler()
           
 
メソッドの概要
 void handle(BLogicResult blogicResult, java.lang.Object blogicInputData, JobStatus jobStatus, java.util.List<java.util.LinkedHashMap<java.lang.String,java.lang.Object>> batchUpdateMapList)
          BLogicの処理結果を処理する。
protected  void processBLogicMessages(BLogicResult blogicResult)
          BLogicMessagesの処理を行う。
protected  void processErrorContinue(java.lang.Object blogicInputData, JobStatus jobStatus, BLogicResult bLogicResult)
          BLogicResult のリターンコードが ERROR_CONTINUE であるときの処理を行う。
protected  void processErrorEnd(java.lang.Object blogicInputData, JobStatus jobStatus, BLogicResult bLogicResult)
          BLogicResult のリターンコードが ERROR_END で あるときの処理を行う。
protected  void processNormalContinue(JobStatus jobStatus, BLogicResult bLogicResult, java.util.List<java.util.LinkedHashMap<java.lang.String,java.lang.Object>> batchUpdateMapList)
          BLogicResult のリターンコードが NORMAL_CONTINUE であるときの処理を行う。
protected  void processNormalEnd(JobStatus jobStatus, BLogicResult bLogicResult, java.util.List<java.util.LinkedHashMap<java.lang.String,java.lang.Object>> batchUpdateMapList)
          BLogicResult のリターンコードが NORMAL_END で あるときの処理を行う。
 void setBLogicErroresLogLevel(java.lang.String logLevel)
          ビジネスロジック内で生成されたエラーメッセージの出力ログレベルを設定する。
 void setBLogicMessagesLogLevel(java.lang.String logLevel)
          ビジネスロジック内で生成されたメッセージの出力ログレベルを設定する。
 void setMessageAccessor(MessageAccessor messageAccessor)
          メッセージ取得クラスのインスタンスを設定する。
protected  void writeBLogicMessagesLog(BLogicMessages blogicMessages, StandardBLogicResultHandler.LOG_TYPE logType)
          BLogicMessageリストを指定のログレベルへ出力する。
protected  void writeErrorLog(java.lang.String message, JobStatus jobStatus, BLogicResult bLogicResult, java.lang.Object blogicInputData)
          ビジネスロジックでのエラーデータをログに出力する。
protected  void writeLog(java.lang.String message, StandardBLogicResultHandler.LOG_TYPE logType)
          指定のログレベルへメッセージを出力する。
protected  void writeWarnLog(java.lang.String message, JobStatus jobStatus, BLogicResult bLogicResult, java.lang.Object blogicInputData)
          ビジネスロジックでの警告データをログに出力する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

log

private static org.apache.commons.logging.Log log
ログインスタンス。


messageAccessor

private MessageAccessor messageAccessor
メッセージ取得クラスのインスタンス。


bLogicMessagesLogLevel

private StandardBLogicResultHandler.LOG_TYPE bLogicMessagesLogLevel
メッセージの出力ログレベル。


bLogicErroresLogLevel

private StandardBLogicResultHandler.LOG_TYPE bLogicErroresLogLevel
エラーメッセージの出力ログレベル。

コンストラクタの詳細

StandardBLogicResultHandler

public StandardBLogicResultHandler()
メソッドの詳細

handle

public void handle(BLogicResult blogicResult,
                   java.lang.Object blogicInputData,
                   JobStatus jobStatus,
                   java.util.List<java.util.LinkedHashMap<java.lang.String,java.lang.Object>> batchUpdateMapList)
BLogicの処理結果を処理する。

定義:
インタフェース BLogicResultHandler 内の handle
パラメータ:
blogicResult - ビジネスロジック処理結果
blogicInputData - ビジネスロジックの入力データ
jobStatus - ジョブステータス
batchUpdateMapList - バッチ更新リスト

processBLogicMessages

protected void processBLogicMessages(BLogicResult blogicResult)
BLogicMessagesの処理を行う。
BLogicResultBLogicResult.setErrors(BLogicMessages)BLogicResult.setMessages(BLogicMessages)で設定されたメッセージの 処理を行う。

デフォルト処理は以下である。
  • setMessages(BLogicMessages): INFOレベルのログの出力
  • setErrors(BLogicMessages): ERRORレベルのログの出力


  • このメソッドを再定義することでBLogicMessageの処理を変更することができる。

    パラメータ:
    blogicResult - ビジネスロジック処理結果

    processNormalContinue

    protected void processNormalContinue(JobStatus jobStatus,
                                         BLogicResult bLogicResult,
                                         java.util.List<java.util.LinkedHashMap<java.lang.String,java.lang.Object>> batchUpdateMapList)
    BLogicResult のリターンコードが NORMAL_CONTINUE であるときの処理を行う。

    BLogicResultがバッチ更新情報を保持していた場合には、バッチ更新リストに 追加する。

    パラメータ:
    jobStatus - ジョブステータス
    bLogicResult - ビジネスロジック処理結果
    batchUpdateMapList - バッチ更新リスト

    processNormalEnd

    protected void processNormalEnd(JobStatus jobStatus,
                                    BLogicResult bLogicResult,
                                    java.util.List<java.util.LinkedHashMap<java.lang.String,java.lang.Object>> batchUpdateMapList)
    BLogicResult のリターンコードが NORMAL_END で あるときの処理を行う。

    BLogicResultがバッチ更新情報を保持していた場合には、バッチ更新リストに 追加する。

    JobStatus

    のジョブ状態 JobStatus.STATE.ENDING_NORMALLY に更新し、BLogicResult のジョブ終了コードを JobStatus に反映する。

    パラメータ:
    jobStatus - ジョブステータス
    bLogicResult - ビジネスロジック処理結果
    batchUpdateMapList - バッチ更新リスト

    processErrorContinue

    protected void processErrorContinue(java.lang.Object blogicInputData,
                                        JobStatus jobStatus,
                                        BLogicResult bLogicResult)
    BLogicResult のリターンコードが ERROR_CONTINUE であるときの処理を行う。

    警告ログを出力する。

    BLogicResult がジョブ終了コードを持っている場合JobStatus に反映する。

    BLogicResult がバッチ更新情報を持っていた場合でも無視される。

    パラメータ:
    blogicInputData - ビジネスロジックの入力データ
    jobStatus - ジョブステータス
    bLogicResult - ビジネスロジック処理結果

    processErrorEnd

    protected void processErrorEnd(java.lang.Object blogicInputData,
                                   JobStatus jobStatus,
                                   BLogicResult bLogicResult)
    BLogicResult のリターンコードが ERROR_END で あるときの処理を行う。

    エラーログを出力する。

    JobStatus

    のジョブ状態 JobStatus.STATE.ENDING_ABNORMALLY に更新し、BLogicResult のジョブ終了コードを JobStatus に反映する。

    パラメータ:
    blogicInputData - ビジネスロジックの入力データ
    jobStatus - ジョブステータス
    bLogicResult - ビジネスロジック処理結果

    writeErrorLog

    protected void writeErrorLog(java.lang.String message,
                                 JobStatus jobStatus,
                                 BLogicResult bLogicResult,
                                 java.lang.Object blogicInputData)
    ビジネスロジックでのエラーデータをログに出力する。

    パラメータ:
    message - メッセージ
    jobStatus - ジョブステータス
    bLogicResult - ビジネスロジック処理結果
    blogicInputData - ビジネスロジックの入力データ

    writeWarnLog

    protected void writeWarnLog(java.lang.String message,
                                JobStatus jobStatus,
                                BLogicResult bLogicResult,
                                java.lang.Object blogicInputData)
    ビジネスロジックでの警告データをログに出力する。

    パラメータ:
    message - メッセージ
    jobStatus - ジョブステータス
    bLogicResult - ビジネスロジック処理結果
    blogicInputData - ビジネスロジックの入力データ

    writeBLogicMessagesLog

    protected void writeBLogicMessagesLog(BLogicMessages blogicMessages,
                                          StandardBLogicResultHandler.LOG_TYPE logType)
    BLogicMessageリストを指定のログレベルへ出力する。

    パラメータ:
    blogicMessages - BLogicMessageリスト
    logType - ログレベル

    writeLog

    protected void writeLog(java.lang.String message,
                            StandardBLogicResultHandler.LOG_TYPE logType)
    指定のログレベルへメッセージを出力する。

    パラメータ:
    message - メッセージ
    logType - ログレベル

    setMessageAccessor

    public void setMessageAccessor(MessageAccessor messageAccessor)
    メッセージ取得クラスのインスタンスを設定する。

    パラメータ:
    messageAccessor - メッセージ取得クラスのインスタンス

    setBLogicErroresLogLevel

    public void setBLogicErroresLogLevel(java.lang.String logLevel)
    ビジネスロジック内で生成されたエラーメッセージの出力ログレベルを設定する。

    パラメータ:
    logLevel - 出力ログレベル

    setBLogicMessagesLogLevel

    public void setBLogicMessagesLogLevel(java.lang.String logLevel)
    ビジネスロジック内で生成されたメッセージの出力ログレベルを設定する。

    パラメータ:
    logLevel - 出力ログレベル