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.InetSocketAddress; 32 33 import org.apache.hc.core5.annotation.Contract; 34 import org.apache.hc.core5.annotation.Internal; 35 import org.apache.hc.core5.annotation.ThreadingBehavior; 36 import org.apache.hc.core5.http.HttpHost; 37 import org.apache.hc.core5.http.io.SocketConfig; 38 import org.apache.hc.core5.http.protocol.HttpContext; 39 import org.apache.hc.core5.util.TimeValue; 40 41 /** 42 * Connection operator that performs connection connect and upgrade operations. 43 * 44 * @since 4.4 45 */ 46 @Contract(threading = ThreadingBehavior.STATELESS) 47 @Internal 48 public interface HttpClientConnectionOperator { 49 50 /** 51 * Connect the given managed connection to the remote endpoint. 52 * 53 * @param conn the managed connection. 54 * @param host the address of the opposite endpoint. 55 * @param localAddress the address of the local endpoint. 56 * @param connectTimeout the timeout of the connect operation. 57 * @param socketConfig the socket configuration. 58 * @param context the execution context. 59 */ 60 void connect( 61 ManagedHttpClientConnection conn, 62 HttpHost host, 63 InetSocketAddress localAddress, 64 TimeValue connectTimeout, 65 SocketConfig socketConfig, 66 HttpContext context) throws IOException; 67 68 /** 69 * Upgrades transport security of the given managed connection 70 * by using the TLS security protocol. 71 * 72 * @param conn the managed connection. 73 * @param host the address of the opposite endpoint with TLS security. 74 * @param context the execution context. 75 */ 76 void upgrade( 77 ManagedHttpClientConnection conn, 78 HttpHost host, 79 HttpContext context) throws IOException; 80 81 }