Package software.amazon.awssdk.retries.internal

Class BaseRetryStrategy

java.lang.Object

software.amazon.awssdk.retries.internal.BaseRetryStrategy

All Implemented Interfaces:

RetryStrategy

Direct Known Subclasses:

DefaultAdaptiveRetryStrategy, DefaultLegacyRetryStrategy, DefaultStandardRetryStrategy

public abstract class BaseRetryStrategy
extends Object
implements RetryStrategy

Generic class that implements that common logic for all the retries strategies with extension points for specific strategies to tailor the behavior to its needs.

Field Summary

Fields

Modifier and Type	Field	Description
protected BackoffStrategy	backoffStrategy
protected boolean	circuitBreakerEnabled
protected int	exceptionCost
protected Logger	log
protected int	maxAttempts
protected List<Predicate<Throwable>>	retryPredicates
protected BackoffStrategy	throttlingBackoffStrategy
protected TokenBucketStore	tokenBucketStore
protected Predicate<Throwable>	treatAsThrottling

Method Summary

Modifier and Type	Method	Description
AcquireInitialTokenResponse	acquireInitialToken(AcquireInitialTokenRequest request)	This method implements the logic of RetryStrategy.acquireInitialToken(AcquireInitialTokenRequest).
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.
protected int	exceptionCost(RefreshRetryTokenRequest request)	Returns the amount of tokens to withdraw from the token bucket.
boolean	hasRetryPredicates()	Returns true if there are retry predicates configured for this retry strategy.
int	maxAttempts()
RecordSuccessResponse	recordSuccess(RecordSuccessRequest request)	This method implements the logic of RetryStrategy.recordSuccess(RecordSuccessRequest).
RefreshRetryTokenResponse	refreshRetryToken(RefreshRetryTokenRequest request)	This method implements the logic of RetryStrategy.refreshRetryToken(RefreshRetryTokenRequest).
protected void	updateStateForRetry(RefreshRetryTokenRequest request)	Called inside refreshRetryToken(software.amazon.awssdk.retries.api.RefreshRetryTokenRequest) to allow extending classes to update their internal state before retrying a request.
protected void	updateStateForSuccess(DefaultRetryToken token)	Called inside recordSuccess(software.amazon.awssdk.retries.api.RecordSuccessRequest) to allow extending classes to update their internal state after a successful request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.retries.api.RetryStrategy

toBuilder

Field Detail

log

protected final Logger log

retryPredicates

protected final List<Predicate<Throwable>> retryPredicates

maxAttempts

protected final int maxAttempts

circuitBreakerEnabled

protected final boolean circuitBreakerEnabled

backoffStrategy

protected final BackoffStrategy backoffStrategy

throttlingBackoffStrategy

protected final BackoffStrategy throttlingBackoffStrategy

treatAsThrottling

protected final Predicate<Throwable> treatAsThrottling

exceptionCost

protected final int exceptionCost

tokenBucketStore

protected final TokenBucketStore tokenBucketStore

Method Detail

acquireInitialToken

public final AcquireInitialTokenResponse acquireInitialToken(AcquireInitialTokenRequest request)

This method implements the logic of RetryStrategy.acquireInitialToken(AcquireInitialTokenRequest).

Specified by:

acquireInitialToken in interface RetryStrategy

See Also:

RetryStrategy.acquireInitialToken(AcquireInitialTokenRequest)

refreshRetryToken

public final RefreshRetryTokenResponse refreshRetryToken(RefreshRetryTokenRequest request)

This method implements the logic of RetryStrategy.refreshRetryToken(RefreshRetryTokenRequest).

Specified by:

refreshRetryToken in interface RetryStrategy

See Also:

RetryStrategy.refreshRetryToken(RefreshRetryTokenRequest)

recordSuccess

public final RecordSuccessResponse recordSuccess(RecordSuccessRequest request)

This method implements the logic of RetryStrategy.recordSuccess(RecordSuccessRequest).

Specified by:

recordSuccess in interface RetryStrategy

See Also:

RetryStrategy.recordSuccess(RecordSuccessRequest)

maxAttempts

public int maxAttempts()

Specified by:

maxAttempts in interface RetryStrategy

computeInitialBackoff

protected Duration computeInitialBackoff(AcquireInitialTokenRequest request)

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.

computeBackoff

protected Duration computeBackoff(RefreshRetryTokenRequest request,
                                  DefaultRetryToken token)

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.

updateStateForSuccess

protected void updateStateForSuccess(DefaultRetryToken token)

Called inside recordSuccess(software.amazon.awssdk.retries.api.RecordSuccessRequest) to allow extending classes to update their internal state after a successful request.

updateStateForRetry

protected void updateStateForRetry(RefreshRetryTokenRequest request)

Called inside refreshRetryToken(software.amazon.awssdk.retries.api.RefreshRetryTokenRequest) to allow extending classes to update their internal state before retrying a request.

exceptionCost

protected int exceptionCost(RefreshRetryTokenRequest request)

Returns the amount of tokens to withdraw from the token bucket. Extending classes can override this method to tailor this amount for the specific kind of failure.

hasRetryPredicates

public final boolean hasRetryPredicates()

Returns true if there are retry predicates configured for this retry strategy.

Returns:

true if there are retry predicates configured for this retry strategy.