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.hc.client5.http.io; 29 30 import java.io.IOException; 31 import java.net.Socket; 32 33 import javax.net.ssl.SSLSession; 34 35 import org.apache.hc.core5.annotation.Internal; 36 import org.apache.hc.core5.http.io.HttpClientConnection; 37 38 /** 39 * Represents a managed connection whose state and life cycle is managed by 40 * a connection manager. This interface extends {@link HttpClientConnection} 41 * with methods to bind the connection to an arbitrary socket and 42 * to obtain SSL session details. 43 * 44 * @since 4.3 45 */ 46 @Internal 47 public interface ManagedHttpClientConnection extends HttpClientConnection { 48 49 /** 50 * Binds this connection to the given socket. The connection 51 * is considered open if it is bound and the underlying socket 52 * is connection to a remote host. 53 * 54 * @param socket the socket to bind the connection to. 55 */ 56 void bind(Socket socket) throws IOException; 57 58 /** 59 * Returns the underlying socket. 60 */ 61 Socket getSocket(); 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 * 69 * @return the underlying SSL session if available, 70 * {@code null} otherwise 71 */ 72 @Override 73 SSLSession getSSLSession(); 74 75 /** 76 * Puts the connection into idle mode. 77 * 78 * @since 5.0 79 */ 80 void passivate(); 81 82 /** 83 * Restores the connection from idle mode. 84 * 85 * @since 5.0 86 */ 87 void activate(); 88 89 }