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.ssl; 29 30 import java.io.IOException; 31 import java.net.Socket; 32 33 import javax.net.ssl.SSLSocket; 34 35 import org.apache.hc.core5.annotation.Contract; 36 import org.apache.hc.core5.annotation.ThreadingBehavior; 37 import org.apache.hc.core5.http.protocol.HttpContext; 38 39 /** 40 * TLS protocol upgrade strategy for blocking {@link Socket}s. 41 * 42 * @since 5.4 43 */ 44 @Contract(threading = ThreadingBehavior.STATELESS) 45 public interface TlsSocketStrategy { 46 47 /** 48 * Upgrades the given plain socket and executes the TLS handshake over it. 49 * 50 * @param socket the existing plain socket 51 * @param target the name of the target host. 52 * @param port the port to connect to on the target host. 53 * @param context the actual HTTP context. 54 * @param attachment connect request attachment. 55 * @return socket upgraded to TLS. 56 */ 57 SSLSocket upgrade( 58 Socket socket, 59 String target, 60 int port, 61 Object attachment, 62 HttpContext context) throws IOException; 63 64 }