Package com.azure.core.amqp
Class ProxyOptions
java.lang.Object
com.azure.core.amqp.ProxyOptions
- All Implemented Interfaces:
AutoCloseable
Properties for configuring proxies with Event Hubs.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The configuration key for containing the authentication type to be used by the proxy.static final String
The configuration key for containing the password for the username who authenticates with the proxy.static final String
The configuration key for containing the username who authenticates with the proxy.static final ProxyOptions
Gets the system defaults for proxy configuration and authentication. -
Constructor Summary
ConstructorDescriptionProxyOptions
(ProxyAuthenticationType authentication, Proxy proxyAddress, String username, String password) Creates a proxy configuration that uses theproxyAddress
and authenticates with providedusername
,password
andauthentication
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Disposes of the configuration along with potential credentials.static ProxyOptions
fromConfiguration
(Configuration configuration) Attempts to load a proxy from the configuration.Gets the proxy authentication type.Gets the credentials user provided for authentication of proxy server.Gets the proxy address.boolean
Gets whether the user has defined credentials.boolean
Gets whether the proxy address has been configured.
-
Field Details
-
PROXY_USERNAME
The configuration key for containing the username who authenticates with the proxy.- See Also:
-
PROXY_PASSWORD
The configuration key for containing the password for the username who authenticates with the proxy.- See Also:
-
PROXY_AUTHENTICATION_TYPE
The configuration key for containing the authentication type to be used by the proxy. This can one of three values - - NONE - BASIC - DIGEST as defined in ProxyAuthenticationType- See Also:
-
SYSTEM_DEFAULTS
Gets the system defaults for proxy configuration and authentication.
-
-
Constructor Details
-
ProxyOptions
public ProxyOptions(ProxyAuthenticationType authentication, Proxy proxyAddress, String username, String password) Creates a proxy configuration that uses theproxyAddress
and authenticates with providedusername
,password
andauthentication
.- Parameters:
authentication
- Authentication method to preemptively use with proxy.proxyAddress
- Proxy to use. Ifnull
is passed in, then the system configuredProxy
is used.username
- Optional. Username used to authenticate with proxy. If not specified, the system-wideAuthenticator
is used to fetch credentials.password
- Optional. Password used to authenticate with proxy.- Throws:
NullPointerException
- ifauthentication
isnull
.IllegalArgumentException
- ifauthentication
isProxyAuthenticationType.BASIC
orProxyAuthenticationType.DIGEST
andusername
orpassword
arenull
.
-
-
Method Details
-
fromConfiguration
Attempts to load a proxy from the configuration.- Parameters:
configuration
- TheConfiguration
that is used to load proxy configurations from the environment. Ifnull
is passed thenConfiguration.getGlobalConfiguration()
will be used.- Returns:
- A
ProxyOptions
reflecting a proxy loaded from the environment, if no proxy is foundnull
will be returned. - Throws:
RuntimeException
- If passedConfiguration
contains invalid configuration options,RuntimeException
is thrown.
-
getAuthentication
Gets the proxy authentication type.- Returns:
- the proxy authentication type to use. Returns
null
if no authentication type was set. This occurs when user usesSYSTEM_DEFAULTS
.
-
getProxyAddress
Gets the proxy address.- Returns:
- the proxy address. Return
null
if no proxy address was set This occurs when user usesSYSTEM_DEFAULTS
.
-
getCredential
Gets the credentials user provided for authentication of proxy server.- Returns:
- the username and password to use. Return
null
if no credential was set. This occurs when user usesSYSTEM_DEFAULTS
.
-
hasUserDefinedCredentials
public boolean hasUserDefinedCredentials()Gets whether the user has defined credentials.- Returns:
- true if the user has defined the credentials to use, false otherwise.
-
isProxyAddressConfigured
public boolean isProxyAddressConfigured()Gets whether the proxy address has been configured. Used to determine whether to use system-defined or user-defined proxy.- Returns:
- true if the proxy url has been set, and false otherwise.
-
close
public void close()Disposes of the configuration along with potential credentials.- Specified by:
close
in interfaceAutoCloseable
-