com.microsoft.azure.storage

Class RetryPolicy

java.lang.Object

com.microsoft.azure.storage.RetryPolicy

All Implemented Interfaces:

RetryPolicyFactory

Direct Known Subclasses:

RetryExponentialRetry, RetryLinearRetry, RetryNoRetry

public abstract class RetryPolicy
extends Object
implements RetryPolicyFactory

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 Date	lastPrimaryAttempt Represents the time of the last request attempt to the primary location.
protected Date	lastSecondaryAttempt Represents the time of the last request attempt to the secondary location.
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

Modifier and Type	Method and Description
abstract RetryInfo	evaluate(RetryContext retryContext, OperationContext operationContext) Determines whether the operation should be retried and specifies the interval until the next retry.
protected boolean	evaluateLastAttemptAndSecondaryNotFound(RetryContext retryContext) Determines the time of the last attempt to a storage location and returns a boolean that specifies if a request that was sent to the secondary location failed with 404.
protected RetryInfo	evaluateRetryInfo(RetryContext retryContext, boolean secondaryNotFound, long retryInterval) Determines the RetryInfo object that indicates whether the next retry will happen in the primary or secondary location, and specifies the location mode.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microsoft.azure.storage.RetryPolicyFactory

createInstance

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.

lastPrimaryAttempt

protected Date lastPrimaryAttempt

Represents the time of the last request attempt to the primary location.

lastSecondaryAttempt

protected Date lastSecondaryAttempt

Represents the time of the last request attempt to the secondary location.

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

evaluate

public abstract RetryInfo evaluate(RetryContext retryContext,
                                   OperationContext operationContext)

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

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.

evaluateLastAttemptAndSecondaryNotFound

protected boolean evaluateLastAttemptAndSecondaryNotFound(RetryContext retryContext)

Determines the time of the last attempt to a storage location and returns a boolean that specifies if a request that was sent to the secondary location failed with 404.

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.

Returns:

true if a request sent to the secondary location fails with 404 (Not Found). false otherwise.

evaluateRetryInfo

protected RetryInfo evaluateRetryInfo(RetryContext retryContext,
                                      boolean secondaryNotFound,
                                      long retryInterval)

Determines the RetryInfo object that indicates whether the next retry will happen in the primary or secondary location, and specifies the location mode.

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.

secondaryNotFound - A boolean representing whether a request sent to the secondary location failed with 404 (Not Found)

retryInterval - Backoff Interval.

Returns:

A reference to the RetryInfo object that indicates whether the next retry will happen in the primary or secondary location, and specifies the location mode.