com.ibm.cos.v2.retries

Interface LegacyRetryStrategy

All Superinterfaces:

RetryStrategy

All Known Implementing Classes:

DefaultLegacyRetryStrategy

@ThreadSafe
public interface LegacyRetryStrategy
extends RetryStrategy

The legacy retry strategy is a RetryStrategy for normal use-cases.

The legacy retry strategy by default:

1. Retries on the conditions configured in the LegacyRetryStrategy.Builder.
2. Retries 3 times (4 total attempts). Adjust with RetryStrategy.Builder.maxAttempts(int)
3. For non-throttling exceptions uses the BackoffStrategy.exponentialDelay(java.time.Duration, java.time.Duration) backoff strategy, with a base delay of 100 milliseconds and max delay of 20 seconds. Adjust with RetryStrategy.Builder.backoffStrategy(com.ibm.cos.v2.retries.api.BackoffStrategy)
4. For throttling exceptions uses the BackoffStrategy.exponentialDelayHalfJitter(java.time.Duration, java.time.Duration) backoff strategy, with a base delay of 500 milliseconds and max delay of 20 seconds. Adjust with LegacyRetryStrategy.Builder.throttlingBackoffStrategy(com.ibm.cos.v2.retries.api.BackoffStrategy)
5. Circuit breaking (disabling retries) in the event of high downstream failures within an individual scope. The circuit breaking will never prevent the first attempt. Adjust with LegacyRetryStrategy.Builder.circuitBreakerEnabled(java.lang.Boolean)
6. The state of the circuit breaker is not affected by throttling exceptions

See Also:

StandardRetryStrategy, AdaptiveRetryStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LegacyRetryStrategy.Builder

Method Summary

Modifier and Type	Method and Description
static LegacyRetryStrategy.Builder	builder() Create a new LegacyRetryStrategy.Builder.
LegacyRetryStrategy.Builder	toBuilder() Create a new RetryStrategy.Builder with the current configuration.

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

acquireInitialToken, maxAttempts, recordSuccess, refreshRetryToken, useClientDefaults

Method Detail

builder

static LegacyRetryStrategy.Builder builder()

Create a new LegacyRetryStrategy.Builder.

Example Usage

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

toBuilder

LegacyRetryStrategy.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 RetryStrategy