Nested Class Summary

Constructor Summary

Method Summary

Constructor Details

• Proxy

  public Proxy()

• Proxy

  public Proxy(Map<String,?> raw)

Method Details

• toJson

  public Map<String,Object> toJson()

• getProxyType

  public Proxy.ProxyType getProxyType()

  Gets theProxy.ProxyType. This can signal if set to use a direct connection (without proxy), manually set proxy settings, auto-configured proxy settings, or whether to use the default system proxy settings. It defaults toProxy.ProxyType.UNSPECIFIED.

  Returns:

  the proxy type employed

• setProxyType

  public Proxy setProxyType(Proxy.ProxyType proxyType)

  Explicitly sets the proxy type, useful for forcing direct connection on Linux.

  Parameters:

  proxyType - type of proxy being used

  Returns:

  reference to self

• isAutodetect

  public boolean isAutodetect()

  Whether to autodetect proxy settings.

  Returns:

  true if set to autodetect proxy settings, false otherwise

• setAutodetect

  public Proxy setAutodetect(boolean autodetect)

  Specifies whether to autodetect proxy settings.

  Parameters:

  autodetect - set to true to use proxy auto detection, false to leave proxy settings unspecified

  Returns:

  reference to self

• getFtpProxy

  @Deprecatedpublic @NullableString getFtpProxy()

  Deprecated.

  getFtpProxy is deprecated and will be removed in a future release.

  Gets the FTP proxy.

  Returns:

  the FTP proxy hostname if present, or null if not set

• setFtpProxy

  @Deprecatedpublic Proxy setFtpProxy(String ftpProxy)

  Deprecated.

  setFtpProxy is deprecated and will be removed in a future release.

  Specify which proxy to use for FTP connections.

  Parameters:

  ftpProxy - the proxy host, expected format ishostname.com:1234

  Returns:

  reference to self

• getHttpProxy

  public @NullableString getHttpProxy()

  Gets the HTTP proxy.

  Returns:

  the HTTP proxy hostname if present, or null if not set

• setHttpProxy

  public Proxy setHttpProxy(String httpProxy)

  Specify which proxy to use for HTTP connections.

  Parameters:

  httpProxy - the proxy host, expected format ishostname:1234

  Returns:

  reference to self

• getNoProxy

  public @NullableString getNoProxy()

  Gets proxy bypass (noproxy) addresses.

  Returns:

  The proxy bypass (noproxy) addresses

• setNoProxy

  public Proxy setNoProxy(String noProxy)

  Sets proxy bypass (noproxy) addresses

  Parameters:

  noProxy - The proxy bypass (noproxy) addresses separated by commas

  Returns:

  reference to self

• getSslProxy

  public @NullableString getSslProxy()

  Gets the SSL tunnel proxy.

  Returns:

  the SSL tunnel proxy hostname if present, null otherwise

• setSslProxy

  public Proxy setSslProxy(String sslProxy)

  Specify which proxy to use for SSL connections.

  Parameters:

  sslProxy - the proxy host, expected format ishostname.com:1234

  Returns:

  reference to self

• getSocksProxy

  public @NullableString getSocksProxy()

  Gets the SOCKS proxy.

  Returns:

  the SOCKS proxy if present, null otherwise

• setSocksProxy

  public Proxy setSocksProxy(String socksProxy)

  Specifies which proxy to use for SOCKS.

  Parameters:

  socksProxy - the proxy host, expected format ishostname.com:1234

  Returns:

  reference to self

• getSocksVersion

  public @NullableInteger getSocksVersion()

  Gets the SOCKS version (4 or 5).

  Returns:

  the SOCKS version if present, null otherwise

• setSocksVersion

  public Proxy setSocksVersion(Integer socksVersion)

  Specifies which version of SOCKS to use (4 or 5).

  Parameters:

  socksVersion - SOCKS version, 4 or 5

  Returns:

  reference to self

• getSocksUsername

  public @NullableString getSocksUsername()

  Gets the SOCKS proxy's username. Supported by SOCKS v5 and above.

  Returns:

  the SOCKS proxy's username

• setSocksUsername

  public Proxy setSocksUsername(String username)

  Specifies a username for the SOCKS proxy. Supported by SOCKS v5 and above.

  Parameters:

  username - username for the SOCKS proxy

  Returns:

  reference to self

• getSocksPassword

  public @NullableString getSocksPassword()

  Gets the SOCKS proxy's password. Supported by SOCKS v5 and above.

  Returns:

  the SOCKS proxy's password

• setSocksPassword

  public Proxy setSocksPassword(String password)

  Specifies a password for the SOCKS proxy. Supported by SOCKS v5 and above.

  Parameters:

  password - password for the SOCKS proxy

  Returns:

  reference to self

• getProxyAutoconfigUrl

  public @NullableString getProxyAutoconfigUrl()

  Gets the proxy auto-configuration URL.

  Returns:

  the proxy auto-configuration URL

• setProxyAutoconfigUrl

  public Proxy setProxyAutoconfigUrl(String proxyAutoconfigUrl)

  Specifies the URL to be used for proxy auto-configuration. Expected format is http://hostname.com:1234/pacfile. This is required ifgetProxyType() is set toProxy.ProxyType.PAC, ignored otherwise.

  Parameters:

  proxyAutoconfigUrl - the URL for proxy auto-configuration

  Returns:

  reference to self

• extractFrom

  public static @NullableProxy extractFrom(Capabilities capabilities)

• toString

  public String toString()

  Overrides:

  toString in class Object

• equals

  public boolean equals(@NullableObject o)

  Overrides:

  equals in class Object

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object