Package org.apache.http.impl.client

Class CloseableHttpClient

java.lang.Object

org.apache.http.impl.client.CloseableHttpClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, HttpClient

Direct Known Subclasses:

AbstractHttpClient

@Contract(threading=SAFE)
public abstract class CloseableHttpClient
extends java.lang.Object
implements HttpClient, java.io.Closeable

Base implementation of HttpClient that also implements Closeable.

Since:

4.3

Constructor Summary

Constructors

Constructor	Description
CloseableHttpClient()

Method Summary

Modifier and Type	Method	Description
CloseableHttpResponse	execute(HttpUriRequest request)	Executes HTTP request using the default context.
<T> T	execute(HttpUriRequest request, ResponseHandler<? extends T> responseHandler)	Executes a request using the default context and processes the response using the given response handler.
<T> T	execute(HttpUriRequest request, ResponseHandler<? extends T> responseHandler, HttpContext context)	Executes a request using the default context and processes the response using the given response handler.
CloseableHttpResponse	execute(HttpUriRequest request, HttpContext context)	Executes HTTP request using the given context.
CloseableHttpResponse	execute(HttpHost target, HttpRequest request)	Executes HTTP request using the default context.
<T> T	execute(HttpHost target, HttpRequest request, ResponseHandler<? extends T> responseHandler)	Executes a request using the default context and processes the response using the given response handler.
<T> T	execute(HttpHost target, HttpRequest request, ResponseHandler<? extends T> responseHandler, HttpContext context)	Executes a request using the default context and processes the response using the given response handler.
CloseableHttpResponse	execute(HttpHost target, HttpRequest request, HttpContext context)	Executes HTTP request using the given context.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.apache.http.client.HttpClient

getConnectionManager, getParams

Constructor Detail

CloseableHttpClient

public CloseableHttpClient()

Method Detail

execute

public CloseableHttpResponse execute(HttpHost target,
                                     HttpRequest request,
                                     HttpContext context)
                              throws java.io.IOException,
                                     ClientProtocolException

Executes HTTP request using the given context.

Specified by:

execute in interface HttpClient

Parameters:

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

context - the context to use for the execution, or null 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:

java.io.IOException - in case of a problem or the connection was aborted

ClientProtocolException - in case of an http protocol error

execute

public CloseableHttpResponse execute(HttpUriRequest request,
                                     HttpContext context)
                              throws java.io.IOException,
                                     ClientProtocolException

Executes HTTP request using the given context.

Specified by:

execute in interface HttpClient

Parameters:

request - the request to execute

context - the context to use for the execution, or null 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:

java.io.IOException - in case of a problem or the connection was aborted

ClientProtocolException - in case of an http protocol error

execute

public CloseableHttpResponse execute(HttpUriRequest request)
                              throws java.io.IOException,
                                     ClientProtocolException

Executes HTTP request using the default context.

Specified by:

execute in interface HttpClient

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:

java.io.IOException - in case of a problem or the connection was aborted

ClientProtocolException - in case of an http protocol error

execute

public CloseableHttpResponse execute(HttpHost target,
                                     HttpRequest request)
                              throws java.io.IOException,
                                     ClientProtocolException

Executes HTTP request using the default context.

Specified by:

execute in interface HttpClient

Parameters:

target - 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 - 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:

java.io.IOException - in case of a problem or the connection was aborted

ClientProtocolException - in case of an http protocol error

execute

public <T> T execute(HttpUriRequest request,
                     ResponseHandler<? extends T> responseHandler)
              throws java.io.IOException,
                     ClientProtocolException

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 ResponseHandlers from having to manage resource deallocation internally.

Specified by:

execute in interface HttpClient

Parameters:

request - the request to execute

responseHandler - the response handler

Returns:

the response object as generated by the response handler.

Throws:

java.io.IOException - in case of a problem or the connection was aborted

ClientProtocolException - in case of an http protocol error

execute

public <T> T execute(HttpUriRequest request,
                     ResponseHandler<? extends T> responseHandler,
                     HttpContext context)
              throws java.io.IOException,
                     ClientProtocolException

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 ResponseHandlers from having to manage resource deallocation internally.

Specified by:

execute in interface HttpClient

Parameters:

request - the request to execute

responseHandler - the response handler

context - the context to use for the execution, or null to use the default context

Returns:

the response object as generated by the response handler.

Throws:

java.io.IOException - in case of a problem or the connection was aborted

ClientProtocolException - in case of an http protocol error

execute

public <T> T execute(HttpHost target,
                     HttpRequest request,
                     ResponseHandler<? extends T> responseHandler)
              throws java.io.IOException,
                     ClientProtocolException

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 ResponseHandlers from having to manage resource deallocation internally.

Specified by:

execute in interface HttpClient

Parameters:

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

responseHandler - the response handler

Returns:

the response object as generated by the response handler.

Throws:

java.io.IOException - in case of a problem or the connection was aborted

ClientProtocolException - in case of an http protocol error

execute

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

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 ResponseHandlers from having to manage resource deallocation internally.

Specified by:

execute in interface HttpClient

Parameters:

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

responseHandler - the response handler

context - the context to use for the execution, or null to use the default context

Returns:

the response object as generated by the response handler.

Throws:

java.io.IOException - in case of a problem or the connection was aborted

ClientProtocolException - in case of an http protocol error