HttpClient Interface Reference

Interface for an HTTP client. More...

Inheritance diagram for HttpClient:

Description

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.

Author

Roland Weber

Version

Revision

676020

Since

4.0

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Public Member Functions
HttpParams	getParams ()
	Obtains the parameters for this client. More...
ClientConnectionManager	getConnectionManager ()
	Obtains the connection manager used by this client. More...
HttpResponse	execute (HttpUriRequest request) throws IOException, ClientProtocolException
	Executes a request using the default context. More...
HttpResponse	execute (HttpUriRequest request, HttpContext context) throws IOException, ClientProtocolException
	Executes a request using the given context. More...
HttpResponse	execute (HttpHost target, HttpRequest request) throws IOException, ClientProtocolException
	Executes a request to the target using the default context. More...
HttpResponse	execute (HttpHost target, HttpRequest request, HttpContext context) throws IOException, ClientProtocolException
	Executes a request to the target using the given context. More...
< 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. More...
< 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. More...
< 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. More...
< 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. More...

Member Function Documentation

getParams()

HttpParams getParams

(

)

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

Implemented in AbstractHttpClient.

getConnectionManager()

ClientConnectionManager getConnectionManager

(

)

Returns

the connection manager

Implemented in AbstractHttpClient.

execute() [1/8]

HttpResponse execute

(

HttpUriRequest

request

)

throws IOException, ClientProtocolException

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.

Exceptions

IOException	in case of a problem or the connection was aborted
ClientProtocolException	in case of an http protocol error

Implemented in AbstractHttpClient.

execute() [2/8]

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

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.

Exceptions

IOException	in case of a problem or the connection was aborted
ClientProtocolException	in case of an http protocol error

Implemented in AbstractHttpClient.

execute() [3/8]

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

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.

Exceptions

IOException	in case of a problem or the connection was aborted
ClientProtocolException	in case of an http protocol error

Implemented in AbstractHttpClient.

execute() [4/8]

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

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.

Exceptions

IOException	in case of a problem or the connection was aborted
ClientProtocolException	in case of an http protocol error

Implemented in AbstractHttpClient.

execute() [5/8]

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

Parameters

request	the request to execute
responseHandler	the response handler

Returns

the response object as generated by the response handler.

Exceptions

IOException	in case of a problem or the connection was aborted
ClientProtocolException	in case of an http protocol error

execute() [6/8]

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

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.

Exceptions

IOException	in case of a problem or the connection was aborted
ClientProtocolException	in case of an http protocol error

execute() [7/8]

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

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.

Exceptions

IOException	in case of a problem or the connection was aborted
ClientProtocolException	in case of an http protocol error

execute() [8/8]

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

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.

Exceptions

IOException	in case of a problem or the connection was aborted
ClientProtocolException	in case of an http protocol error