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.core5.http.nio.ssl; 29 30 import java.net.SocketAddress; 31 32 import org.apache.hc.core5.http.HttpHost; 33 import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer; 34 import org.apache.hc.core5.util.Timeout; 35 36 /** 37 * TLS protocol upgrade strategy for non-blocking {@link TransportSecurityLayer} sessions. 38 * 39 * @since 5.0 40 */ 41 public interface TlsStrategy { 42 43 /** 44 * Secures current session layer with TLS security. 45 * 46 * @param sessionLayer the session layer 47 * @param host the name of the opposite endpoint when given or {@code null} otherwise. 48 * @param localAddress the address of the local endpoint. 49 * @param remoteAddress the address of the remote endpoint. 50 * @param attachment arbitrary object passes to the TLS session initialization code. 51 * @param handshakeTimeout the timeout to use while performing the TLS handshake; may be {@code null}. 52 * @return {@code true} if the session has been upgraded, {@code false} otherwise. 53 */ 54 boolean upgrade( 55 TransportSecurityLayer sessionLayer, 56 HttpHost host, 57 SocketAddress localAddress, 58 SocketAddress remoteAddress, 59 Object attachment, 60 Timeout handshakeTimeout); 61 62 }