com.microsoft.windowsazure.services.core.storage

Class RetryPolicy

java.lang.Object

com.microsoft.windowsazure.services.core.storage.RetryPolicy

Direct Known Subclasses:

RetryExponentialRetry, RetryLinearRetry, RetryNoRetry

public abstract class RetryPolicy
extends Object

Abstract class that represents a retry policy.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CLIENT_BACKOFF Represents the default client backoff interval, in milliseconds.
static int	DEFAULT_CLIENT_RETRY_COUNT Represents the default client retry count.
static int	DEFAULT_MAX_BACKOFF Represents the default maximum backoff interval, in milliseconds.
static int	DEFAULT_MIN_BACKOFF Represents the default minimum backoff interval, in milliseconds.
protected int	deltaBackoffIntervalInMs Represents the realized backoff interval, in milliseconds.
protected int	maximumAttempts Represents the maximum retries that the retry policy should attempt.

Constructor Summary

Constructors

Constructor and Description
RetryPolicy() Creates an instance of the RetryPolicy class.
RetryPolicy(int deltaBackoff, int maxAttempts) Creates an instance of the RetryPolicy class using the specified delta backoff and maximum retry attempts.

Method Summary

Methods

Modifier and Type	Method and Description
abstract RetryResult	shouldRetry(int currentRetryCount, int statusCode, Exception lastException, OperationContext opContext) Determines if the operation should be retried and how long to wait until the next retry.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CLIENT_BACKOFF

public static final int DEFAULT_CLIENT_BACKOFF

Represents the default client backoff interval, in milliseconds.

See Also:

Constant Field Values

DEFAULT_CLIENT_RETRY_COUNT

public static final int DEFAULT_CLIENT_RETRY_COUNT

Represents the default client retry count.

See Also:

Constant Field Values

DEFAULT_MAX_BACKOFF

public static final int DEFAULT_MAX_BACKOFF

Represents the default maximum backoff interval, in milliseconds.

See Also:

Constant Field Values

DEFAULT_MIN_BACKOFF

public static final int DEFAULT_MIN_BACKOFF

Represents the default minimum backoff interval, in milliseconds.

See Also:

Constant Field Values

deltaBackoffIntervalInMs

protected int deltaBackoffIntervalInMs

Represents the realized backoff interval, in milliseconds.

maximumAttempts

protected int maximumAttempts

Represents the maximum retries that the retry policy should attempt.

Constructor Detail

RetryPolicy

public RetryPolicy()

Creates an instance of the RetryPolicy class.

RetryPolicy

public RetryPolicy(int deltaBackoff,
           int maxAttempts)

Creates an instance of the RetryPolicy 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.

Method Detail

shouldRetry

public abstract RetryResult shouldRetry(int currentRetryCount,
                      int statusCode,
                      Exception lastException,
                      OperationContext opContext)

Determines if the operation should be retried and how long to wait until the next retry.

Parameters:

currentRetryCount - The number of retries for the given operation. A value of zero signifies this is the first error encountered.

statusCode - The status code for the last operation.

lastException - A Exception object that represents the last exception encountered.

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 RetryResult object that indicates whether the operation should be retried and how long to backoff.