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   * Extended {@link SchemeSocketFactory} interface for layered sockets such as SSL/TLS.
36   *
37   * @since 4.1
38   *
39   * @deprecated (4.2)  use {@link SchemeLayeredSocketFactory}
40   */
41  @Deprecated
42  public interface LayeredSchemeSocketFactory extends SchemeSocketFactory {
43  
44      /**
45       * Returns a socket connected to the given host that is layered over an
46       * existing socket.  Used primarily for creating secure sockets through
47       * proxies.
48       *
49       * @param socket the existing socket
50       * @param target    the name of the target host.
51       * @param port      the port to connect to on the target host
52       * @param autoClose a flag for closing the underling socket when the created
53       * socket is closed
54       *
55       * @return Socket a new socket
56       *
57       * @throws IOException if an I/O error occurs while creating the socket
58       * @throws UnknownHostException if the IP address of the host cannot be
59       * determined
60       */
61      Socket createLayeredSocket(
62          Socket socket,
63          String target,
64          int port,
65          boolean autoClose
66      ) throws IOException, UnknownHostException;
67  
68  }