nablarch.fw.handler.retry

クラス RetryContextSupport

java.lang.Object

nablarch.fw.handler.retry.RetryContextSupport

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

RetryHandler.RetryContext

直系の既知のサブクラス:

CountingRetryContext, TimeRetryContext

public abstract class RetryContextSupport
extends java.lang.Object
implements RetryHandler.RetryContext

RetryHandler.RetryContextの実装をサポートするクラス。

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

コンストラクタ

修飾子	コンストラクタと説明
protected	RetryContextSupport(long maxRetryTime, long retryIntervals) コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	assertMaxRetryTime(long maxRetryTime, long minRetryTime) 最長リトライ時間の設定値が正しいことを表明する。
int	getCurrentRetryCount() 現在のリトライ回数を取得する。
boolean	isRetryable() リトライ可能か否かをリトライ状態から判定する。
protected abstract boolean	onIsRetryable() リトライ可能か否かをリトライ状態から判定する。
void	prepareRetry() リトライ前の準備を行う。
void	reset() リトライ状態をリセットする。

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

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

コンストラクタの詳細

RetryContextSupport

protected RetryContextSupport(long maxRetryTime,
                              long retryIntervals)

コンストラクタ。

パラメータ:

maxRetryTime - 最長リトライ時間(単位:msec)

retryIntervals - リトライ間隔(単位:msec)

メソッドの詳細

assertMaxRetryTime

protected void assertMaxRetryTime(long maxRetryTime,
                                  long minRetryTime)

最長リトライ時間の設定値が正しいことを表明する。

最短リトライ時間以下の値が最長リトライ時間に指定された場合は実行時例外を送出する。

本メソッドはサブクラスの最長リトライ時間の設定処理において使用すること。 本メソッド呼び出し時はリトライを制御する方法に応じた最短リトライ時間を算出する必要がある。 例えば、リトライ回数によりリトライ制御する場合は、リトライ回数×リトライ間隔が最短リトライ時間となる。

パラメータ:

maxRetryTime - 最長リトライ時間(単位:msec)

minRetryTime - 最短リトライ時間(単位:msec)

getCurrentRetryCount

public int getCurrentRetryCount()

現在のリトライ回数を取得する。

定義:

getCurrentRetryCount インタフェース内 RetryHandler.RetryContext

戻り値:

現在のリトライ回数

isRetryable

public boolean isRetryable()

リトライ可能か否かをリトライ状態から判定する。

現在のリトライ経過時間が最長リトライ時間を超えている場合は、 reset()メソッドを呼び出し、リトライ状態をリセットする。

判定処理はonIsRetryable()メソッドに委譲する。

定義:

isRetryable インタフェース内 RetryHandler.RetryContext

戻り値:

リトライ可能な場合はtrue

onIsRetryable

protected abstract boolean onIsRetryable()

リトライ可能か否かをリトライ状態から判定する。

戻り値:

リトライ可能な場合はtrue

prepareRetry

public void prepareRetry()

リトライ前の準備を行う。

 下記の処理を行う。
 
   リトライ開始時間が設定されていなければ設定する。
   リトライ間隔(単位:msec)プロパティの値が0より大きい場合は、指定された時間だけ待機する。
   待機中にInterruptedExceptionを捕捉した場合は、WARNレベルのログ出力のみ行い、
   呼び出し元に制御を返す。
   現在のリトライ回数をカウントアップする。
 
 

定義:

prepareRetry インタフェース内 RetryHandler.RetryContext

reset

public void reset()

リトライ状態をリセットする。

リトライ開始時間を未設定にする。 現在のリトライ回数に0を設定する。

定義:

reset インタフェース内 RetryHandler.RetryContext