001/**
002 *
003 * Copyright 2015-2019 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;
021
022import org.jivesoftware.smack.util.Function;
023
024public interface ProxySocketConnection {
025
026    /**
027     * Initiate a connection to the given host on the given port. Note that the caller is responsible for closing the
028     * socket in case this method throws.
029     *
030     * @param socket the socket to use to initiate the connection to the proxy.
031     * @param host the host to connect to.
032     * @param port the port to connect to.
033     * @param timeout the timeout in milliseconds.
034     * @throws IOException in case an I/O error occurs.
035     */
036    void connect(Socket socket, String host, int port, int timeout)
037                    throws IOException;
038
039    static Function<ProxySocketConnection, ProxyInfo> forProxyType(ProxyInfo.ProxyType proxyType) {
040        switch (proxyType) {
041            case HTTP:
042                return HTTPProxySocketConnection::new;
043            case SOCKS4:
044                return Socks4ProxySocketConnection::new;
045            case SOCKS5:
046                return Socks5ProxySocketConnection::new;
047            default:
048                throw new AssertionError("Unknown proxy type: " + proxyType);
049        }
050    }
051}