1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.http.client;
29
30 import java.io.IOException;
31
32 import org.apache.http.HttpException;
33 import org.apache.http.HttpHost;
34 import org.apache.http.HttpRequest;
35 import org.apache.http.HttpResponse;
36 import org.apache.http.protocol.HttpContext;
37
38 /**
39 * A client-side request director.
40 * The director decides which steps are necessary to execute a request.
41 * It establishes connections and optionally processes redirects and
42 * authentication challenges. The director may therefore generate and
43 * send a sequence of requests in order to execute one initial request.
44 *
45 * @since 4.0
46 *
47 * @deprecated (4.3) No longer used
48 */
49 @Deprecated
50 public interface RequestDirector {
51
52
53 /**
54 * Executes a request.
55 * <p>
56 * <b>Note:</b> For the time being, a new director is instantiated for each request.
57 * This is the same behavior as for {@code HttpMethodDirector}
58 * in HttpClient 3.
59 * </p>
60 *
61 * @param target the target host for the request.
62 * Implementations may accept {@code null}
63 * if they can still determine a route, for example
64 * to a default target or by inspecting the request.
65 * @param request the request to execute
66 * @param context the context for executing the request
67 *
68 * @return the final response to the request.
69 * This is never an intermediate response with status code 1xx.
70 *
71 * @throws HttpException in case of a problem
72 * @throws IOException in case of an IO problem
73 * or if the connection was aborted
74 */
75 HttpResponse execute(HttpHost target, HttpRequest request, HttpContext context)
76 throws HttpException, IOException;
77
78 }