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.socket;
29  
30  import java.io.IOException;
31  import java.net.Socket;
32  import java.net.UnknownHostException;
33  
34  import org.apache.http.protocol.HttpContext;
35  
36  /**
37   * Extended {@link ConnectionSocketFactory} interface for layered sockets such as SSL/TLS.
38   *
39   * @since 4.3
40   */
41  public interface LayeredConnectionSocketFactory extends ConnectionSocketFactory {
42  
43      /**
44       * Returns a socket connected to the given host that is layered over an
45       * existing socket.  Used primarily for creating secure sockets through
46       * proxies.
47       *
48       * @param socket the existing socket
49       * @param target the name of the target host.
50       * @param port the port to connect to on the target host.
51       * @param context the actual HTTP context.
52       *
53       * @return Socket a new socket
54       *
55       * @throws IOException if an I/O error occurs while creating the socket
56       */
57      Socket createLayeredSocket(
58          Socket socket,
59          String target,
60          int port,
61          HttpContext context) throws IOException, UnknownHostException;
62  
63  }