com.ibm.cos.v2.core.internal.retry

Class RetryPolicyAdapter

java.lang.Object

com.ibm.cos.v2.core.internal.retry.RetryPolicyAdapter

All Implemented Interfaces:

RetryStrategy

public final class RetryPolicyAdapter
extends Object
implements RetryStrategy

Implements the RetryStrategy interface by wrapping a RetryPolicy instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RetryPolicyAdapter.Builder

Method Summary

Modifier and Type	Method and Description
AcquireInitialTokenResponse	acquireInitialToken(AcquireInitialTokenRequest request) Invoked before the first request attempt.
static RetryPolicyAdapter.Builder	builder()
boolean	isInitialized()
int	maxAttempts() Returns the maximum numbers attempts that this retry policy will allow.
RecordSuccessResponse	recordSuccess(RecordSuccessRequest request) Invoked after an attempt succeeds.
RefreshRetryTokenResponse	refreshRetryToken(RefreshRetryTokenRequest request) Invoked before each subsequent (non-first) request attempt.
RetryPolicyAdapter.Builder	toBuilder() Create a new RetryStrategy.Builder with the current configuration.

Methods inherited from class java.lang.Object

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

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

useClientDefaults

Method Detail

acquireInitialToken

public AcquireInitialTokenResponse acquireInitialToken(AcquireInitialTokenRequest request)

Description copied from interface: RetryStrategy

Invoked before the first request attempt.

Callers MUST wait for the delay returned by this call before making the first attempt. Callers that wish to retry a failed attempt MUST call RetryStrategy.refreshRetryToken(com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest) before doing so.

If the attempt was successful, callers MUST call RetryStrategy.recordSuccess(com.ibm.cos.v2.retries.api.RecordSuccessRequest).

Specified by:

acquireInitialToken in interface RetryStrategy

refreshRetryToken

public RefreshRetryTokenResponse refreshRetryToken(RefreshRetryTokenRequest request)

Description copied from interface: RetryStrategy

Invoked before each subsequent (non-first) request attempt.

Callers MUST wait for the delay returned by this call before making the next attempt. If the next attempt fails, callers MUST re-call RetryStrategy.refreshRetryToken(com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest) before attempting another retry. This call invalidates the provided token, and returns a new one. Callers MUST use the new token.

If the attempt was successful, callers MUST call RetryStrategy.recordSuccess(com.ibm.cos.v2.retries.api.RecordSuccessRequest).

Specified by:

refreshRetryToken in interface RetryStrategy

recordSuccess

public RecordSuccessResponse recordSuccess(RecordSuccessRequest request)

Description copied from interface: RetryStrategy

Invoked after an attempt succeeds.

Specified by:

recordSuccess in interface RetryStrategy

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.

toBuilder

public RetryPolicyAdapter.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

isInitialized

public boolean isInitialized()

builder

public static RetryPolicyAdapter.Builder builder()