RequestDirector Interface Reference

A client-side request director. More...

Inheritance diagram for RequestDirector:

Description

The director decides which steps are necessary to execute a request. It establishes connections and optionally processes redirects and authentication challenges. The director may therefore generate and send a sequence of requests in order to execute one initial request.

Note: It is most likely that implementations of this interface will allocate connections, and return responses that depend on those connections for reading the response entity. Such connections MUST be released, but that is out of the scope of a request director.

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
HttpResponse	execute (HttpHost target, HttpRequest request, HttpContext context) throws HttpException, IOException
	Executes a request. More...

Member Function Documentation

execute()

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

Note: For the time being, a new director is instantiated for each request. This is the same behavior as for HttpMethodDirector in HttpClient 3.

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 for executing the request

Returns

the final response to the request. This is never an intermediate response with status code 1xx.

Exceptions

HttpException	in case of a problem
IOException	in case of an IO problem or if the connection was aborted

Implemented in DefaultRequestDirector.