com.zoiper.zdk.Providers

Class ProxyManager

java.lang.Object

com.zoiper.zdk.Providers.ProxyManager

public class ProxyManager
extends java.lang.Object

Proxy Manager

Constructor Summary

Constructors

Constructor and Description
ProxyManager(long handle) Constructor storing the pointer/address to the underlying native object

Method Summary

Modifier and Type	Method and Description
ProxyConfig	createProxyConfig(ProxyProtocolType protocol, ProxyModeType mode, java.lang.String hostname, int port, java.lang.String username, java.lang.String password) Creates a new Proxy configuration with the given parameters If mode is ZDK::ProxyModeType::Environemnt, the environment/system settings are used and arugments _hostname_ and _port_ are ignored.
protected void	finalize() Ensures the underlying native object destruction
ProxyConfig	getProxyConfig(ProxyProtocolType protocol, ProxyModeType mode) Gets the current proxy configuration Gets the currently configured proxy for given protocol.
ProxyConfig	getProxyConfigForURL(java.lang.String url) Gets the current proxy configuration for the specified URL
long	handle() Gets the pointer/address to the underlying native object
Result	setProxyConfig(ProxyConfig value) Sets the current proxy configuration Changes the current proxy configuration to use for specified protocol requests.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProxyManager

public ProxyManager(long handle)

Constructor storing the pointer/address to the underlying native object

Parameters:

handle - Pointer/address to the underlying native object

Method Detail

handle

public long handle()

Gets the pointer/address to the underlying native object

Returns:

Pointer/address to the underlying native object

finalize

protected void finalize()

Ensures the underlying native object destruction

Overrides:

finalize in class java.lang.Object

createProxyConfig

public ProxyConfig createProxyConfig(ProxyProtocolType protocol,
                                     ProxyModeType mode,
                                     java.lang.String hostname,
                                     int port,
                                     java.lang.String username,
                                     java.lang.String password)

Creates a new Proxy configuration with the given parameters If mode is ZDK::ProxyModeType::Environemnt, the environment/system settings are used and arugments _hostname_ and _port_ are ignored. If mode is ZDK::ProxyModeType::Custom, the provided _hostname_ and _port_ are used. If set the _username_ and _password_ will be used to authenticate the proxy (works for both _Envirenment/System_ and _Custom_ proxies)

Parameters:

protocol - The protocol whose settings to configure

mode - Which settings to set

hostname - The hostname of the configured proxy

port - The port of the configured proxy

username - The username to use when authenticating

password - The password to use when authenticating

Returns:

New proxy configuration

See Also:

ProxyConfig

setProxyConfig

public Result setProxyConfig(ProxyConfig value)

Sets the current proxy configuration Changes the current proxy configuration to use for specified protocol requests. If mode is ZDK::ProxyModeType::Environemnt, the environment/system settings are used and arugments _hostname_ and _port_ are ignored. If mode is ZDK::ProxyModeType::Custom, the provided _hostname_ and _port_ are used.

Parameters:

value - The configuration to set

Returns:

Result of the setting

See Also:

ProxyConfig

getProxyConfig

public ProxyConfig getProxyConfig(ProxyProtocolType protocol,
                                  ProxyModeType mode)

Gets the current proxy configuration Gets the currently configured proxy for given protocol. If mode is ZDK::ProxyModeType::Custom, the function gets the currently selected settings. If mode is ZDK::ProxyModeType::Environemnt, the function gets the environment/system settings. NOTE! Proxy authentication credentials (_username_ and _password_) will NOT be retrieved!

Parameters:

protocol - The protocol whose settings to get

mode - Which settings to get

Returns:

The currently used proxy configuration if set, or nullptr otherwise.

See Also:

ProxyConfig

getProxyConfigForURL

public ProxyConfig getProxyConfigForURL(java.lang.String url)

Gets the current proxy configuration for the specified URL

Parameters:

url - The URL to check against

Returns:

The currently used proxy configuration if set, or nullptr otherwise.

See Also:

ProxyConfig