com.ibm.cos.v2.retries

Interface AdaptiveRetryStrategy

All Superinterfaces:

RetryStrategy

All Known Implementing Classes:

DefaultAdaptiveRetryStrategy

@ThreadSafe
public interface AdaptiveRetryStrategy
extends RetryStrategy

The adaptive retry strategy is a RetryStrategy when executing against a very resource-constrained set of resources.

Unlike StandardRetryStrategy, care should be taken when using this strategy. Specifically, it should be used:

1. When the availability of downstream resources are mostly affected by callers that are also using the AdaptiveRetryStrategy.
2. The scope (either the whole strategy or the AcquireInitialTokenRequest.scope()) of the strategy is constrained to target "resource", so that availability issues in one resource cannot delay other, unrelated resource's availability.

The adaptive retry strategy by default:

1. Retries on the conditions configured in the AdaptiveRetryStrategy.Builder.
2. Retries 2 times (3 total attempts). Adjust with RetryStrategy.Builder.maxAttempts(int)
3. Uses a dynamic backoff delay based on load currently perceived against the downstream resource
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

See Also:

StandardRetryStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AdaptiveRetryStrategy.Builder

Method Summary

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

Create a new AdaptiveRetryStrategy.Builder.

Example Usage

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

toBuilder

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