BaseRetryStrategy (IBM COS Java SDK

java.lang.Object
- com.ibm.cos.v2.retries.internal.BaseRetryStrategy

All Implemented Interfaces:

RetryStrategy, DefaultAwareRetryStrategy

Direct Known Subclasses:

DefaultAdaptiveRetryStrategy, DefaultLegacyRetryStrategy, DefaultStandardRetryStrategy
```
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 and Description

static class BaseRetryStrategy.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseRetryStrategy.Builder`

Field Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`	`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()` Returns the maximum numbers attempts that this retry policy will allow.
`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)`.
`List<Predicate<Throwable>>`	`retryPredicates()`
`boolean`	`shouldAddDefaults(String defaultPredicateName)`
`String`	`toString()`
`protected void`	`updateStateForRetry(RefreshRetryTokenRequest request)` Called inside `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 `recordSuccess(com.ibm.cos.v2.retries.api.RecordSuccessRequest)` to allow extending classes to update their internal state after a successful request.
`boolean`	`useClientDefaults()` Returns whether the retry strategy uses default retry predicates.

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
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
```
  - defaultsAdded
```
protected final Set<String> defaultsAdded
```
  - useClientDefaults
```
protected final boolean useClientDefaults
```
- 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()
```
    Description copied from interface: RetryStrategy
    
    Returns the maximum numbers attempts that this retry policy will allow.
    
    Specified by:
    
    maxAttempts in interface RetryStrategy
    
    Returns:
    
    the maximum numbers attempts that this retry policy will allow.
  - useClientDefaults
```
public boolean useClientDefaults()
```
    Description copied from interface: RetryStrategy
    
    Returns whether the retry strategy uses default retry predicates.
    
    Specified by:
    
    useClientDefaults in interface RetryStrategy
    
    Returns:
    
    true if this retry strategy should use the default retry predicates, false otherwise.
  - 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(com.ibm.cos.v2.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(com.ibm.cos.v2.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

Class BaseRetryStrategy

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

log

retryPredicates

maxAttempts

circuitBreakerEnabled

backoffStrategy

throttlingBackoffStrategy

treatAsThrottling

exceptionCost

tokenBucketStore

defaultsAdded

useClientDefaults

Method Detail

acquireInitialToken

refreshRetryToken

recordSuccess

maxAttempts

useClientDefaults

computeInitialBackoff

computeBackoff

updateStateForSuccess

updateStateForRetry

exceptionCost

hasRetryPredicates

retryPredicates

shouldAddDefaults

addDefaults

toString