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 * Extended {@link SchemeSocketFactory} interface for layered sockets such as SSL/TLS.
036 *
037 * @since 4.1
038 *
039 * @deprecated (4.2)  use {@link SchemeLayeredSocketFactory}
040 */
041@Deprecated
042public interface LayeredSchemeSocketFactory extends SchemeSocketFactory {
043
044    /**
045     * Returns a socket connected to the given host that is layered over an
046     * existing socket.  Used primarily for creating secure sockets through
047     * proxies.
048     *
049     * @param socket the existing socket
050     * @param target    the name of the target host.
051     * @param port      the port to connect to on the target host
052     * @param autoClose a flag for closing the underling socket when the created
053     * socket is closed
054     *
055     * @return Socket a new socket
056     *
057     * @throws IOException if an I/O error occurs while creating the socket
058     * @throws UnknownHostException if the IP address of the host cannot be
059     * determined
060     */
061    Socket createLayeredSocket(
062        Socket socket,
063        String target,
064        int port,
065        boolean autoClose
066    ) throws IOException, UnknownHostException;
067
068}