Source code: org/apache/http/HttpProxyConnection.java
1 /*
2 * $HeadURL: https://svn.apache.org/repos/asf/jakarta/httpcomponents/httpcore/tags/4.0-alpha2/src/java/org/apache/http/HttpProxyConnection.java $
3 * $Revision: 391135 $
4 * $Date: 2006-04-03 22:15:40 +0200 (Mon, 03 Apr 2006) $
5 *
6 * ====================================================================
7 *
8 * Copyright 1999-2006 The Apache Software Foundation
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License");
11 * you may not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS,
18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
21 * ====================================================================
22 *
23 * This software consists of voluntary contributions made by many
24 * individuals on behalf of the Apache Software Foundation. For more
25 * information on the Apache Software Foundation, please see
26 * <http://www.apache.org/>.
27 *
28 */
29
30 package org.apache.http;
31
32 import java.io.IOException;
33
34 import org.apache.http.params.HttpParams;
35
36 /**
37 * An HTTP connection through a proxy. The semantics of
38 * @link org.apache.http.HttpClientConnection#setTargetHost(HttpHost) and
39 * @link org.apache.http.HttpClientConnection#getTargetHost() methods of a proxy
40 * connections change their meaning to designate the proxy host.
41
42 * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
43 * @version $Revision: 391135 $
44 * @since 4.0
45 */
46 public interface HttpProxyConnection extends HttpClientConnection {
47
48 /**
49 * After this connection is opened to the proxy, this method may be called
50 * to create a new connection over it. Subsequent data is sent over the
51 * resulting connection.
52 *
53 * @param targetHost The final target host
54 * @param params The parameters effective for this connection
55 * @throws IOException
56 */
57 void tunnelTo(HttpHost targetHost, HttpParams params) throws IOException;
58
59 /**
60 * Returns the target host as provided by
61 *
62 * @link #tunnelTo(HttpHost, HttpParams).
63 */
64 HttpHost getTunnelTarget();
65
66 /**
67 * Checks if
68 *
69 * @link #tunnelTo(HttpHost, HttpParams) has been called on this connection.
70 * @return true if tunnelTo has been called, false if not
71 */
72 boolean isTunnelActive();
73
74 /**
75 * Checks if the tunnel uses a secure socket.
76 *
77 * @return true if this is a secure tunnel.
78 */
79 boolean isSecure();
80
81 }