Package io.vertx.core.net

Class ProxyOptions

  • public class ProxyOptions
extends Object
    Proxy options for a net client or a net client.
    Author:
    Alexander Lehmann

    • Field Detail

      • DEFAULT_TYPE

        public static final ProxyType DEFAULT_TYPE
        The default proxy type (HTTP)

      • DEFAULT_PORT

        public static final int DEFAULT_PORT
        The default port for proxy connect = 3128

        3128 is the default port for Squid

        See Also:
        Constant Field Values

      • DEFAULT_HOST

        public static final String DEFAULT_HOST
        The default hostname for proxy connect = "localhost"
        See Also:
        Constant Field Values

      • DEFAULT_CONNECT_TIMEOUT

        public static final Duration DEFAULT_CONNECT_TIMEOUT
        The default timeout for proxy connect = 10 seconds

    • Constructor Detail

      • ProxyOptions

        public ProxyOptions()
        Default constructor.

      • ProxyOptions

        public ProxyOptions​(ProxyOptions other)
        Copy constructor.
        Parameters:
        other - the options to copy

      • ProxyOptions

        public ProxyOptions​(JsonObject json)
        Create options from JSON.
        Parameters:
        json - the JSON

    • Method Detail

      • toJson

        public JsonObject toJson()
        Convert to JSON
        Returns:
        the JSON

      • getHost

        public String getHost()
        Get proxy host.
        Returns:
        proxy hosts

      • setHost

        public ProxyOptions setHost​(String host)
        Set proxy host.
        Parameters:
        host - the proxy host to connect to
        Returns:
        a reference to this, so the API can be used fluently

      • getPort

        public int getPort()
        Get proxy port.
        Returns:
        proxy port

      • setPort

        public ProxyOptions setPort​(int port)
        Set proxy port.
        Parameters:
        port - the proxy port to connect to
        Returns:
        a reference to this, so the API can be used fluently

      • getUsername

        public String getUsername()
        Get proxy username.
        Returns:
        proxy username

      • setUsername

        public ProxyOptions setUsername​(String username)
        Set proxy username.
        Parameters:
        username - the proxy username
        Returns:
        a reference to this, so the API can be used fluently

      • getPassword

        public String getPassword()
        Get proxy password.
        Returns:
        proxy password

      • setPassword

        public ProxyOptions setPassword​(String password)
        Set proxy password.
        Parameters:
        password - the proxy password
        Returns:
        a reference to this, so the API can be used fluently

      • getType

        public ProxyType getType()
        Get proxy type.

        ProxyType can be HTTP, SOCKS4 and SOCKS5

        Returns:
        proxy type

      • setType

        public ProxyOptions setType​(ProxyType type)
        Set proxy type.

        ProxyType can be HTTP, SOCKS4 and SOCKS5

        Parameters:
        type - the proxy type to connect to
        Returns:
        a reference to this, so the API can be used fluently

      • getConnectTimeout

        public Duration getConnectTimeout()
        Get the connection timeout , defaults to 10 seconds.

        A connection to the proxy is considered successful when:

        • the client received a 200 response to the CONNECT request for HTTP proxies, or
        • the SOCKS handshake ended with the SUCCESS status, for SOCKS proxies.
        Returns:
        the connection timeout

      • setConnectTimeout

        public ProxyOptions setConnectTimeout​(Duration connectTimeout)
        Set the connection timeout.
        Parameters:
        connectTimeout - the connection timeout
        Returns:
        a reference to this, so the API can be used fluently