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 * @deprecated Use {@link org.apache.hc.client5.http.ssl.TlsSocketStrategy}.
41 */
42 @Deprecated
43 @Contract(threading = ThreadingBehavior.STATELESS)
44 public interface LayeredConnectionSocketFactory extends ConnectionSocketFactory {
45
46 /**
47 * Returns a socket connected to the given host that is layered over an
48 * existing socket. Used primarily for creating secure sockets through
49 * proxies.
50 *
51 * @param socket the existing socket
52 * @param target the name of the target host.
53 * @param port the port to connect to on the target host.
54 * @param context the actual HTTP context.
55 *
56 * @return Socket a new socket
57 *
58 * @throws IOException if an I/O error occurs while creating the socket
59 */
60 Socket createLayeredSocket(
61 Socket socket,
62 String target,
63 int port,
64 HttpContext context) throws IOException;
65
66 /**
67 * Returns a socket connected to the given host that is layered over an
68 * existing socket. Used primarily for creating secure sockets through
69 * proxies.
70 *
71 * @param socket the existing socket
72 * @param target the name of the target host.
73 * @param port the port to connect to on the target host.
74 * @param context the actual HTTP context.
75 * @param attachment connect request attachment.
76 *
77 * @return Socket a new socket
78 *
79 * @throws IOException if an I/O error occurs while creating the socket
80 *
81 * @since 5.2
82 */
83 default Socket createLayeredSocket(
84 Socket socket,
85 String target,
86 int port,
87 Object attachment,
88 HttpContext context) throws IOException {
89 return createLayeredSocket(socket, target, port, context);
90 }
91
92 }