com.microsoft.azure.storage

Class RetryExponentialRetry

java.lang.Object

com.microsoft.azure.storage.RetryPolicy

com.microsoft.azure.storage.RetryExponentialRetry

All Implemented Interfaces:

RetryPolicyFactory

public final class RetryExponentialRetry
extends RetryPolicy
implements RetryPolicyFactory

Represents a retry policy that performs a specified number of retries, using a randomized exponential backoff scheme to determine the interval between retries. This class extends the RetryPolicy class and implements the RetryPolicyFactory interface.

Field Summary

Fields inherited from class com.microsoft.azure.storage.RetryPolicy

DEFAULT_CLIENT_BACKOFF, DEFAULT_CLIENT_RETRY_COUNT, DEFAULT_MAX_BACKOFF, DEFAULT_MIN_BACKOFF

Constructor Summary

Constructors

Constructor and Description
RetryExponentialRetry() Creates an instance of the RetryExponentialRetry class.
RetryExponentialRetry(int deltaBackoff, int maxAttempts) Creates an instance of the RetryExponentialRetry class using the specified delta backoff and maximum retry attempts.
RetryExponentialRetry(int minBackoff, int deltaBackoff, int maxBackOff, int maxAttempts) Creates an instance of the RetryExponentialRetry class using the specified minimum, maximum, and delta backoff amounts, and maximum number of retry attempts.

Method Summary

Modifier and Type	Method and Description
RetryPolicy	createInstance(OperationContext opContext) Generates a new retry policy for the current request attempt.
RetryInfo	evaluate(RetryContext retryContext, OperationContext operationContext) Determines whether the operation should be retried and specifies the interval until the next retry.

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryExponentialRetry

public RetryExponentialRetry()

Creates an instance of the RetryExponentialRetry class.

RetryExponentialRetry

public RetryExponentialRetry(int deltaBackoff,
                             int maxAttempts)

Creates an instance of the RetryExponentialRetry class using the specified delta backoff and maximum retry attempts.

Parameters:

deltaBackoff - The backoff interval, in milliseconds, between retries.

maxAttempts - The maximum number of retry attempts.

RetryExponentialRetry

public RetryExponentialRetry(int minBackoff,
                             int deltaBackoff,
                             int maxBackOff,
                             int maxAttempts)

Creates an instance of the RetryExponentialRetry class using the specified minimum, maximum, and delta backoff amounts, and maximum number of retry attempts.

Parameters:

minBackoff - The minimum backoff interval, in milliseconds, between retries.

deltaBackoff - The backoff interval, in milliseconds, between retries.

maxBackOff - The maximum backoff interval, in milliseconds, between retries.

maxAttempts - The maximum retry attempts, in milliseconds, between retries.

Method Detail

createInstance

public RetryPolicy createInstance(OperationContext opContext)

Generates a new retry policy for the current request attempt.

Specified by:

createInstance in interface RetryPolicyFactory

Parameters:

opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

A RetryPolicy object that represents the retry policy for the current request attempt.

evaluate

public RetryInfo evaluate(RetryContext retryContext,
                          OperationContext operationContext)

Determines whether the operation should be retried and specifies the interval until the next retry.

Specified by:

evaluate in class RetryPolicy

Parameters:

retryContext - A RetryContext object that indicates the number of retries, last request's results, whether the next retry should happen in the primary or secondary location, and specifies the location mode.

operationContext - An OperationContext object for tracking the current operation.

Returns:

A RetryInfo object that indicates whether the next retry will happen in the primary or secondary location, and specifies the location mode. If null, the operation will not be retried.