Apache HttpClient 5.3 · org.apache.hc.client5.http.impl.DefaultHttpRequestRetryStrategy

Field Summary

Modifier and Type	Field and Description
private final TimeValue	defaultRetryInterval Retry interval between subsequent retries
public static final DefaultHttpRequestRetryStrategy	INSTANCE
private final int	maxRetries Maximum number of allowed retries
private final Set<Class<? extends IOException>>	nonRetriableIOExceptionClasses Derived `IOExceptions` which shall not be retried
private final Set<Integer>	retriableCodes HTTP status codes which shall be retried

Constructor Summary

Access	Constructor and Description
protected	DefaultHttpRequestRetryStrategy(final int maxRetries, final TimeValue defaultRetryInterval, final Collection<Class<? extends IOException>> clazzes, final Collection<Integer> codes)
public	DefaultHttpRequestRetryStrategy(final int how many times to retry; 0 means no retries maxRetries, final TimeValue the default retry interval between subsequent retries if the `Retry-After` header is not set or invalid. defaultRetryInterval) Create the HTTP request retry strategy using the following list of non-retriable I/O exception classes: InterruptedIOException UnknownHostException ConnectException ConnectionClosedException NoRouteToHostException SSLException
public	DefaultHttpRequestRetryStrategy() Create the HTTP request retry strategy with a max retry count of 1, default retry interval of 1 second, and using the following list of non-retriable I/O exception classes: InterruptedIOException UnknownHostException ConnectException ConnectionClosedException SSLException

Method Summary

Modifier and Type	Method and Description
public TimeValue	getRetryInterval(final HttpResponse the response from the target server response, final int the number of times this method has been unsuccessfully executed execCount, final HttpContext the context for the request execution context) Implements org.apache.hc.client5.http.HttpRequestRetryStrategy.getRetryInterval. Determines the retry interval between subsequent retries.
protected boolean	handleAsIdempotent(final HttpRequest request)
public boolean	retryRequest(final HttpRequest the request failed due to an I/O exception request, final IOException the exception that occurred exception, final int the number of times this method has been unsuccessfully executed execCount, final HttpContext the context for the request execution context) Implements org.apache.hc.client5.http.HttpRequestRetryStrategy.retryRequest. Determines if a method should be retried after an I/O exception occurred during execution.
public boolean	retryRequest(final HttpResponse the response from the target server response, final int the number of times this method has been unsuccessfully executed execCount, final HttpContext the context for the request execution context) Implements org.apache.hc.client5.http.HttpRequestRetryStrategy.retryRequest. Determines if a method should be retried given the response from the target server.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

defaultRetryInterval	back to summary
private final TimeValue defaultRetryInterval Retry interval between subsequent retries

INSTANCE	back to summary
public static final DefaultHttpRequestRetryStrategy INSTANCE

maxRetries	back to summary
private final int maxRetries Maximum number of allowed retries

nonRetriableIOExceptionClasses	back to summary
private final Set<Class<? extends IOException>> nonRetriableIOExceptionClasses Derived `IOExceptions` which shall not be retried

retriableCodes	back to summary
private final Set<Integer> retriableCodes HTTP status codes which shall be retried

Constructor Detail

DefaultHttpRequestRetryStrategy	back to summary
protected DefaultHttpRequestRetryStrategy(final int maxRetries, final TimeValue defaultRetryInterval, final Collection<Class<? extends IOException>> clazzes, final Collection<Integer> codes)

DefaultHttpRequestRetryStrategy back to summary

DefaultHttpRequestRetryStrategy	back to summary
public DefaultHttpRequestRetryStrategy(final int maxRetries, final TimeValue defaultRetryInterval) Create the HTTP request retry strategy using the following list of non-retriable I/O exception classes: InterruptedIOException UnknownHostException ConnectException ConnectionClosedException NoRouteToHostException SSLException and retriable HTTP status codes: SC_TOO_MANY_REQUESTS (429) SC_SERVICE_UNAVAILABLE (503) Parameters maxRetries:int how many times to retry; 0 means no retries defaultRetryInterval:TimeValue the default retry interval between subsequent retries if the `Retry-After` header is not set or invalid.

public DefaultHttpRequestRetryStrategy(final int maxRetries, final TimeValue defaultRetryInterval)

Create the HTTP request retry strategy using the following list of non-retriable I/O exception classes:

InterruptedIOException
UnknownHostException
ConnectException
ConnectionClosedException
NoRouteToHostException
SSLException

and retriable HTTP status codes:

SC_TOO_MANY_REQUESTS (429)
SC_SERVICE_UNAVAILABLE (503)

Parameters

maxRetries:int: how many times to retry; 0 means no retries
defaultRetryInterval:TimeValue: the default retry interval between subsequent retries if the Retry-After header is not set or invalid.

DefaultHttpRequestRetryStrategy	back to summary
public DefaultHttpRequestRetryStrategy() Create the HTTP request retry strategy with a max retry count of 1, default retry interval of 1 second, and using the following list of non-retriable I/O exception classes: InterruptedIOException UnknownHostException ConnectException ConnectionClosedException SSLException and retriable HTTP status codes: SC_TOO_MANY_REQUESTS (429) SC_SERVICE_UNAVAILABLE (503)

DefaultHttpRequestRetryStrategy

back to summary

public DefaultHttpRequestRetryStrategy()

Create the HTTP request retry strategy with a max retry count of 1, default retry interval of 1 second, and using the following list of non-retriable I/O exception classes:

InterruptedIOException
UnknownHostException
ConnectException
ConnectionClosedException
SSLException

and retriable HTTP status codes:

SC_TOO_MANY_REQUESTS (429)
SC_SERVICE_UNAVAILABLE (503)

Method Detail

getRetryInterval	back to summary
public TimeValue getRetryInterval(final HttpResponse response, final int execCount, final HttpContext context) Implements org.apache.hc.client5.http.HttpRequestRetryStrategy.getRetryInterval. Doc from org.apache.hc.client5.http.HttpRequestRetryStrategy.getRetryInterval. Determines the retry interval between subsequent retries. Parameters response:HttpResponse the response from the target server execCount:int the number of times this method has been unsuccessfully executed context:HttpContext the context for the request execution Returns:TimeValue the retry interval between subsequent retries Annotations @Override

getRetryInterval

back to summary

public TimeValue getRetryInterval(final HttpResponse response, final int execCount, final HttpContext context)

Implements org.apache.hc.client5.http.HttpRequestRetryStrategy.getRetryInterval.

Doc from org.apache.hc.client5.http.HttpRequestRetryStrategy.getRetryInterval.

Determines the retry interval between subsequent retries.

Parameters

response:HttpResponse: the response from the target server
execCount:int: the number of times this method has been unsuccessfully executed
context:HttpContext: the context for the request execution

Returns:TimeValue

the retry interval between subsequent retries

Annotations

@Override

handleAsIdempotent	back to summary
protected boolean handleAsIdempotent(final HttpRequest request)

retryRequest back to summary

retryRequest	back to summary
public boolean retryRequest(final HttpRequest request, final IOException exception, final int execCount, final HttpContext context) Implements org.apache.hc.client5.http.HttpRequestRetryStrategy.retryRequest. Doc from org.apache.hc.client5.http.HttpRequestRetryStrategy.retryRequest. Determines if a method should be retried after an I/O exception occurred during execution. Parameters request:HttpRequest the request failed due to an I/O exception exception:IOException the exception that occurred execCount:int the number of times this method has been unsuccessfully executed context:HttpContext the context for the request execution Returns:boolean `true` if the request should be retried, `false` otherwise Annotations @Override

public boolean retryRequest(final HttpRequest request, final IOException exception, final int execCount, final HttpContext context)

Implements org.apache.hc.client5.http.HttpRequestRetryStrategy.retryRequest.

Doc from org.apache.hc.client5.http.HttpRequestRetryStrategy.retryRequest.

Determines if a method should be retried after an I/O exception occurred during execution.

Parameters

request:HttpRequest: the request failed due to an I/O exception
exception:IOException: the exception that occurred
execCount:int: the number of times this method has been unsuccessfully executed
context:HttpContext: the context for the request execution

Returns:boolean

true if the request should be retried, false otherwise

Annotations

@Override

retryRequest back to summary

retryRequest	back to summary
public boolean retryRequest(final HttpResponse response, final int execCount, final HttpContext context) Implements org.apache.hc.client5.http.HttpRequestRetryStrategy.retryRequest. Doc from org.apache.hc.client5.http.HttpRequestRetryStrategy.retryRequest. Determines if a method should be retried given the response from the target server. Parameters response:HttpResponse the response from the target server execCount:int the number of times this method has been unsuccessfully executed context:HttpContext the context for the request execution Returns:boolean `true` if the request should be retried, `false` otherwise Annotations @Override

public boolean retryRequest(final HttpResponse response, final int execCount, final HttpContext context)

Implements org.apache.hc.client5.http.HttpRequestRetryStrategy.retryRequest.

Doc from org.apache.hc.client5.http.HttpRequestRetryStrategy.retryRequest.

Determines if a method should be retried given the response from the target server.

Parameters

response:HttpResponse: the response from the target server
execCount:int: the number of times this method has been unsuccessfully executed
context:HttpContext: the context for the request execution

Returns:boolean

true if the request should be retried, false otherwise

Annotations

@Override

public Class DefaultHttpRequestRetryStrategy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail