com.ibm.cloud.objectstorage.retry

Class PredefinedBackoffStrategies.ExponentialBackoffStrategy

java.lang.Object

com.ibm.cloud.objectstorage.retry.PredefinedBackoffStrategies.ExponentialBackoffStrategy

All Implemented Interfaces:

RetryPolicy.BackoffStrategy, BackoffStrategy, V2CompatibleBackoffStrategy

Enclosing class:

PredefinedBackoffStrategies

public static class PredefinedBackoffStrategies.ExponentialBackoffStrategy
extends Object

Field Summary

Fields inherited from interface com.ibm.cloud.objectstorage.retry.RetryPolicy.BackoffStrategy

NO_DELAY

Constructor Summary

Constructors

Constructor and Description
ExponentialBackoffStrategy(int baseDelay, int maxBackoffTime)

Method Summary

Modifier and Type	Method and Description
long	computeDelayBeforeNextRetry(RetryPolicyContext context) Compute the delay before the next retry request.
long	delayBeforeNextRetry(AmazonWebServiceRequest originalRequest, AmazonClientException exception, int retriesAttempted) Returns the delay (in milliseconds) before next retry attempt.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExponentialBackoffStrategy

public ExponentialBackoffStrategy(int baseDelay,
                                  int maxBackoffTime)

Method Detail

computeDelayBeforeNextRetry

public long computeDelayBeforeNextRetry(RetryPolicyContext context)

Description copied from interface: BackoffStrategy

Compute the delay before the next retry request. This strategy is only consulted when there will be a next retry.

Parameters:

context - Context about the state of the last request and information about the number of requests made.

Returns:

Amount of time in milliseconds to wait before the next attempt. Must be non-negative (can be zero).

delayBeforeNextRetry

public long delayBeforeNextRetry(AmazonWebServiceRequest originalRequest,
                                 AmazonClientException exception,
                                 int retriesAttempted)

Description copied from interface: RetryPolicy.BackoffStrategy

Returns the delay (in milliseconds) before next retry attempt.

Specified by:

delayBeforeNextRetry in interface RetryPolicy.BackoffStrategy

Parameters:

originalRequest - The original request object being executed. For performance reason, this object is not a defensive copy, and caller should not attempt to modify its data.

exception - The exception from the failed request, represented as an AmazonClientException object. There are two types of exception that will be passed to this method:

• AmazonServiceException (sub-class of AmazonClientException) indicating a service error
• AmazonClientException caused by an IOException when executing the HTTP request.

Any other exceptions are regarded as unexpected failures and are thrown immediately without any retry. For performance reason, this object is not a defensive copy, and caller should not attempt to modify its data.

retriesAttempted - The number of times the current request has been attempted (not including the next attempt after the delay).

Returns:

The delay (in milliseconds) before next retry attempt.