001/**
002 *
003 * Copyright 2015-2024 Florian Schmaus.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.jivesoftware.smack.proxy;
018
019import java.io.IOException;
020import java.net.Socket;
021import java.util.function.Function;
022
023public interface ProxySocketConnection {
024
025    /**
026     * Initiate a connection to the given host on the given port. Note that the caller is responsible for closing the
027     * socket in case this method throws.
028     *
029     * @param socket the socket to use to initiate the connection to the proxy.
030     * @param host the host to connect to.
031     * @param port the port to connect to.
032     * @param timeout the timeout in milliseconds.
033     * @throws IOException in case an I/O error occurs.
034     */
035    void connect(Socket socket, String host, int port, int timeout)
036                    throws IOException;
037
038    static Function<ProxyInfo, ProxySocketConnection> forProxyType(ProxyInfo.ProxyType proxyType) {
039        switch (proxyType) {
040            case HTTP:
041                return HTTPProxySocketConnection::new;
042            case SOCKS4:
043                return Socks4ProxySocketConnection::new;
044            case SOCKS5:
045                return Socks5ProxySocketConnection::new;
046            default:
047                throw new AssertionError("Unknown proxy type: " + proxyType);
048        }
049    }
050}