Interface HttpClient
- All Known Implementing Classes:
CloseableHttpClient
,InternalHttpClient
,MinimalHttpClient
- Since:
- 4.0
-
Method Summary
Modifier and TypeMethodDescriptionorg.apache.hc.core5.http.HttpResponse
execute
(org.apache.hc.core5.http.ClassicHttpRequest request) Deprecated.<T> T
execute
(org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler) Executes HTTP request using the default context and processes the response using the given response handler.org.apache.hc.core5.http.HttpResponse
execute
(org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context) Deprecated.It is strongly recommended to use execute methods withHttpClientResponseHandler
such asexecute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler)
in order to ensure automatic resource deallocation by the client.<T> T
execute
(org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler) Executes HTTP request using the given context and processes the response using the given response handler.org.apache.hc.core5.http.ClassicHttpResponse
execute
(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request) Deprecated.It is strongly recommended to use execute methods withHttpClientResponseHandler
such asexecute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler)
in order to ensure automatic resource deallocation by the client.<T> T
execute
(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler) Executes HTTP request to the target using the default context and processes the response using the given response handler.org.apache.hc.core5.http.HttpResponse
execute
(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context) Deprecated.It is strongly recommended to use execute methods withHttpClientResponseHandler
such asexecute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler)
in order to ensure automatic resource deallocation by the client.<T> T
execute
(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler) Executes HTTP request to the target using the given context and processes the response using the given response handler.default org.apache.hc.core5.http.ClassicHttpResponse
executeOpen
(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context) Executes the request and opens the response stream using the given context.
-
Method Details
-
execute
@Deprecated org.apache.hc.core5.http.HttpResponse execute(org.apache.hc.core5.http.ClassicHttpRequest request) throws IOException Deprecated.It is strongly recommended to use execute methods withHttpClientResponseHandler
such asexecute(ClassicHttpRequest, HttpClientResponseHandler)
in order to ensure automatic resource deallocation by the client. For special cases one can still useexecuteOpen(HttpHost, ClassicHttpRequest, HttpContext)
to keep the response object open after the request execution.Executes HTTP request using the default context.- Parameters:
request
- the request to execute- Returns:
- 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.
- Throws:
IOException
- in case of a problem or the connection was aborted- See Also:
-
execute
@Deprecated org.apache.hc.core5.http.HttpResponse execute(org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context) throws IOException Deprecated.It is strongly recommended to use execute methods withHttpClientResponseHandler
such asexecute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler)
in order to ensure automatic resource deallocation by the client. For special cases one can still useexecuteOpen(HttpHost, ClassicHttpRequest, HttpContext)
to keep the response object open after the request execution.Executes HTTP request using the given context.- Parameters:
request
- the request to executecontext
- the context to use for the execution, ornull
to use the default context- Returns:
- 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.
- Throws:
IOException
- in case of a problem or the connection was aborted- See Also:
-
execute
@Deprecated org.apache.hc.core5.http.ClassicHttpResponse execute(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request) throws IOException Deprecated.It is strongly recommended to use execute methods withHttpClientResponseHandler
such asexecute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler)
in order to ensure automatic resource deallocation by the client. For special cases one can still useexecuteOpen(HttpHost, ClassicHttpRequest, HttpContext)
to keep the response object open after the request execution.Executes HTTP request using the default context.- Parameters:
target
- the target host for the request. Implementations may acceptnull
if they can still determine a route, for example to a default target or by inspecting the request.request
- the request to execute- Returns:
- 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.
- Throws:
IOException
- in case of a problem or the connection was aborted- See Also:
-
execute
@Deprecated org.apache.hc.core5.http.HttpResponse execute(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context) throws IOException Deprecated.It is strongly recommended to use execute methods withHttpClientResponseHandler
such asexecute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler)
in order to ensure automatic resource deallocation by the client. For special cases one can still useexecuteOpen(HttpHost, ClassicHttpRequest, HttpContext)
to keep the response object open after the request execution.Executes HTTP request using the given context.- Parameters:
target
- the target host for the request. Implementations may acceptnull
if they can still determine a route, for example to a default target or by inspecting the request.request
- the request to executecontext
- the context to use for the execution, ornull
to use the default context- Returns:
- 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.
- Throws:
IOException
- in case of a problem or the connection was aborted- See Also:
-
executeOpen
default org.apache.hc.core5.http.ClassicHttpResponse executeOpen(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context) throws IOException Executes the request and opens the response stream using the given context.- Parameters:
target
- the target host for the request. Implementations may acceptnull
if they can still determine a route, for example to a default target or by inspecting the request.request
- the request to executecontext
- the context to use for the execution, ornull
to use the default context- Returns:
- 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.
The response returned by this method must be closed with
Closeable.close()
in order ensure deallocation of system resources. - Throws:
IOException
- in case of a problem or the connection was aborted- Since:
- 5.2
-
execute
<T> T execute(org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler) throws IOException 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
HttpClientResponseHandler
s from having to manage resource deallocation internally.- Parameters:
request
- the request to executeresponseHandler
- the response handler- Returns:
- the response object as generated by the response handler.
- Throws:
IOException
- in case of a problem or the connection was aborted
-
execute
<T> T execute(org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler) throws IOException 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
HttpClientResponseHandler
s from having to manage resource deallocation internally.- Parameters:
request
- the request to executecontext
- the context to use for the execution, ornull
to use the default contextresponseHandler
- the response handler- Returns:
- the response object as generated by the response handler.
- Throws:
IOException
- in case of a problem or the connection was aborted
-
execute
<T> T execute(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler) throws IOException 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
HttpClientResponseHandler
s from having to manage resource deallocation internally.- Parameters:
target
- the target host for the request. Implementations may acceptnull
if they can still determine a route, for example to a default target or by inspecting the request.request
- the request to executeresponseHandler
- the response handler- Returns:
- the response object as generated by the response handler.
- Throws:
IOException
- in case of a problem or the connection was aborted
-
execute
<T> T execute(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler) throws IOException 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
HttpClientResponseHandler
s from having to manage resource deallocation internally.- Parameters:
target
- the target host for the request. Implementations may acceptnull
if they can still determine a route, for example to a default target or by inspecting the request.request
- the request to executecontext
- the context to use for the execution, ornull
to use the default contextresponseHandler
- the response handler- Returns:
- the response object as generated by the response handler.
- Throws:
IOException
- in case of a problem or the connection was aborted
-
HttpClientResponseHandler
such asexecute(ClassicHttpRequest, HttpClientResponseHandler)
in order to ensure automatic resource deallocation by the client.