AbstractHttpClient Class Reference

Convenience base class for HTTP client implementations. More...

Inheritance diagram for AbstractHttpClient:

Description

Author

Roland Weber

Oleg Kalnichevski

Version

Revision

677250

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

Protected Member Functions
	AbstractHttpClient (final ClientConnectionManager conman, final HttpParams params)
	Creates a new HTTP client. More...
HttpParams	determineParams (HttpRequest req)
	Obtains parameters for executing a request. More...

Constructor & Destructor Documentation

AbstractHttpClient()

AbstractHttpClient ( final ClientConnectionManager  conman, final HttpParams  params  )

protected

Parameters

conman	the connection manager
params	the parameters

Member Function Documentation

getParams()

synchronized final 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

Implements HttpClient.

setParams()

synchronized void setParams

(

HttpParams

params

)

The implementation here does not update parameters of dependent objects.

Parameters

params

the new default parameters

getConnectionManager()

synchronized final ClientConnectionManager getConnectionManager

(

)

Returns

the connection manager

Implements HttpClient.

execute() [1/4]

final 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

Implements HttpClient.

execute() [2/4]

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

The target is determined from the URI of the request.

Parameters

request	the request to execute
context	the request-specific execution context, or null to use a default context

Implements HttpClient.

execute() [3/4]

final 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

Implements HttpClient.

execute() [4/4]

final 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

Implements HttpClient.

determineParams()

HttpParams determineParams ( HttpRequest  req )

protected

The default implementation in this class creates a new com.good.gd.apache.http.impl.client.ClientParamsStack from the request parameters and the client parameters.
This method is called by the default implementation of (HttpHost,HttpRequest,HttpContext) to obtain the parameters for the com.good.gd.apache.http.impl.client.DefaultRequestDirector.

Parameters

req	the request that will be executed

Returns

the parameters to use