com.cloudant.http.interceptors

Class Replay429Interceptor

java.lang.Object

com.cloudant.http.interceptors.Replay429Interceptor

All Implemented Interfaces:

HttpConnectionInterceptor, HttpConnectionResponseInterceptor

public class Replay429Interceptor
extends java.lang.Object
implements HttpConnectionResponseInterceptor

An implementation of HttpConnectionResponseInterceptor that retries requests if they receive a 429 Too Many Requests response. The interceptor will replay the request after a delay and thereafter continue to replay the request after doubling the delay time for each subsequent 429 response received up to the maximum number of retries.

Field Summary

Fields

Modifier and Type	Field and Description
static Replay429Interceptor	WITH_DEFAULTS Get an instance of a Replay429Interceptor configured with the defaults of 3 retries starting at a 250 ms backoff and preferring any Retry-After header that may be sent by the server.

Constructor Summary

Constructors

Constructor and Description
Replay429Interceptor(int numberOfReplays, long initialBackoff) Construct a new Replay429Interceptor with a customized number of retries and initial backoff time.
Replay429Interceptor(int numberOfReplays, long initialBackoff, boolean preferRetryAfter) Construct a new Replay429Interceptor with a customized number of retries and initial backoff time, specifying whether to honour Retry-After headers sent from the server.

Method Summary

Modifier and Type	Method and Description
HttpConnectionInterceptorContext	interceptResponse(HttpConnectionInterceptorContext context) Intercept the response This method must not do any of the following Return null Read the response stream

Methods inherited from class java.lang.Object

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

Field Detail

WITH_DEFAULTS

public static final Replay429Interceptor WITH_DEFAULTS

Get an instance of a Replay429Interceptor configured with the defaults of 3 retries starting at a 250 ms backoff and preferring any Retry-After header that may be sent by the server.

Constructor Detail

Replay429Interceptor

public Replay429Interceptor(int numberOfReplays,
                            long initialBackoff)

Construct a new Replay429Interceptor with a customized number of retries and initial backoff time. Instances created with this constructor will honour Retry-After headers sent by the server if available.

Parameters:

numberOfReplays - number of times to replay a request that received a 429

initialBackoff - the initial delay before retrying

Replay429Interceptor

public Replay429Interceptor(int numberOfReplays,
                            long initialBackoff,
                            boolean preferRetryAfter)

Construct a new Replay429Interceptor with a customized number of retries and initial backoff time, specifying whether to honour Retry-After headers sent from the server.

Parameters:

numberOfReplays - number of times to replay a request that received a 429

initialBackoff - the initial delay before retrying

preferRetryAfter - whether the replay should honour the duration specified by a Retry-After header sent by the server in preference to the local doubling backoff.

Method Detail

interceptResponse

public HttpConnectionInterceptorContext interceptResponse(HttpConnectionInterceptorContext context)

Description copied from interface: HttpConnectionResponseInterceptor

Intercept the response This method must not do any of the following

• Return null
• Read the response stream

Specified by:

interceptResponse in interface HttpConnectionResponseInterceptor

Parameters:

context - Input context

Returns:

Output context