Class for storing settings when using a proxy server.
More...
#include <LicenseSpring/ExtendedOptions.h>
Class for storing settings when using a proxy server.
Definition at line 60 of file ExtendedOptions.h.
◆ ProxySettings() [1/2]
LicenseSpring::ProxySettings::ProxySettings |
( |
| ) |
|
|
default |
Default constructor for proxy settings.
◆ ProxySettings() [2/2]
LicenseSpring::ProxySettings::ProxySettings |
( |
const std::string & |
proxy, |
|
|
const std::string & |
user, |
|
|
const std::string & |
password |
|
) |
| |
Constructor for proxy settings.
- Parameters
-
proxy | String of proxy URI |
user | String of user |
password | String of password |
◆ ~ProxySettings()
LicenseSpring::ProxySettings::~ProxySettings |
( |
| ) |
|
Destructor for proxy settings.
◆ fetchProxySettings()
bool LicenseSpring::ProxySettings::fetchProxySettings |
( |
const std::string & |
serviceURL, |
|
|
const std::string & |
credentialTarget, |
|
|
bool |
throwExceptions = false |
|
) |
| |
Automatically fetch proxy URI and credentials.
Usable only on Windows.
Tries to automatically fetch PAC file and proxy settings specific to the LicenseSpring API URL. Otherwise fetches default WinHTTP proxy.
Also tries to fetch credential data through Windows Credential Manager.
- Parameters
-
serviceURL | License API URL |
credentialTarget | Proxy credentials name in Windows Credential Manager |
throwExceptions | Indicates whether this method should throw exceptions |
- Exceptions
-
- Returns
- True if fetching proxy settings is successful and false otherwise.
◆ setProxyUri()
void LicenseSpring::ProxySettings::setProxyUri |
( |
const std::string & |
uri | ) |
|
Setter for proxy URI.
- Parameters
-
◆ getProxyUri()
const std::string& LicenseSpring::ProxySettings::getProxyUri |
( |
| ) |
const |
Getter for proxy URI.
- Returns
- String of proxy URI.
◆ setUser()
void LicenseSpring::ProxySettings::setUser |
( |
const std::string & |
user | ) |
|
Setter for proxy user.
- Parameters
-
user | String for proxy user |
◆ getUser()
const std::string& LicenseSpring::ProxySettings::getUser |
( |
| ) |
const |
Getter for proxy user.
- Returns
- String of proxy user.
◆ setPassword()
void LicenseSpring::ProxySettings::setPassword |
( |
const std::string & |
password | ) |
|
Setter for password.
- Parameters
-
password | String for password |
◆ getPassword()
const std::string& LicenseSpring::ProxySettings::getPassword |
( |
| ) |
const |
Getter for password.
- Returns
- String of password.
◆ isValid()
bool LicenseSpring::ProxySettings::isValid |
( |
| ) |
const |
Checker for if proxy URI is specified (i.e. not empty).
- Returns
- True if specified, false if empty.
The documentation for this class was generated from the following file: