ProxyOptions Class

Package:

com.azure.core.amqp

Maven Artifact:

com.azure:azure-core-amqp:2.11.3

• java.lang.Object
• • com.azure.core.amqp.ProxyOptions

Implements

AutoCloseable

public class ProxyOptions
implements AutoCloseable

Properties for configuring proxies with Event Hubs.

Field Summary

Modifier and Type	Field and Description
static final String	PROXY_AUTHENTICATION_TYPE The configuration key for containing the authentication type to be used by the proxy.
static final String	PROXY_PASSWORD The configuration key for containing the password for the username who authenticates with the proxy.
static final String	PROXY_USERNAME The configuration key for containing the username who authenticates with the proxy.
static final ProxyOptions	SYSTEM_DEFAULTS Gets the system defaults for proxy configuration and authentication.

Constructor Summary

Constructor	Description
ProxyOptions(ProxyAuthenticationType authentication, Proxy proxyAddress, String username, String password)	Creates a proxy configuration that uses the proxyAddress and authenticates with provided username, password and authentication.

Method Summary

Modifier and Type	Method and Description
void	close() Disposes of the configuration along with potential credentials.
static ProxyOptions	fromConfiguration(Configuration configuration) Attempts to load a proxy from the configuration.
ProxyAuthenticationType	getAuthentication() Gets the proxy authentication type.
PasswordAuthentication	getCredential() Gets the credentials user provided for authentication of proxy server.
Proxy	getProxyAddress() Gets the proxy address.
boolean	hasUserDefinedCredentials() Gets whether the user has defined credentials.
boolean	isProxyAddressConfigured() Gets whether the proxy address has been configured.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Details

PROXY_AUTHENTICATION_TYPE

public static final String 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

PROXY_PASSWORD

public static final String PROXY_PASSWORD

The configuration key for containing the password for the username who authenticates with the proxy.

PROXY_USERNAME

public static final String PROXY_USERNAME

The configuration key for containing the username who authenticates with the proxy.

SYSTEM_DEFAULTS

public static final ProxyOptions 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 the proxyAddress and authenticates with provided username, password and authentication.

Parameters:

authentication - Authentication method to preemptively use with proxy.

proxyAddress - Proxy to use. If null is passed in, then the system configured Proxy is used.

username - Optional. Username used to authenticate with proxy. If not specified, the system-wide Authenticator is used to fetch credentials.

password - Optional. Password used to authenticate with proxy.

Method Details

close

public void close()

Disposes of the configuration along with potential credentials.

fromConfiguration

public static ProxyOptions fromConfiguration(Configuration configuration)

Attempts to load a proxy from the configuration.

Parameters:

configuration - The Configuration that is used to load proxy configurations from the environment. If null is passed then Configuration#getGlobalConfiguration() will be used.

Returns:

A ProxyOptions reflecting a proxy loaded from the environment, if no proxy is found null will be returned.

getAuthentication

public ProxyAuthenticationType 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 uses SYSTEM_DEFAULTS.

getCredential

public PasswordAuthentication 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 uses SYSTEM_DEFAULTS.

getProxyAddress

public Proxy getProxyAddress()

Gets the proxy address.

Returns:

the proxy address. Return null if no proxy address was set This occurs when user uses SYSTEM_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.