Package com.microsoft.azure.eventhubs
Class ProxyConfiguration
- java.lang.Object
-
- com.microsoft.azure.eventhubs.ProxyConfiguration
-
- All Implemented Interfaces:
AutoCloseable
public class ProxyConfiguration extends Object implements AutoCloseable
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ProxyConfiguration.ProxyAuthenticationType
Supported methods of proxy authentication.
-
Field Summary
Fields Modifier and Type Field Description static ProxyConfiguration
SYSTEM_DEFAULTS
Gets the system defaults for proxy configuration and authentication.
-
Constructor Summary
Constructors Constructor Description ProxyConfiguration(ProxyConfiguration.ProxyAuthenticationType authentication, Proxy proxyAddress, String username, String password)
Creates a proxy configuration that uses theproxyAddress
and authenticates with providedusername
,password
andauthentication
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProxyConfiguration.ProxyAuthenticationType
authentication()
Gets the proxy authentication type to use.void
close()
PasswordAuthentication
credentials()
Gets credentials to authenticate against proxy with.boolean
hasUserDefinedCredentials()
Gets whether the user has defined credentials.boolean
isProxyAddressConfigured()
Gets whether the proxy address has been configured.Proxy
proxyAddress()
Gets the proxy address.
-
-
-
Field Detail
-
SYSTEM_DEFAULTS
public static final ProxyConfiguration SYSTEM_DEFAULTS
Gets the system defaults for proxy configuration and authentication.
-
-
Constructor Detail
-
ProxyConfiguration
public ProxyConfiguration(ProxyConfiguration.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
isProxyConfiguration.ProxyAuthenticationType.BASIC
orProxyConfiguration.ProxyAuthenticationType.DIGEST
andusername
orpassword
arenull
.
-
-
Method Detail
-
proxyAddress
public Proxy proxyAddress()
Gets the proxy address.- Returns:
- The proxy address. Returns
null
if user creates proxy credentials withSYSTEM_DEFAULTS
.
-
credentials
public PasswordAuthentication credentials()
Gets credentials to authenticate against proxy with.- Returns:
- The credentials to authenticate against proxy with. Returns
null
if no credentials were set. This occurs when user usesSYSTEM_DEFAULTS
.
-
authentication
public ProxyConfiguration.ProxyAuthenticationType authentication()
Gets the proxy authentication type to use.- Returns:
- The proxy authentication type to use. returns
null
if no authentication type 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()
- Specified by:
close
in interfaceAutoCloseable
-
-