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.conn;
michael@0: 
michael@0: import javax.net.ssl.SSLSession;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.HttpInetConnection;
michael@0: import ch.boye.httpclientandroidlib.conn.routing.HttpRoute;
michael@0: 
michael@0: /**
michael@0:  * Interface to access routing information of a client side connection.
michael@0:  *
michael@0:  * @since 4.1
michael@0:  */
michael@0: public interface HttpRoutedConnection extends HttpInetConnection {
michael@0: 
michael@0:     /**
michael@0:      * Indicates whether this connection is secure.
michael@0:      * The return value is well-defined only while the connection is open.
michael@0:      * It may change even while the connection is open.
michael@0:      *
michael@0:      * @return  <code>true</code> if this connection is secure,
michael@0:      *          <code>false</code> otherwise
michael@0:      */
michael@0:     boolean isSecure();
michael@0: 
michael@0:     /**
michael@0:      * Obtains the current route of this connection.
michael@0:      *
michael@0:      * @return  the route established so far, or
michael@0:      *          <code>null</code> if not connected
michael@0:      */
michael@0:     HttpRoute getRoute();
michael@0: 
michael@0:     /**
michael@0:      * Obtains the SSL session of the underlying connection, if any.
michael@0:      * If this connection is open, and the underlying socket is an
michael@0:      * {@link javax.net.ssl.SSLSocket SSLSocket}, the SSL session of
michael@0:      * that socket is obtained. This is a potentially blocking operation.
michael@0:      * <br/>
michael@0:      * <b>Note:</b> Whether the underlying socket is an SSL socket
michael@0:      * can not necessarily be determined via {@link #isSecure}.
michael@0:      * Plain sockets may be considered secure, for example if they are
michael@0:      * connected to a known host in the same network segment.
michael@0:      * On the other hand, SSL sockets may be considered insecure,
michael@0:      * for example depending on the chosen cipher suite.
michael@0:      *
michael@0:      * @return  the underlying SSL session if available,
michael@0:      *          <code>null</code> otherwise
michael@0:      */
michael@0:     SSLSession getSSLSession();
michael@0: 
michael@0: }