View Javadoc

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