nablarch.fw.handler

クラス LoopHandler

java.lang.Object

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

nablarch.fw.handler.LoopHandler

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

Handler<java.lang.Object,Result>

public class LoopHandler
extends TransactionEventCallback.Provider<java.lang.Object>
implements Handler<java.lang.Object,Result>

ループ制御ハンドラークラス。

本ハンドラは、アプリケーションが処理すべきデータが存在する間、後続のハンドラに対して繰り返し処理を委譲する。 処理すべきデータが存在するかは、ExecutionContext.hasNextData()により判断する。

また、本ハンドラではトランザクション制御もあわせて行う。 トランザクションは、指定間隔(setCommitInterval(int)毎にコミット処理を行う。 後続ハンドラから例外が送出された場合には、未コミットのトランザクションを全てロールバックし、例外を再送出する。

本ハンドラの事前ハンドラとして、DbConnectionManagementHandlerを登録すること。

関連項目:

DataReader.NoMoreRecord, CommitLogger, TransactionContext, TransactionFactory, TransactionExecutor

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
Result	handle(java.lang.Object data, ExecutionContext context) 入力データに対する処理を実行する。
static boolean	isAboutToCommit(ExecutionContext ctx) 現在のリクエストループの業務アクション実行後にLoopHandlerによるコミットが行われるか否か。
LoopHandler	setCommitInterval(int commitInterval) コミット間隔を設定する。
LoopHandler	setTransactionFactory(TransactionFactory transactionFactory) トランザクションオブジェクトを取得するためのファクトリを設定する。
void	setTransactionName(java.lang.String transactionName) このハンドラが管理するトランザクションの、スレッドコンテキスト上での登録名を設定する。
boolean	shouldStop(ExecutionContext context) 現在の処理終了後にループを止める場合にtrueを返す。

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

callAbnormalEndHandlers, callNormalEndHandlers, prepareListeners

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

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

コンストラクタの詳細

LoopHandler

public LoopHandler()

メソッドの詳細

handle

public Result handle(java.lang.Object data,
                     ExecutionContext context)

入力データに対する処理を実行する。 この実装では、特定の条件を満たすまで、以降のハンドラキューの内容を 繰り返し処理する。

定義:

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

パラメータ:

data - 入力データ

context - 実行コンテキスト

戻り値:

処理結果データ

shouldStop

public boolean shouldStop(ExecutionContext context)

現在の処理終了後にループを止める場合にtrueを返す。

デフォルトの実装では、実行コンテキスト上のデータリーダのデータが 空になるまで繰り返し処理を行う。

これと異なる条件でループを停止させたい場合は、本メソッドをオーバライドすること。

パラメータ:

context - 実行コンテキスト

戻り値:

ループを止める場合はtrue

setTransactionFactory

public LoopHandler setTransactionFactory(TransactionFactory transactionFactory)

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

パラメータ:

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

戻り値:

このハンドラ自体

setTransactionName

public void setTransactionName(java.lang.String transactionName)

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

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

 

パラメータ:

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

setCommitInterval

public LoopHandler setCommitInterval(int commitInterval)

コミット間隔を設定する。

コミット間隔を指定した場合、指定した間隔でコミットが行われる。 なお、0以下の値を設定した場合や、設定を省略した場合のコミット間隔は1となる。

パラメータ:

commitInterval - コミット間隔

戻り値:

このハンドラ自体

isAboutToCommit

public static final boolean isAboutToCommit(ExecutionContext ctx)

現在のリクエストループの業務アクション実行後にLoopHandlerによるコミットが行われるか否か。 本メソッドは DataReadHandler よりも後ろで呼び出された場合のみ正しい結果が得られる。

パラメータ:

ctx - 実行コンテキスト

戻り値:

業務アクション実行後にコミットが行われる場合は true