nablarch.fw.handler

クラス RetryHandler

java.lang.Object

nablarch.fw.handler.RetryHandler

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

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

public class RetryHandler
extends java.lang.Object
implements Handler<java.lang.Object,java.lang.Object>

リトライ可能な例外を捕捉した場合に後続ハンドラの処理をリトライするハンドラ。

Retryableインタフェースを実装した例外をリトライ可能な例外と判断する。

リトライ処理の制御はRetryHandler.RetryContextを実装したクラスに委譲する。 RetryHandler.RetryContextを実装したクラスはRetryHandler.RetryContextFactoryから取得するので、 本クラスを使用する場合はRetryHandler.RetryContextFactoryオブジェクトをプロパティに設定すること。

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static interface	RetryHandler.RetryContext リトライ処理を制御するインタフェース。
static interface	RetryHandler.RetryContextFactory リトライコンテキストを生成するインタフェース。

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.lang.Object	handle(java.lang.Object data, ExecutionContext context) 入力データに対する処理を実行する。
void	setDestroyReader(boolean destroyReader) リトライ時にExecutionContext上に設定されたDataReaderを破棄するか否かを設定する。。
void	setRetryContextFactory(RetryHandler.RetryContextFactory retryContextFactory) リトライコンテキストを生成するRetryHandler.RetryContextFactoryオブジェクトを設定する。
void	setRetryLimitExceededExitCode(int retryLimitExceededExitCode) リトライ上限を超えた場合に使用する終了コード(プロセスを終了(System.exit(int))する際に設定する値)を設定する。
void	setRetryLimitExceededFailureCode(java.lang.String retryLimitExceededFailureCode) リトライ上限を超えた場合に使用する障害コードを設定する。

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

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

コンストラクタの詳細

RetryHandler

public RetryHandler()

メソッドの詳細

handle

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

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

リトライ対象でない例外を捕捉した場合は、補足した例外を再送出する。
リトライ可能な例外を捕捉した場合、かつリトライ上限を超えていない場合は 後続ハンドラの処理をリトライする。 リトライ可能な例外を捕捉した場合、かつリトライ上限を超えている場合は retryLimitExceededExitCodeプロパティと retryLimitExceededFailureCodeプロパティを使用して ProcessAbnormalEndを送出する。

定義:

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

パラメータ:

data - 入力データ

context - 実行コンテキスト

戻り値:

処理結果データ

setDestroyReader

public void setDestroyReader(boolean destroyReader)

リトライ時にExecutionContext上に設定されたDataReaderを破棄するか否かを設定する。。

本設定値にtrueを設定した場合、リトライ時にExecutionContext上に設定されたDataReaderを破棄（削除）する。 これにより、後続ハンドラでDataReaderが再生成される。

パラメータ:

destroyReader - リトライ時にリーダを破棄するか否か

setRetryContextFactory

public void setRetryContextFactory(RetryHandler.RetryContextFactory retryContextFactory)

リトライコンテキストを生成するRetryHandler.RetryContextFactoryオブジェクトを設定する。

パラメータ:

retryContextFactory - リトライコンテキストを生成するRetryHandler.RetryContextFactoryオブジェクト

setRetryLimitExceededExitCode

public void setRetryLimitExceededExitCode(int retryLimitExceededExitCode)

リトライ上限を超えた場合に使用する終了コード(プロセスを終了(System.exit(int))する際に設定する値)を設定する。

パラメータ:

retryLimitExceededExitCode - リトライ上限を超えた場合に使用する終了コード(プロセスを終了(System.exit(int))する際に設定する値)

setRetryLimitExceededFailureCode

public void setRetryLimitExceededFailureCode(java.lang.String retryLimitExceededFailureCode)

リトライ上限を超えた場合に使用する障害コードを設定する。

パラメータ:

retryLimitExceededFailureCode - リトライ上限を超えた場合に使用する障害コード