001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.conn.scheme;
029
030import java.io.IOException;
031import java.net.Socket;
032import java.net.UnknownHostException;
033
034/**
035 * A {@link SocketFactory SocketFactory} for layered sockets (SSL/TLS).
036 * See there for things to consider when implementing a socket factory.
037 *
038 * @since 4.0
039 *
040 * @deprecated (4.1)  use {@link SchemeSocketFactory}
041 */
042@Deprecated
043public interface LayeredSocketFactory extends SocketFactory {
044
045    /**
046     * Returns a socket connected to the given host that is layered over an
047     * existing socket.  Used primarily for creating secure sockets through
048     * proxies.
049     *
050     * @param socket the existing socket
051     * @param host the host name/IP
052     * @param port the port on the host
053     * @param autoClose a flag for closing the underling socket when the created
054     * socket is closed
055     *
056     * @return Socket a new socket
057     *
058     * @throws IOException if an I/O error occurs while creating the socket
059     * @throws UnknownHostException if the IP address of the host cannot be
060     * determined
061     */
062    Socket createSocket(
063        Socket socket,
064        String host,
065        int port,
066        boolean autoClose
067    ) throws IOException, UnknownHostException;
068
069}