com.azure.core.http.policy

Class RetryPolicy

java.lang.Object

com.azure.core.http.policy.RetryPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public class RetryPolicy
extends Object
implements HttpPipelinePolicy

A pipeline policy that retries when a recoverable HTTP error occurs.

Constructor Summary

Constructors

Constructor and Description
RetryPolicy() Creates RetryPolicy with default ExponentialBackoff as RetryStrategy and ignore the delay provided in response header.
RetryPolicy(RetryStrategy retryStrategy) Creates a RetryPolicy with the provided RetryStrategy and ignore the delay provided in response header.
RetryPolicy(RetryStrategy retryStrategy, String retryAfterHeader, ChronoUnit retryAfterTimeUnit) Creates RetryPolicy with the provided RetryStrategy and default ExponentialBackoff as RetryStrategy.
RetryPolicy(String retryAfterHeader, ChronoUnit retryAfterTimeUnit) Creates RetryPolicy with default ExponentialBackoff as RetryStrategy and use provided retryAfterHeader in HttpResponse headers for calculating retry delay.

Method Summary

Modifier and Type	Method and Description
Mono<HttpResponse>	process(HttpPipelineCallContext context, HttpPipelineNextPolicy next) Process provided request context and invokes the next policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryPolicy

public RetryPolicy()

Creates RetryPolicy with default ExponentialBackoff as RetryStrategy and ignore the delay provided in response header.

RetryPolicy

public RetryPolicy(String retryAfterHeader,
                   ChronoUnit retryAfterTimeUnit)

Creates RetryPolicy with default ExponentialBackoff as RetryStrategy and use provided retryAfterHeader in HttpResponse headers for calculating retry delay.

Parameters:

retryAfterHeader - The HTTP header, such as 'Retry-After' or 'x-ms-retry-after-ms', to lookup for the retry delay. If the value is null, RetryPolicy will use the retry strategy to compute the delay and ignore the delay provided in response header.

retryAfterTimeUnit - The time unit to use when applying the retry delay. null is valid if, and only if, retryAfterHeader is null.

Throws:

NullPointerException - When retryAfterTimeUnit is null and retryAfterHeader is not null.

RetryPolicy

public RetryPolicy(RetryStrategy retryStrategy,
                   String retryAfterHeader,
                   ChronoUnit retryAfterTimeUnit)

Creates RetryPolicy with the provided RetryStrategy and default ExponentialBackoff as RetryStrategy. It will use provided retryAfterHeader in HttpResponse headers for calculating retry delay.

Parameters:

retryStrategy - The RetryStrategy used for retries.

retryAfterHeader - The HTTP header, such as 'Retry-After' or 'x-ms-retry-after-ms', to lookup for the retry delay. If the value is null, RetryPolicy will use the retry strategy to compute the delay and ignore the delay provided in response header.

retryAfterTimeUnit - The time unit to use when applying the retry delay. null is valid if, and only if, retryAfterHeader is null.

Throws:

NullPointerException - When retryStrategy is null. Also when retryAfterTimeUnit is null and retryAfterHeader is not null.

RetryPolicy

public RetryPolicy(RetryStrategy retryStrategy)

Creates a RetryPolicy with the provided RetryStrategy and ignore the delay provided in response header.

Parameters:

retryStrategy - The RetryStrategy used for retries.

Throws:

NullPointerException - When retryStrategy is null.

Method Detail

process

public Mono<HttpResponse> process(HttpPipelineCallContext context,
                                  HttpPipelineNextPolicy next)

Description copied from interface: HttpPipelinePolicy

Process provided request context and invokes the next policy.

Specified by:

process in interface HttpPipelinePolicy

Parameters:

context - request context

next - The next policy to invoke.

Returns:

A publisher that initiates the request upon subscription and emits a response on completion.