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  package org.apache.http.nio.conn;
28  
29  import javax.net.ssl.SSLSession;
30  
31  import org.apache.http.HttpInetConnection;
32  import org.apache.http.nio.NHttpClientConnection;
33  import org.apache.http.nio.reactor.IOSession;
34  
35  /**
36   * Represents a managed connection whose state and life cycle is managed by
37   * a connection manager. This interface extends {@link NHttpClientConnection}
38   * with methods to bind the connection to an arbitrary {@link IOSession} and
39   * to obtain SSL session details.
40   *
41   * @since 4.0
42   */
43  public interface ManagedNHttpClientConnection extends NHttpClientConnection, HttpInetConnection {
44  
45      /**
46       * Returns connection ID which is expected to be unique
47       * for the life span of the connection manager.
48       */
49      String getId();
50  
51      /**
52       * Binds connection to the given I/O session.
53       */
54      void bind(IOSession iosession);
55  
56      /**
57       * Returns the underlying I/O session.
58       */
59      IOSession getIOSession();
60  
61      /**
62       * Obtains the SSL session of the underlying connection, if any.
63       *
64       * @return  the underlying SSL session if available,
65       *          {@code null} otherwise
66       */
67      SSLSession getSSLSession();
68  
69  }