Package software.amazon.awssdk.retries.internal

Class BaseRetryStrategy

java.lang.Object

software.amazon.awssdk.retries.internal.BaseRetryStrategy

All Implemented Interfaces:

RetryStrategy, DefaultAwareRetryStrategy

Direct Known Subclasses:

DefaultAdaptiveRetryStrategy, DefaultLegacyRetryStrategy, DefaultStandardRetryStrategy

@SdkInternalApi
public abstract class BaseRetryStrategy
extends Object
implements DefaultAwareRetryStrategy

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseRetryStrategy.Builder

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final AcquireInitialTokenResponse	acquireInitialToken(AcquireInitialTokenRequest request)	This method implements the logic of RetryStrategy.acquireInitialToken(AcquireInitialTokenRequest).
DefaultAwareRetryStrategy	addDefaults(RetryStrategyDefaults retryStrategyDefaults)	Add the specified defaults to this retry strategy
protected Duration	computeAcquireFailureBackoff(RefreshRetryTokenRequest request)	Computes the backoff before exiting the retry loop using the configured backoff strategy.
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.
final boolean	hasRetryPredicates()	Returns true if there are retry predicates configured for this retry strategy.
int	maxAttempts()
final RecordSuccessResponse	recordSuccess(RecordSuccessRequest request)	This method implements the logic of RetryStrategy.recordSuccess(RecordSuccessRequest).
final RefreshRetryTokenResponse	refreshRetryToken(RefreshRetryTokenRequest request)	This method implements the logic of RetryStrategy.refreshRetryToken(RefreshRetryTokenRequest).
List<Predicate<Throwable>>	retryPredicates()
boolean	shouldAddDefaults(String defaultPredicateName)
String	toString()
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.
boolean	useClientDefaults()

Methods inherited from class java.lang.Object

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

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

toBuilder

Field Details

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

throttlingExceptionCost

protected final int throttlingExceptionCost

tokenBucketStore

protected final TokenBucketStore tokenBucketStore

defaultsAdded

protected final Set<String> defaultsAdded

useClientDefaults

protected final boolean useClientDefaults

Method Details

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

useClientDefaults

public boolean useClientDefaults()

Specified by:

useClientDefaults 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 a different duration 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 a different duration depending on their logic.

computeAcquireFailureBackoff

protected Duration computeAcquireFailureBackoff(RefreshRetryTokenRequest request)

Computes the backoff before exiting the retry loop using the configured backoff strategy. Extending classes can override this method to compute a different duration depending on their logic. The default implementation returns 0 delay.

Parameters:

request - The refresh request that failed to acquire sufficient capacity.

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.

retryPredicates

public List<Predicate<Throwable>> retryPredicates()

shouldAddDefaults

public boolean shouldAddDefaults(String defaultPredicateName)

addDefaults

public DefaultAwareRetryStrategy addDefaults(RetryStrategyDefaults retryStrategyDefaults)

Description copied from interface: DefaultAwareRetryStrategy

Add the specified defaults to this retry strategy

Specified by:

addDefaults in interface DefaultAwareRetryStrategy

Parameters:

retryStrategyDefaults - the defaults to add to this strategy

Returns:

a new retry strategy containing the specified defaults.

toString

public String toString()

Overrides:

toString in class Object