fm.liveswitch.Proxy Class Reference

Proxy utility methods. More...

Public Member Functions

 Proxy ()
 

Static Public Member Functions

static fm.liveswitch.Future< fm.liveswitch.ProxyAuthCheckResultauthCheck (String url)
 Checks if proxy authentication is required to access a given URL. More...
 
static String exportCredentials ()
 Exports the credentials to JSON. More...
 
static fm.liveswitch.ProxyCredentials getCredentials (String proxyIPAddress)
 Gets the proxy credentials for the given proxy IP address. More...
 
static void importCredentials (String credentialsJson)
 Imports credentials from JSON. More...
 
static void setCredentials (String proxyIPAddress, fm.liveswitch.ProxyCredentials proxyCredentials)
 Sets the proxy credentials for the given proxy IP address. More...
 
static void setCredentials (String[] proxyIPAddresses, fm.liveswitch.ProxyCredentials proxyCredentials)
 Sets the proxy credentials for the given proxy IP addresss. More...
 

Detailed Description

Proxy utility methods.

Constructor & Destructor Documentation

◆ Proxy()

fm.liveswitch.Proxy.Proxy ( )

Member Function Documentation

◆ authCheck()

static fm.liveswitch.Future<fm.liveswitch.ProxyAuthCheckResult> fm.liveswitch.Proxy.authCheck ( String  url)
static

Checks if proxy authentication is required to access a given URL.

Parameters
urlThe URL.

◆ exportCredentials()

static String fm.liveswitch.Proxy.exportCredentials ( )
static

Exports the credentials to JSON.

Returns
The credentials in JSON format.

◆ getCredentials()

static fm.liveswitch.ProxyCredentials fm.liveswitch.Proxy.getCredentials ( String  proxyIPAddress)
static

Gets the proxy credentials for the given proxy IP address.

Parameters
proxyIPAddressThe proxy IP address.
Returns
The proxy credentials, if they exist, or
null
.

◆ importCredentials()

static void fm.liveswitch.Proxy.importCredentials ( String  credentialsJson)
static

Imports credentials from JSON.

Parameters
credentialsJsonThe credentials in JSON format.

◆ setCredentials() [1/2]

static void fm.liveswitch.Proxy.setCredentials ( String  proxyIPAddress,
fm.liveswitch.ProxyCredentials  proxyCredentials 
)
static

Sets the proxy credentials for the given proxy IP address.

Parameters
proxyIPAddressThe proxy IP address.
proxyCredentialsThe proxy credentials.

◆ setCredentials() [2/2]

static void fm.liveswitch.Proxy.setCredentials ( String[]  proxyIPAddresses,
fm.liveswitch.ProxyCredentials  proxyCredentials 
)
static

Sets the proxy credentials for the given proxy IP addresss.

Parameters
proxyIPAddressesThe proxy IP addresses.
proxyCredentialsThe proxy credentials.