Apache HttpClient 4.5.14 · org.apache.http.impl.client.AutoRetryHttpClient

Modifier and Type	Field and Description
private final HttpClient	backend
private final Log	log
private final ServiceUnavailableRetryStrategy	retryStrategy

Access	Constructor and Description
public	AutoRetryHttpClient(final HttpClient client, final ServiceUnavailableRetryStrategy retryStrategy)
public	AutoRetryHttpClient() Constructs a `AutoRetryHttpClient` with default caching settings that stores cache entries in memory and uses a vanilla `DefaultHttpClient` for backend requests.
public	AutoRetryHttpClient(final ServiceUnavailableRetryStrategy retry configuration module options config) Constructs a `AutoRetryHttpClient` with the given caching options that stores cache entries in memory and uses a vanilla `DefaultHttpClient` for backend requests.
public	AutoRetryHttpClient(final HttpClient used to make origin requests client) Constructs a `AutoRetryHttpClient` with default caching settings that stores cache entries in memory and uses the given `HttpClient` for backend requests.

Method Summary

Modifier and Type	Method and Description
public HttpResponse	execute(final HttpHost the target host for the request. Implementations may accept `null` if they can still determine a route, for example to a default target or by inspecting the request. target, final HttpRequest the request to execute request) Implements org.apache.http.client.HttpClient.execute. Executes HTTP request using the default context.
public <T> T	execute(final HttpHost the target host for the request. Implementations may accept `null` if they can still determine a route, for example to a default target or by inspecting the request. target, final HttpRequest the request to execute request, final ResponseHandler<? extends T> the response handler responseHandler) Implements org.apache.http.client.HttpClient.execute. Executes HTTP request to the target using the default context and processes the response using the given response handler.
public <T> T	execute(final HttpHost the target host for the request. Implementations may accept `null` if they can still determine a route, for example to a default target or by inspecting the request. target, final HttpRequest the request to execute request, final ResponseHandler<? extends T> the response handler responseHandler, final HttpContext the context to use for the execution, or `null` to use the default context context) Implements org.apache.http.client.HttpClient.execute. Executes HTTP request to the target using the given context and processes the response using the given response handler.
public HttpResponse	execute(final HttpUriRequest the request to execute request) Implements org.apache.http.client.HttpClient.execute. Executes HTTP request using the default context.
public HttpResponse	execute(final HttpUriRequest the request to execute request, final HttpContext the context to use for the execution, or `null` to use the default context context) Implements org.apache.http.client.HttpClient.execute. Executes HTTP request using the given context.
public <T> T	execute(final HttpUriRequest the request to execute request, final ResponseHandler<? extends T> the response handler responseHandler) Implements org.apache.http.client.HttpClient.execute. Executes HTTP request using the default context and processes the response using the given response handler.
public <T> T	execute(final HttpUriRequest the request to execute request, final ResponseHandler<? extends T> the response handler responseHandler, final HttpContext the context to use for the execution, or `null` to use the default context context) Implements org.apache.http.client.HttpClient.execute. Executes HTTP request using the given context and processes the response using the given response handler.
public HttpResponse	execute(final HttpHost the target host for the request. Implementations may accept `null` if they can still determine a route, for example to a default target or by inspecting the request. target, final HttpRequest the request to execute request, final HttpContext the context to use for the execution, or `null` to use the default context context) Implements org.apache.http.client.HttpClient.execute. Executes HTTP request using the given context.
public ClientConnectionManager	getConnectionManager() Implements org.apache.http.client.HttpClient.getConnectionManager. Deprecated as a consequence of `ClientConnectionManager` being deprecated. Obtains the connection manager used by this client.
public HttpParams	getParams() Implements org.apache.http.client.HttpClient.getParams. Deprecated as a consequence of `HttpParams` being deprecated. Obtains the parameters for this client.

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

backend	back to summary
private final HttpClient backend

log	back to summary
private final Log log

retryStrategy	back to summary
private final ServiceUnavailableRetryStrategy retryStrategy

AutoRetryHttpClient	back to summary
public AutoRetryHttpClient(final HttpClient client, final ServiceUnavailableRetryStrategy retryStrategy)

AutoRetryHttpClient	back to summary
public AutoRetryHttpClient() Constructs a `AutoRetryHttpClient` with default caching settings that stores cache entries in memory and uses a vanilla `DefaultHttpClient` for backend requests.

AutoRetryHttpClient	back to summary
public AutoRetryHttpClient(final ServiceUnavailableRetryStrategy config) Constructs a `AutoRetryHttpClient` with the given caching options that stores cache entries in memory and uses a vanilla `DefaultHttpClient` for backend requests. Parameters config:ServiceUnavailableRetryStrategy retry configuration module options

AutoRetryHttpClient	back to summary
public AutoRetryHttpClient(final HttpClient client) Constructs a `AutoRetryHttpClient` with default caching settings that stores cache entries in memory and uses the given `HttpClient` for backend requests. Parameters client:HttpClient used to make origin requests

Method Detail

execute back to summary

execute	back to summary
public HttpResponse execute(final HttpHost target, final HttpRequest request) throws IOException Implements org.apache.http.client.HttpClient.execute. Doc from org.apache.http.client.HttpClient.execute. Executes HTTP request using the default context. Parameters target:HttpHost the target host for the request. Implementations may accept `null` if they can still determine a route, for example to a default target or by inspecting the request. request:HttpRequest the request to execute Returns:HttpResponse the response to the request. This is always a final response, never an intermediate response with an 1xx status code. Whether redirects or authentication challenges will be returned or handled automatically depends on the implementation and configuration of this client. Annotations @Override Exceptions IOException: in case of a problem or the connection was aborted

public HttpResponse execute(final HttpHost target, final HttpRequest request) throws IOException

Implements org.apache.http.client.HttpClient.execute.

Doc from org.apache.http.client.HttpClient.execute.

Executes HTTP request using the default context.

Parameters

target:HttpHost: the target host for the request. Implementations may accept null if they can still determine a route, for example to a default target or by inspecting the request.
request:HttpRequest: the request to execute

Returns:HttpResponse

the response to the request. This is always a final response, never an intermediate response with an 1xx status code. Whether redirects or authentication challenges will be returned or handled automatically depends on the implementation and configuration of this client.

Annotations

@Override

Exceptions

IOException:: in case of a problem or the connection was aborted

execute back to summary

execute	back to summary
public <T> T execute(final HttpHost target, final HttpRequest request, final ResponseHandler<? extends T> responseHandler) throws IOException Implements org.apache.http.client.HttpClient.execute. Doc from org.apache.http.client.HttpClient.execute. Executes HTTP request to the target using the default context and processes the response using the given response handler. Implementing classes are required to ensure that the content entity associated with the response is fully consumed and the underlying connection is released back to the connection manager automatically in all cases relieving individual `ResponseHandler`s from having to manage resource deallocation internally. Parameters target:HttpHost the target host for the request. Implementations may accept `null` if they can still determine a route, for example to a default target or by inspecting the request. request:HttpRequest the request to execute responseHandler:ResponseHandler<? extends T> the response handler Returns:T the response object as generated by the response handler. Annotations @Override Exceptions IOException: in case of a problem or the connection was aborted

public <T> T execute(final HttpHost target, final HttpRequest request, final ResponseHandler<? extends T> responseHandler) throws IOException

Implements org.apache.http.client.HttpClient.execute.

Doc from org.apache.http.client.HttpClient.execute.

Executes HTTP request to the target using the default context and processes the response using the given response handler.

Implementing classes are required to ensure that the content entity associated with the response is fully consumed and the underlying connection is released back to the connection manager automatically in all cases relieving individual ResponseHandlers from having to manage resource deallocation internally.

Parameters

target:HttpHost: the target host for the request. Implementations may accept null if they can still determine a route, for example to a default target or by inspecting the request.
request:HttpRequest: the request to execute
responseHandler:ResponseHandler<? extends T>: the response handler

Returns:T

the response object as generated by the response handler.

Annotations

@Override

Exceptions

IOException:: in case of a problem or the connection was aborted

execute back to summary

execute	back to summary
public <T> T execute(final HttpHost target, final HttpRequest request, final ResponseHandler<? extends T> responseHandler, final HttpContext context) throws IOException Implements org.apache.http.client.HttpClient.execute. Doc from org.apache.http.client.HttpClient.execute. Executes HTTP request to the target using the given context and processes the response using the given response handler. Implementing classes are required to ensure that the content entity associated with the response is fully consumed and the underlying connection is released back to the connection manager automatically in all cases relieving individual `ResponseHandler`s from having to manage resource deallocation internally. Parameters target:HttpHost the target host for the request. Implementations may accept `null` if they can still determine a route, for example to a default target or by inspecting the request. request:HttpRequest the request to execute responseHandler:ResponseHandler<? extends T> the response handler context:HttpContext the context to use for the execution, or `null` to use the default context Returns:T the response object as generated by the response handler. Annotations @Override Exceptions IOException: in case of a problem or the connection was aborted

public <T> T execute(final HttpHost target, final HttpRequest request, final ResponseHandler<? extends T> responseHandler, final HttpContext context) throws IOException

Implements org.apache.http.client.HttpClient.execute.

Doc from org.apache.http.client.HttpClient.execute.

Executes HTTP request to the target using the given context and processes the response using the given response handler.

Parameters

target:HttpHost: the target host for the request. Implementations may accept null if they can still determine a route, for example to a default target or by inspecting the request.
request:HttpRequest: the request to execute
responseHandler:ResponseHandler<? extends T>: the response handler
context:HttpContext: the context to use for the execution, or null to use the default context

Returns:T

the response object as generated by the response handler.

Annotations

@Override

Exceptions

IOException:: in case of a problem or the connection was aborted

execute	back to summary
public HttpResponse execute(final HttpUriRequest request) throws IOException Implements org.apache.http.client.HttpClient.execute. Doc from org.apache.http.client.HttpClient.execute. Executes HTTP request using the default context. Parameters request:HttpUriRequest the request to execute Returns:HttpResponse the response to the request. This is always a final response, never an intermediate response with an 1xx status code. Whether redirects or authentication challenges will be returned or handled automatically depends on the implementation and configuration of this client. Annotations @Override Exceptions IOException: in case of a problem or the connection was aborted

execute

back to summary

public HttpResponse execute(final HttpUriRequest request) throws IOException

Implements org.apache.http.client.HttpClient.execute.

Doc from org.apache.http.client.HttpClient.execute.

Executes HTTP request using the default context.

Parameters

request:HttpUriRequest: the request to execute

Returns:HttpResponse

Annotations

@Override

Exceptions

IOException:: in case of a problem or the connection was aborted

execute back to summary

execute	back to summary
public HttpResponse execute(final HttpUriRequest request, final HttpContext context) throws IOException Implements org.apache.http.client.HttpClient.execute. Doc from org.apache.http.client.HttpClient.execute. Executes HTTP request using the given context. Parameters request:HttpUriRequest the request to execute context:HttpContext the context to use for the execution, or `null` to use the default context Returns:HttpResponse the response to the request. This is always a final response, never an intermediate response with an 1xx status code. Whether redirects or authentication challenges will be returned or handled automatically depends on the implementation and configuration of this client. Annotations @Override Exceptions IOException: in case of a problem or the connection was aborted

public HttpResponse execute(final HttpUriRequest request, final HttpContext context) throws IOException

Implements org.apache.http.client.HttpClient.execute.

Doc from org.apache.http.client.HttpClient.execute.

Executes HTTP request using the given context.

Parameters

request:HttpUriRequest: the request to execute
context:HttpContext: the context to use for the execution, or null to use the default context

Returns:HttpResponse

Annotations

@Override

Exceptions

IOException:: in case of a problem or the connection was aborted

execute back to summary

execute	back to summary
public <T> T execute(final HttpUriRequest request, final ResponseHandler<? extends T> responseHandler) throws IOException Implements org.apache.http.client.HttpClient.execute. Doc from org.apache.http.client.HttpClient.execute. Executes HTTP request using the default context and processes the response using the given response handler. Implementing classes are required to ensure that the content entity associated with the response is fully consumed and the underlying connection is released back to the connection manager automatically in all cases relieving individual `ResponseHandler`s from having to manage resource deallocation internally. Parameters request:HttpUriRequest the request to execute responseHandler:ResponseHandler<? extends T> the response handler Returns:T the response object as generated by the response handler. Annotations @Override Exceptions IOException: in case of a problem or the connection was aborted

public <T> T execute(final HttpUriRequest request, final ResponseHandler<? extends T> responseHandler) throws IOException

Implements org.apache.http.client.HttpClient.execute.

Doc from org.apache.http.client.HttpClient.execute.

Executes HTTP request using the default context and processes the response using the given response handler.

Parameters

request:HttpUriRequest: the request to execute
responseHandler:ResponseHandler<? extends T>: the response handler

Returns:T

the response object as generated by the response handler.

Annotations

@Override

Exceptions

IOException:: in case of a problem or the connection was aborted

execute back to summary

execute	back to summary
public <T> T execute(final HttpUriRequest request, final ResponseHandler<? extends T> responseHandler, final HttpContext context) throws IOException Implements org.apache.http.client.HttpClient.execute. Doc from org.apache.http.client.HttpClient.execute. Executes HTTP request using the given context and processes the response using the given response handler. Implementing classes are required to ensure that the content entity associated with the response is fully consumed and the underlying connection is released back to the connection manager automatically in all cases relieving individual `ResponseHandler`s from having to manage resource deallocation internally. Parameters request:HttpUriRequest the request to execute responseHandler:ResponseHandler<? extends T> the response handler context:HttpContext the context to use for the execution, or `null` to use the default context Returns:T the response object as generated by the response handler. Annotations @Override Exceptions IOException: in case of a problem or the connection was aborted

public <T> T execute(final HttpUriRequest request, final ResponseHandler<? extends T> responseHandler, final HttpContext context) throws IOException

Implements org.apache.http.client.HttpClient.execute.

Doc from org.apache.http.client.HttpClient.execute.

Executes HTTP request using the given context and processes the response using the given response handler.

Parameters

request:HttpUriRequest: the request to execute
responseHandler:ResponseHandler<? extends T>: the response handler
context:HttpContext: the context to use for the execution, or null to use the default context

Returns:T

the response object as generated by the response handler.

Annotations

@Override

Exceptions

IOException:: in case of a problem or the connection was aborted

execute back to summary

execute	back to summary
public HttpResponse execute(final HttpHost target, final HttpRequest request, final HttpContext context) throws IOException Implements org.apache.http.client.HttpClient.execute. Doc from org.apache.http.client.HttpClient.execute. Executes HTTP request using the given context. Parameters target:HttpHost the target host for the request. Implementations may accept `null` if they can still determine a route, for example to a default target or by inspecting the request. request:HttpRequest the request to execute context:HttpContext the context to use for the execution, or `null` to use the default context Returns:HttpResponse the response to the request. This is always a final response, never an intermediate response with an 1xx status code. Whether redirects or authentication challenges will be returned or handled automatically depends on the implementation and configuration of this client. Annotations @Override Exceptions IOException: in case of a problem or the connection was aborted

public HttpResponse execute(final HttpHost target, final HttpRequest request, final HttpContext context) throws IOException

Implements org.apache.http.client.HttpClient.execute.

Doc from org.apache.http.client.HttpClient.execute.

Executes HTTP request using the given context.

Parameters

target:HttpHost: the target host for the request. Implementations may accept null if they can still determine a route, for example to a default target or by inspecting the request.
request:HttpRequest: the request to execute
context:HttpContext: the context to use for the execution, or null to use the default context

Returns:HttpResponse

Annotations

@Override

Exceptions

IOException:: in case of a problem or the connection was aborted

getConnectionManager back to summary

getConnectionManager	back to summary
public ClientConnectionManager getConnectionManager() Implements org.apache.http.client.HttpClient.getConnectionManager. Doc from org.apache.http.client.HttpClient.getConnectionManager. Deprecated as a consequence of `ClientConnectionManager` being deprecated. See corresponding docs for further information. Obtains the connection manager used by this client. Returns:ClientConnectionManager the connection manager Annotations @Override

public ClientConnectionManager getConnectionManager()

Implements org.apache.http.client.HttpClient.getConnectionManager.

Doc from org.apache.http.client.HttpClient.getConnectionManager.

Deprecated

as a consequence of ClientConnectionManager being deprecated. See corresponding docs for further information.

Obtains the connection manager used by this client.

Returns:ClientConnectionManager

the connection manager

Annotations

@Override

getParams back to summary

getParams	back to summary
public HttpParams getParams() Implements org.apache.http.client.HttpClient.getParams. Doc from org.apache.http.client.HttpClient.getParams. Deprecated as a consequence of `HttpParams` being deprecated. See corresponding docs for further information. Obtains the parameters for this client. These parameters will become defaults for all requests being executed with this client, and for the parameters of dependent objects in this client. Returns:HttpParams the default parameters Annotations @Override

public HttpParams getParams()

Implements org.apache.http.client.HttpClient.getParams.

Doc from org.apache.http.client.HttpClient.getParams.

Deprecated

as a consequence of HttpParams being deprecated. See corresponding docs for further information.

Obtains the parameters for this client. These parameters will become defaults for all requests being executed with this client, and for the parameters of dependent objects in this client.

Returns:HttpParams

the default parameters

Annotations

@Override

public Class AutoRetryHttpClient

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail