1/*
2 * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/conn/scheme/LayeredSocketFactory.java $
3 * $Revision: 645850 $
4 * $Date: 2008-04-08 04:08:52 -0700 (Tue, 08 Apr 2008) $
5 *
6 * ====================================================================
7 * Licensed to the Apache Software Foundation (ASF) under one
8 * or more contributor license agreements.  See the NOTICE file
9 * distributed with this work for additional information
10 * regarding copyright ownership.  The ASF licenses this file
11 * to you under the Apache License, Version 2.0 (the
12 * "License"); you may not use this file except in compliance
13 * with the License.  You may obtain a copy of the License at
14 *
15 *   http://www.apache.org/licenses/LICENSE-2.0
16 *
17 * Unless required by applicable law or agreed to in writing,
18 * software distributed under the License is distributed on an
19 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20 * KIND, either express or implied.  See the License for the
21 * specific language governing permissions and limitations
22 * under the License.
23 * ====================================================================
24 *
25 * This software consists of voluntary contributions made by many
26 * individuals on behalf of the Apache Software Foundation.  For more
27 * information on the Apache Software Foundation, please see
28 * <http://www.apache.org/>.
29 *
30 */
31
32package org.apache.http.conn.scheme;
33
34import java.io.IOException;
35import java.net.Socket;
36import java.net.UnknownHostException;
37
38/**
39 * A {@link SocketFactory SocketFactory} for layered sockets (SSL/TLS).
40 * See there for things to consider when implementing a socket factory.
41 *
42 * @author Michael Becke
43 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
44 * @since 4.0
45 */
46public interface LayeredSocketFactory extends SocketFactory {
47
48    /**
49     * Returns a socket connected to the given host that is layered over an
50     * existing socket.  Used primarily for creating secure sockets through
51     * proxies.
52     *
53     * @param socket the existing socket
54     * @param host the host name/IP
55     * @param port the port on the host
56     * @param autoClose a flag for closing the underling socket when the created
57     * socket is closed
58     *
59     * @return Socket a new socket
60     *
61     * @throws IOException if an I/O error occurs while creating the socket
62     * @throws UnknownHostException if the IP address of the host cannot be
63     * determined
64     */
65    Socket createSocket(
66        Socket socket,
67        String host,
68        int port,
69        boolean autoClose
70    ) throws IOException, UnknownHostException;
71
72}
73