1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/RequestDirector.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 676020 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-07-11 09:38:49 -0700 (Fri, 11 Jul 2008) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or more contributor license agreements. See the NOTICE file 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed with this work for additional information 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * regarding copyright ownership. The ASF licenses this file 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to you under the Apache License, Version 2.0 (the 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "License"); you may not use this file except in compliance 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * with the License. You may obtain a copy of the License at 14069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 15069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 16069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 17069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Unless required by applicable law or agreed to in writing, 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * software distributed under the License is distributed on an 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * KIND, either express or implied. See the License for the 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * specific language governing permissions and limitations 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * under the License. 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.client; 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.io.IOException; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.HttpHost; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.HttpRequest; 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.HttpResponse; 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.HttpException; 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.protocol.HttpContext; 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * A client-side request director. 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The director decides which steps are necessary to execute a request. 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * It establishes connections and optionally processes redirects and 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * authentication challenges. The director may therefore generate and 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * send a sequence of requests in order to execute one initial request. 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <br/><b>Note:</b> 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * It is most likely that implementations of this interface will 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * allocate connections, and return responses that depend on those 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * connections for reading the response entity. Such connections 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * MUST be released, but that is out of the scope of a request director. 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:rolandw at apache.org">Roland Weber</a> 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <!-- empty lines to avoid svn diff problems --> 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Revision: 676020 $ 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic interface RequestDirector { 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Executes a request. 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <br/><b>Note:</b> 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * For the time being, a new director is instantiated for each request. 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This is the same behavior as for <code>HttpMethodDirector</code> 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * in HttpClient 3. 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param target the target host for the request. 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Implementations may accept <code>null</code> 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * if they can still determine a route, for example 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to a default target or by inspecting the request. 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param request the request to execute 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param context the context for executing the request 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the final response to the request. 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This is never an intermediate response with status code 1xx. 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws HttpException in case of a problem 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws IOException in case of an IO problem 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or if the connection was aborted 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project HttpResponse execute(HttpHost target, HttpRequest request, 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project HttpContext context) 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws HttpException, IOException 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ; 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} // class ClientRequestDirector 93