クラス RetryTemplateBuilder

方法の詳細

• maxAttempts

  public RetryTemplateBuilder maxAttempts(int maxAttempts)

  アクションを maxAttempts 回以内で試行します。

  パラメーター:

  maxAttempts - アクションを試行する回数。値が 3 の場合、最初の試行と 2 回の再試行が行われます。

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - maxAttempts が 0 以下の場合、または別の再試行ポリシーがすでに選択されている場合。

  関連事項:

  • MaxAttemptsRetryPolicy

• withinMillis

  @DeprecatedSE(since="2.0.2", forRemoval=true) public RetryTemplateBuilder withinMillis(long timeout)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  代わりに withTimeout(long) を使用してください。

  最初の試行から timeout が経過するまで再試行します。

  パラメーター:

  timeout - タイムアウト（ミリ秒）

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - タイムアウトが 0 以下であるか、別の再試行ポリシーがすでに選択されている場合。

  関連事項:

  • TimeoutRetryPolicy

• withTimeout

  public RetryTemplateBuilder withTimeout(long timeoutMillis)

  最初の試行から timeoutMillis が経過するまで再試行します。

  パラメーター:

  timeoutMillis - タイムアウト（ミリ秒）

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - タイムアウトが 0 以下であるか、別の再試行ポリシーがすでに選択されている場合。

  導入:

  2.0.2

  関連事項:

  • TimeoutRetryPolicy

• withTimeout

  public RetryTemplateBuilder withTimeout(DurationSE timeout)

  最初の試行から timeout が経過するまで再試行します。

  パラメーター:

  timeout - 再試行をどのくらいの期間行うかを示す期間

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - タイムアウトが null または 0 の場合、または別の再試行ポリシーがすでに選択されている場合。

  導入:

  2.0.2

  関連事項:

  • TimeoutRetryPolicy

• infiniteRetry

  public RetryTemplateBuilder infiniteRetry()

  アクションを無限に再試行します。

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - 別の再試行ポリシーがすでに選択されている場合。

  関連事項:

  • AlwaysRetryPolicy

• customPolicy

  public RetryTemplateBuilder customPolicy(RetryPolicy policy)

  付属の RetryPolicy を使用してください。

  パラメーター:

  policy - 使用する RetryPolicy

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - 別のバックオフポリシーがすでに選択されている場合、いずれかの引数が null である場合、または別の再試行ポリシーがすでに選択されている場合。

• exponentialBackoff

  public RetryTemplateBuilder exponentialBackoff(long initialInterval, double multiplier, long maxInterval)

  指数バックオフポリシーを使用します。バックオフ期間の計算式は次のとおりです。

  currentInterval = Math.min(initialInterval * Math.pow(multiplier, retryNum), maxInterval)

  最初の試みは、retryNum = 0 です。

  パラメーター:

  initialInterval - 初期スリープ期間（ミリ秒）

  multiplier - バックオフ間隔乗数

  maxInterval - ミリ秒単位の最大バックオフ期間

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - 別のバックオフポリシーがすでに選択されている場合、initialInterval < 1 の場合、multiplier <= 1 の場合、または maxInterval <= initialInterval の場合。

  関連事項:

  • ExponentialBackOffPolicy

• exponentialBackoff

  public RetryTemplateBuilder exponentialBackoff(DurationSE initialInterval, double multiplier, DurationSE maxInterval)

  指数バックオフポリシーを使用します。バックオフ期間の計算式は次のとおりです。

  currentInterval = Math.min(initialInterval * Math.pow(multiplier, retryNum), maxInterval)

  最初の試みは、retryNum = 0 です。

  パラメーター:

  initialInterval - 初期睡眠時間

  multiplier - バックオフ間隔乗数

  maxInterval - 最大バックオフ期間

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - 別のバックオフポリシーがすでに選択されている場合、initialInterval が null であるか 1 ミリ秒未満である場合、乗数が <= 1 である場合、または maxInterval が null であるか <= initialInterval である場合。

  導入:

  2.0.2

  関連事項:

  • ExponentialBackOffPolicy

• exponentialBackoff

  public RetryTemplateBuilder exponentialBackoff(long initialInterval, double multiplier, long maxInterval, boolean withRandom)

  指数バックオフポリシーを使用します。バックオフ期間の式は次のとおりです (ランダム性なし):

  currentInterval = Math.min(initialInterval * Math.pow(multiplier, retryNum), maxInterval)

  最初の試みは、retryNum = 0 です。

  パラメーター:

  initialInterval - 初期スリープ期間（ミリ秒）

  multiplier - バックオフ間隔乗数

  maxInterval - ミリ秒単位の最大バックオフ期間

  withRandom - ExponentialRandomBackOffPolicy を使用するかどうか（true の場合）

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - 別のバックオフポリシーがすでに選択されている場合、initialInterval < 1 の場合、multiplier <= 1 の場合、または maxInterval <= initialInterval の場合。

  関連事項:

  • ExponentialBackOffPolicy
  • ExponentialRandomBackOffPolicy

• exponentialBackoff

  public RetryTemplateBuilder exponentialBackoff(DurationSE initialInterval, double multiplier, DurationSE maxInterval, boolean withRandom)

  指数バックオフポリシーを使用します。バックオフ期間の式は次のとおりです (ランダム性なし):

  currentInterval = Math.min(initialInterval * Math.pow(multiplier, retryNum), maxInterval)

  最初の試みは、retryNum = 0 です。

  パラメーター:

  initialInterval - 初期睡眠時間

  multiplier - バックオフ間隔乗数

  maxInterval - 最大バックオフ期間

  withRandom - ExponentialRandomBackOffPolicy を使用するかどうか（true の場合）

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - 別のバックオフポリシーがすでに選択されている場合、initialInterval が null または 1 ミリ秒未満の場合、multiplier が <= 1 の場合、または maxInterval が null または <= initialInterval の場合。

  導入:

  2.0.2

  関連事項:

  • ExponentialBackOffPolicy
  • ExponentialRandomBackOffPolicy

• withLogger

  public RetryTemplateBuilder withLogger(org.apache.commons.logging.Log logger)

  RetryTemplate に専用のロガーを適用します。適用されていない場合は、以下が使用されます。

  LogFactory.getLog(getClass())

  パラメーター:

  logger - ログ記録に使用するロガー

  戻り値:

  this

  導入:

  2.0.10

• fixedBackoff

  public RetryTemplateBuilder fixedBackoff(long interval)

  一定時間後に再試行を実行します。

  パラメーター:

  interval - ミリ秒単位の固定間隔

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - 別のバックオフポリシーがすでに選択されている場合、または interval が 1 未満の場合。

  関連事項:

  • FixedBackOffPolicy

• fixedBackoff

  public RetryTemplateBuilder fixedBackoff(DurationSE interval)

  一定時間後に再試行を実行します。

  パラメーター:

  interval - 固定バックオフ期間

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - 別のバックオフポリシーがすでに選択されている場合、または interval が null または 1 ミリ秒未満の場合

  導入:

  2.0.2

  関連事項:

  • FixedBackOffPolicy

• uniformRandomBackoff

  public RetryTemplateBuilder uniformRandomBackoff(long minInterval, long maxInterval)

  UniformRandomBackOffPolicy を使用します。

  パラメーター:

  minInterval - 最小間隔（ミリ秒）

  maxInterval - 最大間隔（ミリ秒）

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - 別のバックオフポリシーがすでに選択されている場合、minInterval が < 1 の場合、maxInterval が < 1 の場合、または maxInterval が <= minInterval の場合。

  関連事項:

  • UniformRandomBackOffPolicy

• uniformRandomBackoff

  public RetryTemplateBuilder uniformRandomBackoff(DurationSE minInterval, DurationSE maxInterval)

  UniformRandomBackOffPolicy を使用します。

  パラメーター:

  minInterval - 最小バックオフ期間

  maxInterval - 最大バックオフ期間

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - 別のバックオフポリシーがすでに選択されている場合、minInterval が null または < 1 の場合、maxInterval が null または 1 ミリ秒未満の場合、または maxInterval <= minInterval の場合。

  導入:

  2.0.2

  関連事項:

  • UniformRandomBackOffPolicy

• noBackoff

  public RetryTemplateBuilder noBackoff()

  試行の間に一時停止せずに、すぐに再試行してください。

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - 別のバックオフポリシーがすでに選択されている場合。

  関連事項:

  • NoBackOffPolicy

• customBackoff

  public RetryTemplateBuilder customBackoff(BackOffPolicy backOffPolicy)

  付属の BackOffPolicy を使用してください。

  パラメーター:

  backOffPolicy - 使用する BackOffPolicy

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - backOffPolicy が null の場合、または別のバックオフポリシーがすでに選択されている場合。

• retryOn

  public RetryTemplateBuilder retryOn(ClassSE<? extends ThrowableSE> throwable)

  再試行を引き起こす例外のリストに ThrowableSE とそのサブクラスを追加します。

  retryOn() と notRetryOn() は相互に排他的です。両方を使用しようとすると、IllegalArgumentExceptionSE が発生します。

  パラメーター:

  throwable - 再試行を引き起こす

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - throwable が null の場合、または notRetryOn(java.lang.Class<? extends java.lang.Throwable>) がすでに使用されている場合。

  関連事項:

  • BinaryExceptionClassifierBuilder.retryOn(java.lang.Class<? extends java.lang.Throwable>)
  • BinaryExceptionClassifier

• notRetryOn

  public RetryTemplateBuilder notRetryOn(ClassSE<? extends ThrowableSE> throwable)

  再試行を引き起こさない例外のリストに ThrowableSE とそのサブクラスを追加します。

  retryOn() と notRetryOn() は相互に排他的です。両方を使用しようとすると、IllegalArgumentExceptionSE が発生します。

  パラメーター:

  throwable - 再試行を起こさない

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - throwable が null の場合、または retryOn(java.lang.Class<? extends java.lang.Throwable>) がすでに使用されている場合。

  関連事項:

  • BinaryExceptionClassifierBuilder.notRetryOn(java.lang.Class<? extends java.lang.Throwable>)
  • BinaryExceptionClassifier

• retryOn

  public RetryTemplateBuilder retryOn(ListSE<ClassSE<? extends ThrowableSE>> throwables)

  再試行の原因となる例外のリストに、ThrowableSE クラスとそのサブクラスのリストを追加します。

  retryOn() と notRetryOn() は相互に排他的です。両方を使用しようとすると、IllegalArgumentExceptionSE が発生します。

  パラメーター:

  throwables - 再試行を引き起こす

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - notRetryOn(java.lang.Class<? extends java.lang.Throwable>) がすでに使用されている場合。

  導入:

  1.3.2

  関連事項:

  • BinaryExceptionClassifierBuilder.retryOn(java.lang.Class<? extends java.lang.Throwable>)
  • BinaryExceptionClassifier

• notRetryOn

  public RetryTemplateBuilder notRetryOn(ListSE<ClassSE<? extends ThrowableSE>> throwables)

  再試行を引き起こさない例外のリストに、ThrowableSE クラスとそのサブクラスのリストを追加します。

  retryOn() と notRetryOn() は相互に排他的です。両方を使用しようとすると、IllegalArgumentExceptionSE が発生します。

  パラメーター:

  throwables - 再試行を起こさない

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - retryOn(java.lang.Class<? extends java.lang.Throwable>) がすでに使用されている場合。

  導入:

  1.3.2

  関連事項:

  • BinaryExceptionClassifierBuilder.notRetryOn(java.lang.Class<? extends java.lang.Throwable>)
  • BinaryExceptionClassifier

• retryOn

  public RetryTemplateBuilder retryOn(PredicateSE<ThrowableSE> predicate)

  例外によって再試行が発生するかどうかを決定する PredicateSE<ThrowableSE> を設定します。

  retryOn(Predicate<Throwable>) は、他の retryOn() または noRetryOn() と混合することはできません。混合しようとすると、IllegalArgumentExceptionSE になります。

  パラメーター:

  predicate - 例外によって再試行が発生する場合。

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - retryOn(java.lang.Class<? extends java.lang.Throwable>) または notRetryOn(java.lang.Class<? extends java.lang.Throwable>) がすでに使用されている場合。

  導入:

  2.0.7

  関連事項:

  • BinaryExceptionClassifierRetryPolicy

• traversingCauses

  public RetryTemplateBuilder traversingCauses()

  再試行を引き起こす ThrowableSE インスタンスの例外原因の調査を有効にします。

  次の RetryTemplate を想定します。

  
   RetryTemplate.builder()
            .retryOn(IOException.class)
            .build()
   

  これは、IOExceptionSE をスローするコード (例: throw new IOException()) に対して動作します。ただし、IOExceptionSE が別の例外 (例: throw new MyException(new IOException())) にラップされている場合は、アクションを再試行しません。ただし、この RetryTemplate は次のようになります。

  
   RetryTemplate.builder()
            .retryOn(IOException.class)
            .traversingCauses()
            .build()
   

  戻り値:

  this

  関連事項:

  • BinaryExceptionClassifier

• withListener

  public RetryTemplateBuilder withListener(RetryListener listener)

  提供された listener を RetryTemplate のリスナーリストに追加します。

  パラメーター:

  listener - 追加される

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - listener が null の場合。

  関連事項:

  • RetryListener

• withListeners

  public RetryTemplateBuilder withListeners(ListSE<RetryListener> listeners)

  提供されたすべての listeners を RetryTemplate のリスナーリストに追加します。

  パラメーター:

  listeners - 追加される

  戻り値:

  this

  例外:

  IllegalArgumentExceptionSE - listeners のいずれかが null である場合。

  関連事項:

  • RetryListener

• build

  public RetryTemplate build()

  新しい RetryTemplate をビルドします。

  複数のインスタンスの構築をサポートします。ただし、複数の build() 呼び出し間で構成を変更することはできません。

  返される RetryTemplate の retryPolicy は常に、1 つの基本ポリシーと、基本ポリシーに関係なく例外分類を可能にする BinaryExceptionClassifierRetryPolicy で構成される CompositeRetryPolicy です。

  戻り値:

  RetryTemplate の新しいインスタンス