com.ibm.cos.v2.retries.internal

Class DefaultAdaptiveRetryStrategy

java.lang.Object

com.ibm.cos.v2.retries.internal.BaseRetryStrategy

com.ibm.cos.v2.retries.internal.DefaultAdaptiveRetryStrategy

All Implemented Interfaces:

AdaptiveRetryStrategy, RetryStrategy, DefaultAwareRetryStrategy

public final class DefaultAdaptiveRetryStrategy
extends BaseRetryStrategy
implements AdaptiveRetryStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultAdaptiveRetryStrategy.Builder

Field Summary

Fields inherited from class com.ibm.cos.v2.retries.internal.BaseRetryStrategy

backoffStrategy, circuitBreakerEnabled, defaultsAdded, exceptionCost, log, maxAttempts, retryPredicates, throttlingBackoffStrategy, tokenBucketStore, treatAsThrottling, useClientDefaults

Method Summary

Modifier and Type	Method and Description
static DefaultAdaptiveRetryStrategy.Builder	builder() Create a new AdaptiveRetryStrategy.Builder.
protected Duration	computeBackoff(RefreshRetryTokenRequest request, DefaultRetryToken token) Computes the backoff before a retry using the configured backoff strategy.
protected Duration	computeInitialBackoff(AcquireInitialTokenRequest request) Computes the backoff before the first attempt, by default Duration.ZERO.
DefaultAdaptiveRetryStrategy.Builder	toBuilder() Create a new RetryStrategy.Builder with the current configuration.
protected void	updateStateForRetry(RefreshRetryTokenRequest request) Called inside BaseRetryStrategy.refreshRetryToken(com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest) to allow extending classes to update their internal state before retrying a request.
protected void	updateStateForSuccess(DefaultRetryToken token) Called inside BaseRetryStrategy.recordSuccess(com.ibm.cos.v2.retries.api.RecordSuccessRequest) to allow extending classes to update their internal state after a successful request.

Methods inherited from class com.ibm.cos.v2.retries.internal.BaseRetryStrategy

acquireInitialToken, addDefaults, exceptionCost, hasRetryPredicates, maxAttempts, recordSuccess, refreshRetryToken, retryPredicates, shouldAddDefaults, toString, useClientDefaults

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.cos.v2.retries.api.RetryStrategy

acquireInitialToken, maxAttempts, recordSuccess, refreshRetryToken, useClientDefaults

Method Detail

computeInitialBackoff

protected Duration computeInitialBackoff(AcquireInitialTokenRequest request)

Description copied from class: BaseRetryStrategy

Computes the backoff before the first attempt, by default Duration.ZERO. Extending classes can override this method to compute different a different depending on their logic.

Overrides:

computeInitialBackoff in class BaseRetryStrategy

computeBackoff

protected Duration computeBackoff(RefreshRetryTokenRequest request,
                                  DefaultRetryToken token)

Description copied from class: BaseRetryStrategy

Computes the backoff before a retry using the configured backoff strategy. Extending classes can override this method to compute different a different depending on their logic.

Overrides:

computeBackoff in class BaseRetryStrategy

updateStateForRetry

protected void updateStateForRetry(RefreshRetryTokenRequest request)

Description copied from class: BaseRetryStrategy

Called inside BaseRetryStrategy.refreshRetryToken(com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest) to allow extending classes to update their internal state before retrying a request.

Overrides:

updateStateForRetry in class BaseRetryStrategy

updateStateForSuccess

protected void updateStateForSuccess(DefaultRetryToken token)

Description copied from class: BaseRetryStrategy

Called inside BaseRetryStrategy.recordSuccess(com.ibm.cos.v2.retries.api.RecordSuccessRequest) to allow extending classes to update their internal state after a successful request.

Overrides:

updateStateForSuccess in class BaseRetryStrategy

toBuilder

public DefaultAdaptiveRetryStrategy.Builder toBuilder()

Description copied from interface: RetryStrategy

Create a new RetryStrategy.Builder with the current configuration.

This is useful for modifying the strategy's behavior, like conditions or max retries.

Specified by:

toBuilder in interface AdaptiveRetryStrategy

Specified by:

toBuilder in interface RetryStrategy

builder

public static DefaultAdaptiveRetryStrategy.Builder builder()

Description copied from interface: AdaptiveRetryStrategy

Create a new AdaptiveRetryStrategy.Builder.

Example Usage

 AdaptiveRetryStrategy retryStrategy =
     AdaptiveRetryStrategy.builder()
                          .retryOnExceptionInstanceOf(IllegalArgumentException.class)
                          .retryOnExceptionInstanceOf(IllegalStateException.class)
                          .build();
 

Specified by:

builder in interface AdaptiveRetryStrategy