View Javadoc

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.http.conn.scheme;
29  
30  import java.io.IOException;
31  import java.net.Socket;
32  import java.net.UnknownHostException;
33  
34  /**
35   * A {@link SocketFactory SocketFactory} for layered sockets (SSL/TLS).
36   * See there for things to consider when implementing a socket factory.
37   *
38   * @since 4.0
39   *
40   * @deprecated (4.1)  use {@link SchemeSocketFactory}
41   */
42  @Deprecated
43  public interface LayeredSocketFactory extends SocketFactory {
44  
45      /**
46       * Returns a socket connected to the given host that is layered over an
47       * existing socket.  Used primarily for creating secure sockets through
48       * proxies.
49       *
50       * @param socket the existing socket
51       * @param host the host name/IP
52       * @param port the port on the host
53       * @param autoClose a flag for closing the underling socket when the created
54       * socket is closed
55       *
56       * @return Socket a new socket
57       *
58       * @throws IOException if an I/O error occurs while creating the socket
59       * @throws UnknownHostException if the IP address of the host cannot be
60       * determined
61       */
62      Socket createSocket(
63          Socket socket,
64          String host,
65          int port,
66          boolean autoClose
67      ) throws IOException, UnknownHostException;
68  
69  }