Package org.apache.http.client

Interface HttpClient

All Known Implementing Classes:

AbstractHttpClient, DefaultHttpClient

public interface HttpClient

Interface for an HTTP client. HTTP clients encapsulate a smorgasbord of objects required to execute HTTP requests while handling cookies, authentication, connection management, and other features. Thread safety of HTTP clients depends on the implementation and configuration of the specific client.

Since:

4.0

Version:

$Revision: 676020 $

Author:

Roland Weber

Method Summary

Modifier and Type	Method	Description
HttpResponse	execute(HttpUriRequest request)	Executes a 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 given context and processes the response using the given response handler.
HttpResponse	execute(HttpUriRequest request, HttpContext context)	Executes a request using the given context.
HttpResponse	execute(HttpHost target, HttpRequest request)	Executes a request to the target using the default context.
<T> T	execute(HttpHost target, HttpRequest request, ResponseHandler<? extends T> responseHandler)	Executes a request to the target 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 to the target using the given context and processes the response using the given response handler.
HttpResponse	execute(HttpHost target, HttpRequest request, HttpContext context)	Executes a request to the target using the given context.
ClientConnectionManager	getConnectionManager()	Obtains the connection manager used by this client.
HttpParams	getParams()	Obtains the parameters for this client.

Method Details

getParams

HttpParams getParams()

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:

the default parameters

getConnectionManager

ClientConnectionManager getConnectionManager()

Obtains the connection manager used by this client.

Returns:

the connection manager

execute

HttpResponse execute(HttpUriRequest request)
              throws IOException,
ClientProtocolException

Executes a 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

ClientProtocolException - in case of an http protocol error

execute

HttpResponse execute(HttpUriRequest request,
HttpContext context)
              throws IOException,
ClientProtocolException

Executes a request using the given context. The route to the target will be determined by the HTTP client.

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:

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

ClientProtocolException - in case of an http protocol error

execute

HttpResponse execute(HttpHost target,
HttpRequest request)
              throws IOException,
ClientProtocolException

Executes a request to the target using the default context.

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:

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

ClientProtocolException - in case of an http protocol error

execute

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

Executes a request to the target using the given context.

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:

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

ClientProtocolException - in case of an http protocol error

execute

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

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

Parameters:

request - the request to execute

responseHandler - 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

ClientProtocolException - in case of an http protocol error

execute

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

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

Parameters:

request - the request to execute

responseHandler - 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

ClientProtocolException - in case of an http protocol error

execute

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

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

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:

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

ClientProtocolException - in case of an http protocol error

execute

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

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

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:

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

ClientProtocolException - in case of an http protocol error