Apache HttpClient 5.3 · org.apache.hc.client5.http.impl.classic.CloseableHttpClient

Modifier and Type	Field and Description
private static final Logger	LOG

Access	Constructor and Description
public	CloseableHttpClient()

Method Summary

Modifier and Type	Method and Description
private static HttpHost	determineTarget(final ClassicHttpRequest request)
protected abstract CloseableHttpResponse	doExecute(HttpHost target, ClassicHttpRequest request, HttpContext context)
public CloseableHttpResponse	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 ClassicHttpRequest 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.hc.client5.http.classic.HttpClient.execute. Deprecated It is strongly recommended to use execute methods with `HttpClientResponseHandler` such as `execute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler)` in order to ensure automatic resource deallocation by the client. Executes HTTP request using the given context.
public CloseableHttpResponse	execute(final ClassicHttpRequest 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.hc.client5.http.classic.HttpClient.execute. Deprecated It is strongly recommended to use execute methods with `HttpClientResponseHandler` such as `execute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler)` in order to ensure automatic resource deallocation by the client. Executes HTTP request using the given context.
public CloseableHttpResponse	execute(final ClassicHttpRequest the request to execute request) Implements org.apache.hc.client5.http.classic.HttpClient.execute. Deprecated It is strongly recommended to use execute methods with `HttpClientResponseHandler` such as `execute(ClassicHttpRequest, HttpClientResponseHandler)` in order to ensure automatic resource deallocation by the client. Executes HTTP request using the default context.
public CloseableHttpResponse	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 ClassicHttpRequest the request to execute request) Implements org.apache.hc.client5.http.classic.HttpClient.execute. Deprecated It is strongly recommended to use execute methods with `HttpClientResponseHandler` such as `execute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler)` in order to ensure automatic resource deallocation by the client. Executes HTTP request using the default context.
public <T> T	Returns: the response object as generated by the response handler. execute(final ClassicHttpRequest the request to execute request, final HttpClientResponseHandler<? extends T> the response handler responseHandler) Implements org.apache.hc.client5.http.classic.HttpClient.execute. Executes a request using the default context and processes the response using the given response handler.
public <T> T	Returns: the response object as generated by the response handler. execute(final ClassicHttpRequest the request to execute request, final HttpContext the context to use for the execution, or `null` to use the default context context, final HttpClientResponseHandler<? extends T> the response handler responseHandler) Implements org.apache.hc.client5.http.classic.HttpClient.execute. Executes a request using the default context and processes the response using the given response handler.
public <T> T	Returns: the response object as generated by the response handler. 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 ClassicHttpRequest the request to execute request, final HttpClientResponseHandler<? extends T> the response handler responseHandler) Implements org.apache.hc.client5.http.classic.HttpClient.execute. Executes a request using the default context and processes the response using the given response handler.
public <T> T	Returns: the response object as generated by the response handler. 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 ClassicHttpRequest the request to execute request, final HttpContext the context to use for the execution, or `null` to use the default context context, final HttpClientResponseHandler<? extends T> the response handler responseHandler) Implements org.apache.hc.client5.http.classic.HttpClient.execute. Executes a request using the default context and processes the response using the given response handler.

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

LOG	back to summary
private static final Logger LOG

CloseableHttpClient	back to summary
public CloseableHttpClient()

Method Detail

determineTarget	back to summary
private static HttpHost determineTarget(final ClassicHttpRequest request) throws ClientProtocolException

doExecute	back to summary
protected abstract CloseableHttpResponse doExecute(HttpHost target, ClassicHttpRequest request, HttpContext context) throws IOException

execute back to summary

execute	back to summary
public CloseableHttpResponse execute(final HttpHost target, final ClassicHttpRequest request, final HttpContext context) throws IOException Implements org.apache.hc.client5.http.classic.HttpClient.execute. Doc from org.apache.hc.client5.http.classic.HttpClient.execute. Deprecated It is strongly recommended to use execute methods with `HttpClientResponseHandler` such as `execute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler)` in order to ensure automatic resource deallocation by the client. For special cases one can still use `executeOpen(HttpHost, ClassicHttpRequest, HttpContext)` to keep the response object open after the request execution. 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:ClassicHttpRequest the request to execute context:HttpContext the context to use for the execution, or `null` to use the default context Returns:CloseableHttpResponse 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 @Deprecated @Override Exceptions IOException: in case of a problem or the connection was aborted See Also `execute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler)`, `executeOpen(HttpHost, ClassicHttpRequest, HttpContext)`

public CloseableHttpResponse execute(final HttpHost target, final ClassicHttpRequest request, final HttpContext context) throws IOException

Implements org.apache.hc.client5.http.classic.HttpClient.execute.

Doc from org.apache.hc.client5.http.classic.HttpClient.execute.

Deprecated

It is strongly recommended to use execute methods with HttpClientResponseHandler such as execute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler) in order to ensure automatic resource deallocation by the client. For special cases one can still use executeOpen(HttpHost, ClassicHttpRequest, HttpContext) to keep the response object open after the request execution.

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:ClassicHttpRequest: the request to execute
context:HttpContext: the context to use for the execution, or null to use the default context

Returns:CloseableHttpResponse

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

@Deprecated
@Override

Exceptions

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

execute back to summary

execute	back to summary
public CloseableHttpResponse execute(final ClassicHttpRequest request, final HttpContext context) throws IOException Implements org.apache.hc.client5.http.classic.HttpClient.execute. Doc from org.apache.hc.client5.http.classic.HttpClient.execute. Deprecated It is strongly recommended to use execute methods with `HttpClientResponseHandler` such as `execute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler)` in order to ensure automatic resource deallocation by the client. For special cases one can still use `executeOpen(HttpHost, ClassicHttpRequest, HttpContext)` to keep the response object open after the request execution. Executes HTTP request using the given context. Parameters request:ClassicHttpRequest the request to execute context:HttpContext the context to use for the execution, or `null` to use the default context Returns:CloseableHttpResponse 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 @Deprecated @Override Exceptions IOException: in case of a problem or the connection was aborted See Also `execute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler)`, `executeOpen(HttpHost, ClassicHttpRequest, HttpContext)`

public CloseableHttpResponse execute(final ClassicHttpRequest request, final HttpContext context) throws IOException

Implements org.apache.hc.client5.http.classic.HttpClient.execute.

Doc from org.apache.hc.client5.http.classic.HttpClient.execute.

Deprecated

It is strongly recommended to use execute methods with HttpClientResponseHandler such as execute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler) in order to ensure automatic resource deallocation by the client. For special cases one can still use executeOpen(HttpHost, ClassicHttpRequest, HttpContext) to keep the response object open after the request execution.

Executes HTTP request using the given context.

Parameters

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

Returns:CloseableHttpResponse

Annotations

@Deprecated
@Override

Exceptions

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

execute back to summary

execute	back to summary
public CloseableHttpResponse execute(final ClassicHttpRequest request) throws IOException Implements org.apache.hc.client5.http.classic.HttpClient.execute. Doc from org.apache.hc.client5.http.classic.HttpClient.execute. Deprecated It is strongly recommended to use execute methods with `HttpClientResponseHandler` such as `execute(ClassicHttpRequest, HttpClientResponseHandler)` in order to ensure automatic resource deallocation by the client. For special cases one can still use `executeOpen(HttpHost, ClassicHttpRequest, HttpContext)` to keep the response object open after the request execution. Executes HTTP request using the default context. Parameters request:ClassicHttpRequest the request to execute Returns:CloseableHttpResponse 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 @Deprecated @Override Exceptions IOException: in case of a problem or the connection was aborted See Also `execute(ClassicHttpRequest, HttpClientResponseHandler)`, `executeOpen(HttpHost, ClassicHttpRequest, HttpContext)`

public CloseableHttpResponse execute(final ClassicHttpRequest request) throws IOException

Implements org.apache.hc.client5.http.classic.HttpClient.execute.

Doc from org.apache.hc.client5.http.classic.HttpClient.execute.

Deprecated

It is strongly recommended to use execute methods with HttpClientResponseHandler such as execute(ClassicHttpRequest, HttpClientResponseHandler) in order to ensure automatic resource deallocation by the client. For special cases one can still use executeOpen(HttpHost, ClassicHttpRequest, HttpContext) to keep the response object open after the request execution.

Executes HTTP request using the default context.

Parameters

request:ClassicHttpRequest: the request to execute

Returns:CloseableHttpResponse

Annotations

@Deprecated
@Override

Exceptions

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

execute back to summary

execute	back to summary
public CloseableHttpResponse execute(final HttpHost target, final ClassicHttpRequest request) throws IOException Implements org.apache.hc.client5.http.classic.HttpClient.execute. Doc from org.apache.hc.client5.http.classic.HttpClient.execute. Deprecated It is strongly recommended to use execute methods with `HttpClientResponseHandler` such as `execute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler)` in order to ensure automatic resource deallocation by the client. For special cases one can still use `executeOpen(HttpHost, ClassicHttpRequest, HttpContext)` to keep the response object open after the request execution. 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:ClassicHttpRequest the request to execute Returns:CloseableHttpResponse 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 @Deprecated @Override Exceptions IOException: in case of a problem or the connection was aborted See Also `execute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler)`, `executeOpen(HttpHost, ClassicHttpRequest, HttpContext)`

public CloseableHttpResponse execute(final HttpHost target, final ClassicHttpRequest request) throws IOException

Implements org.apache.hc.client5.http.classic.HttpClient.execute.

Doc from org.apache.hc.client5.http.classic.HttpClient.execute.

Deprecated

It is strongly recommended to use execute methods with HttpClientResponseHandler such as execute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler) in order to ensure automatic resource deallocation by the client. For special cases one can still use executeOpen(HttpHost, ClassicHttpRequest, HttpContext) to keep the response object open after the request execution.

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:ClassicHttpRequest: the request to execute

Returns:CloseableHttpResponse

Annotations

@Deprecated
@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 ClassicHttpRequest request, final HttpClientResponseHandler<? extends T> responseHandler) throws IOException Implements org.apache.hc.client5.http.classic.HttpClient.execute. Executes a request using the default context and processes the response using the given response handler. 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 `HttpClientResponseHandler`s from having to manage resource deallocation internally. Parameters request:ClassicHttpRequest the request to execute responseHandler:HttpClientResponseHandler<? 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 ClientProtocolException: in case of an http protocol error

public <T> T execute(final ClassicHttpRequest request, final HttpClientResponseHandler<? extends T> responseHandler) throws IOException

Implements org.apache.hc.client5.http.classic.HttpClient.execute.

Executes a request using the default context and processes the response using the given response handler. 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 HttpClientResponseHandlers from having to manage resource deallocation internally.

Parameters

request:ClassicHttpRequest: the request to execute
responseHandler:HttpClientResponseHandler<? 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
ClientProtocolException:: in case of an http protocol error

execute back to summary

execute	back to summary
public <T> T execute(final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler<? extends T> responseHandler) throws IOException Implements org.apache.hc.client5.http.classic.HttpClient.execute. Executes a request using the default context and processes the response using the given response handler. 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 `HttpClientResponseHandler`s from having to manage resource deallocation internally. Parameters request:ClassicHttpRequest the request to execute context:HttpContext the context to use for the execution, or `null` to use the default context responseHandler:HttpClientResponseHandler<? 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 ClientProtocolException: in case of an http protocol error

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

Implements org.apache.hc.client5.http.classic.HttpClient.execute.

Parameters

request:ClassicHttpRequest: the request to execute
context:HttpContext: the context to use for the execution, or null to use the default context
responseHandler:HttpClientResponseHandler<? 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
ClientProtocolException:: in case of an http protocol error

execute back to summary

execute	back to summary
public <T> T execute(final HttpHost target, final ClassicHttpRequest request, final HttpClientResponseHandler<? extends T> responseHandler) throws IOException Implements org.apache.hc.client5.http.classic.HttpClient.execute. Executes a request using the default context and processes the response using the given response handler. 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 `HttpClientResponseHandler`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:ClassicHttpRequest the request to execute responseHandler:HttpClientResponseHandler<? 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 ClientProtocolException: in case of an http protocol error

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

Implements org.apache.hc.client5.http.classic.HttpClient.execute.

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:ClassicHttpRequest: the request to execute
responseHandler:HttpClientResponseHandler<? 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
ClientProtocolException:: in case of an http protocol error

execute back to summary

execute	back to summary
public <T> T execute(final HttpHost target, final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler<? extends T> responseHandler) throws IOException Implements org.apache.hc.client5.http.classic.HttpClient.execute. Executes a request using the default context and processes the response using the given response handler. 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 `HttpClientResponseHandler`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:ClassicHttpRequest the request to execute context:HttpContext the context to use for the execution, or `null` to use the default context responseHandler:HttpClientResponseHandler<? 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 ClientProtocolException: in case of an http protocol error

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

Implements org.apache.hc.client5.http.classic.HttpClient.execute.

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:ClassicHttpRequest: the request to execute
context:HttpContext: the context to use for the execution, or null to use the default context
responseHandler:HttpClientResponseHandler<? 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
ClientProtocolException:: in case of an http protocol error

public abstract Class CloseableHttpClient

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail