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.conn;
29
30 import javax.net.ssl.SSLSession;
31
32 import org.apache.http.HttpInetConnection;
33 import org.apache.http.conn.routing.HttpRoute;
34
35 /**
36 * Interface to access routing information of a client side connection.
37 *
38 * @since 4.1
39 */
40 public interface HttpRoutedConnection extends HttpInetConnection {
41
42 /**
43 * Indicates whether this connection is secure.
44 * The return value is well-defined only while the connection is open.
45 * It may change even while the connection is open.
46 *
47 * @return <code>true</code> if this connection is secure,
48 * <code>false</code> otherwise
49 */
50 boolean isSecure();
51
52 /**
53 * Obtains the current route of this connection.
54 *
55 * @return the route established so far, or
56 * <code>null</code> if not connected
57 */
58 HttpRoute getRoute();
59
60 /**
61 * Obtains the SSL session of the underlying connection, if any.
62 * If this connection is open, and the underlying socket is an
63 * {@link javax.net.ssl.SSLSocket SSLSocket}, the SSL session of
64 * that socket is obtained. This is a potentially blocking operation.
65 * <br/>
66 * <b>Note:</b> Whether the underlying socket is an SSL socket
67 * can not necessarily be determined via {@link #isSecure}.
68 * Plain sockets may be considered secure, for example if they are
69 * connected to a known host in the same network segment.
70 * On the other hand, SSL sockets may be considered insecure,
71 * for example depending on the chosen cipher suite.
72 *
73 * @return the underlying SSL session if available,
74 * <code>null</code> otherwise
75 */
76 SSLSession getSSLSession();
77
78 }