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 org.apache.http.HttpHost; 30 import org.apache.http.nio.reactor.IOSession; 31 32 import java.io.IOException; 33 34 /** 35 * I/O session layering strategy for complex protocol schemes, which employ 36 * a transport level security protocol to secure HTTP communication 37 * (in other words those schemes 'layer' HTTP on top of a transport level 38 * protocol such as TLS/SSL). 39 * 40 * @since 4.0 41 */ 42 public interface SchemeIOSessionStrategy { 43 44 /** 45 * Determines whether or not protocol layering is required. If this method 46 * returns {@code false} the {@link #upgrade(org.apache.http.HttpHost, 47 * org.apache.http.nio.reactor.IOSession) upgrade} method is expected 48 * to have no effect and should not be called. 49 */ 50 boolean isLayeringRequired(); 51 52 /** 53 * Decorates the original {@link IOSession} with a transport level security 54 * protocol implementation. 55 * @param host the target host. 56 * @param ioSession the I/O session. 57 * @return upgraded I/O session. 58 */ 59 IOSession upgrade(HttpHost host, IOSession ioSession) throws IOException; 60 61 }