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.hc.client5.http.socket;
29
30 import java.io.IOException;
31 import java.net.Socket;
32
33 import org.apache.hc.core5.annotation.Contract;
34 import org.apache.hc.core5.annotation.ThreadingBehavior;
35 import org.apache.hc.core5.http.protocol.HttpContext;
36
37 /**
38 * Extended {@link ConnectionSocketFactory} interface for layered sockets such as SSL/TLS.
39 *
40 * @since 4.3
41 */
42 @Contract(threading = ThreadingBehavior.STATELESS)
43 public interface LayeredConnectionSocketFactory extends ConnectionSocketFactory {
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 target the name of the target host.
52 * @param port the port to connect to on the target host.
53 * @param context the actual HTTP context.
54 *
55 * @return Socket a new socket
56 *
57 * @throws IOException if an I/O error occurs while creating the socket
58 */
59 Socket createLayeredSocket(
60 Socket socket,
61 String target,
62 int port,
63 HttpContext context) throws IOException;
64
65 /**
66 * Returns a socket connected to the given host that is layered over an
67 * existing socket. Used primarily for creating secure sockets through
68 * proxies.
69 *
70 * @param socket the existing socket
71 * @param target the name of the target host.
72 * @param port the port to connect to on the target host.
73 * @param context the actual HTTP context.
74 * @param attachment connect request attachment.
75 *
76 * @return Socket a new socket
77 *
78 * @throws IOException if an I/O error occurs while creating the socket
79 *
80 * @since 5.2
81 */
82 default Socket createLayeredSocket(
83 Socket socket,
84 String target,
85 int port,
86 Object attachment,
87 HttpContext context) throws IOException {
88 return createLayeredSocket(socket, target, port, context);
89 }
90
91 }