com.ibm.cos.v2.retries

Interface StandardRetryStrategy

All Superinterfaces:

RetryStrategy

All Known Implementing Classes:

DefaultStandardRetryStrategy

@ThreadSafe
public interface StandardRetryStrategy
extends RetryStrategy

The standard retry strategy is the recommended RetryStrategy for normal use-cases.

Unlike AdaptiveRetryStrategy, the standard strategy is generally useful across all retry use-cases.

The standard retry strategy by default:

1. Retries on the conditions configured in the StandardRetryStrategy.Builder.
2. Retries 2 times (3 total attempts). Adjust with RetryStrategy.Builder.maxAttempts(int)
3. Uses the BackoffStrategy.exponentialDelay(java.time.Duration, java.time.Duration) backoff strategy, with a base delay of 1 second and max delay of 20 seconds. Adjust with RetryStrategy.Builder.backoffStrategy(com.ibm.cos.v2.retries.api.BackoffStrategy)
4. 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 StandardRetryStrategy.Builder.circuitBreakerEnabled(java.lang.Boolean).

See Also:

AdaptiveRetryStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StandardRetryStrategy.Builder

Method Summary

Modifier and Type	Method and Description
static StandardRetryStrategy.Builder	builder() Create a new StandardRetryStrategy.Builder.
StandardRetryStrategy.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 StandardRetryStrategy.Builder builder()

Create a new StandardRetryStrategy.Builder.

Example Usage

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

toBuilder

StandardRetryStrategy.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