nablarch.common.handler

クラス TransactionManagementHandler

java.lang.Object

nablarch.fw.TransactionEventCallback.Provider<java.lang.Object>

nablarch.common.handler.TransactionManagementHandler

すべての実装されたインタフェース:

Handler<java.lang.Object,java.lang.Object>, InboundHandleable, OutboundHandleable

public class TransactionManagementHandler
extends TransactionEventCallback.Provider<java.lang.Object>
implements Handler<java.lang.Object,java.lang.Object>, InboundHandleable, OutboundHandleable

後続処理における透過的トランザクションを実現するハンドラ。
通常の として使用する場合と、 として使用する場合で動作が異なる。

  として使用する場合、本ハンドラの詳細な処理内容は以下の通り。

 1.  トランザクションファクトリから使用するトランザクションオブジェクトを取得し、
     TransactionContext上に設定する。
 2.  トランザクションを開始する。
 3.  ハンドラスタックから次のリクエストハンドラを取得し、処理を委譲する。
 4a. 委譲先の処理において例外が発生しなければトランザクションをコミットする。
 4b. 例外が発生した場合はトランザクションをロールバックする。
     ただし、このとき送出された例外が、setTransactionCommitExceptions(java.util.List)で設定された例外の
     いずれかのサブクラスである場合はトランザクションをコミットする。
 5.  トランザクションオブジェクトをTransactionContextから除去する。

 設定例:

 
 <component class="nablarch.common.handler.TransactionManagementHandler">
      <!-- トランザクションファクトリ -->
      <property name="transactionFactory"
                value="transactionFactory"/>
      <!-- トランザクションをコミットする例外 -->
      <property name="transactionCommitExceptions">
          <list>
              <value>example.TransactionCommitException</value>
              <value>example.TransactionCommitException2</value>
          </list>
      </property>
 </component>
 
 

として使用する場合、Inbound処理の際にトランザクションを開始し、 Outbound処理の際にトランザクションをコミットまたはロールバックする。
コミットとロールバックの判定は、 isProcessSucceded が true を返すか false を返すかで判定する。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
TransactionManagementHandler()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.lang.Object	handle(java.lang.Object inputData, ExecutionContext ctx) 入力データに対する処理を実行する。
Result	handleInbound(ExecutionContext context) 前処理を実装する。
Result	handleOutbound(ExecutionContext context) 後処理を実装する。
protected boolean	isCompleteTransaction(ExecutionContext context) トランザクションが正常終了したかどうかを判定する。
void	setTransactionCommitExceptions(java.util.List<java.lang.String> exceptionClassNames) 送出されてもトランザクションをコミットしなければならない例外クラスの一覧を設定する。
void	setTransactionFactory(TransactionFactory transactionFactory) トランザクションオブジェクトを取得するためのファクトリを設定する。
void	setTransactionName(java.lang.String transactionName) このハンドラが管理するトランザクションの、スレッドコンテキスト上での登録名を設定する。

クラスから継承されたメソッド nablarch.fw.TransactionEventCallback.Provider

callAbnormalEndHandlers, callNormalEndHandlers, prepareListeners

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

TransactionManagementHandler

public TransactionManagementHandler()

メソッドの詳細

setTransactionFactory

public void setTransactionFactory(TransactionFactory transactionFactory)

トランザクションオブジェクトを取得するためのファクトリを設定する。

パラメータ:

transactionFactory - トランザクションオブジェクトを取得するためのファクトリ

setTransactionName

public void setTransactionName(java.lang.String transactionName)

このハンドラが管理するトランザクションの、スレッドコンテキスト上での登録名を設定する。

 デフォルトでは既定のトランザクション名
 (TransactionContext.DEFAULT_TRANSACTION_CONTEXT_KEY)を使用する。

 

パラメータ:

transactionName - データベース接続のスレッドコンテキスト上の登録名

setTransactionCommitExceptions

public void setTransactionCommitExceptions(java.util.List<java.lang.String> exceptionClassNames)

送出されてもトランザクションをコミットしなければならない例外クラスの一覧を設定する。

 指定可能な例外は実行時例外（RuntimeExceptionのサブクラス）のみである。
 なにも指定しなかった場合はいかなる例外についてもロールバックする。
 

パラメータ:

exceptionClassNames - 送出されてもトランザクションをコミットしなければならない例外クラスの一覧

handle

public java.lang.Object handle(java.lang.Object inputData,
                               ExecutionContext ctx)

入力データに対する処理を実行する。

 このクラスの実装では後続ハンドラに対する処理委譲の前後に、
 データベース接続オブジェクトの初期化と終了の処理をそれぞれ行う。
 

定義:

handle インタフェース内 Handler<java.lang.Object,java.lang.Object>

パラメータ:

inputData - 入力データ

ctx - 実行コンテキスト

戻り値:

処理結果データ

handleInbound

public Result handleInbound(ExecutionContext context)

インタフェースからコピーされた説明: InboundHandleable

前処理を実装する。

定義:

handleInbound インタフェース内 InboundHandleable

パラメータ:

context - ExecutionContext

戻り値:

処理結果オブジェクト

handleOutbound

public Result handleOutbound(ExecutionContext context)

インタフェースからコピーされた説明: OutboundHandleable

後処理を実装する。

定義:

handleOutbound インタフェース内 OutboundHandleable

パラメータ:

context - ExecutionContext

戻り値:

処理結果オブジェクト

isCompleteTransaction

protected boolean isCompleteTransaction(ExecutionContext context)

トランザクションが正常終了したかどうかを判定する。
この実装では、ExecutionContext#isProcessSucceded() がtrueを返すかどうかで、判定を行う。

パラメータ:

context - ExecutionContext

戻り値:

正常終了した場合 true