michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.client;
michael@0: 
michael@0: import java.io.IOException;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.HttpHost;
michael@0: import ch.boye.httpclientandroidlib.HttpRequest;
michael@0: import ch.boye.httpclientandroidlib.HttpResponse;
michael@0: import ch.boye.httpclientandroidlib.HttpException;
michael@0: import ch.boye.httpclientandroidlib.protocol.HttpContext;
michael@0: 
michael@0: /**
michael@0:  * A client-side request director.
michael@0:  * The director decides which steps are necessary to execute a request.
michael@0:  * It establishes connections and optionally processes redirects and
michael@0:  * authentication challenges. The director may therefore generate and
michael@0:  * send a sequence of requests in order to execute one initial request.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface RequestDirector {
michael@0: 
michael@0: 
michael@0:     /**
michael@0:      * Executes a request.
michael@0:      * <br/><b>Note:</b>
michael@0:      * For the time being, a new director is instantiated for each request.
michael@0:      * This is the same behavior as for <code>HttpMethodDirector</code>
michael@0:      * in HttpClient 3.
michael@0:      *
michael@0:      * @param target    the target host for the request.
michael@0:      *                  Implementations may accept <code>null</code>
michael@0:      *                  if they can still determine a route, for example
michael@0:      *                  to a default target or by inspecting the request.
michael@0:      * @param request   the request to execute
michael@0:      * @param context   the context for executing the request
michael@0:      *
michael@0:      * @return  the final response to the request.
michael@0:      *          This is never an intermediate response with status code 1xx.
michael@0:      *
michael@0:      * @throws HttpException            in case of a problem
michael@0:      * @throws IOException              in case of an IO problem
michael@0:      *                                     or if the connection was aborted
michael@0:      */
michael@0:     HttpResponse execute(HttpHost target, HttpRequest request, HttpContext context)
michael@0:         throws HttpException, IOException;
michael@0: 
michael@0: }