### YamlMime:JavaType
uid: "com.azure.core.amqp.ProxyOptions"
fullName: "com.azure.core.amqp.ProxyOptions"
name: "ProxyOptions"
nameWithType: "ProxyOptions"
summary: "Properties for configuring proxies with Event Hubs."
inheritances:
- ""
inheritedClassMethods:
- classRef: "java.lang.Object"
methodsRef:
- "clone"
- "equals"
- "finalize"
- "getClass"
- "hashCode"
- "notify"
- "notifyAll"
- "toString"
- "wait"
- "wait"
- "wait"
syntax: "public class **ProxyOptions** implements AutoCloseable"
constructors:
- uid: "com.azure.core.amqp.ProxyOptions.ProxyOptions(com.azure.core.amqp.ProxyAuthenticationType,java.net.Proxy,java.lang.String,java.lang.String)"
fullName: "com.azure.core.amqp.ProxyOptions.ProxyOptions(ProxyAuthenticationType authentication, Proxy proxyAddress, String username, String password)"
name: "ProxyOptions(ProxyAuthenticationType authentication, Proxy proxyAddress, String username, String password)"
nameWithType: "ProxyOptions.ProxyOptions(ProxyAuthenticationType authentication, Proxy proxyAddress, String username, String password)"
summary: "Creates a proxy configuration that uses the `proxyAddress` and authenticates with provided `username`, `password` and `authentication`."
parameters:
- description: "Authentication method to preemptively use with proxy."
name: "authentication"
type: ""
- description: "Proxy to use. If null
is passed in, then the system configured Proxy\n is used."
name: "proxyAddress"
type: "Proxy"
- description: "Optional. Username used to authenticate with proxy. If not specified, the system-wide\n Authenticator is used to fetch credentials."
name: "username"
type: "String"
- description: "Optional. Password used to authenticate with proxy."
name: "password"
type: "String"
syntax: "public ProxyOptions(ProxyAuthenticationType authentication, Proxy proxyAddress, String username, String password)"
desc: "Creates a proxy configuration that uses the `proxyAddress` and authenticates with provided `username`, `password` and `authentication`."
fields:
- uid: "com.azure.core.amqp.ProxyOptions.PROXY_AUTHENTICATION_TYPE"
fullName: "com.azure.core.amqp.ProxyOptions.PROXY_AUTHENTICATION_TYPE"
name: "PROXY_AUTHENTICATION_TYPE"
nameWithType: "ProxyOptions.PROXY_AUTHENTICATION_TYPE"
summary: "The configuration key for containing the authentication type to be used by the proxy."
modifiers:
- "static"
- "final"
field:
value: "PROXY_AUTHENTICATION_TYPE"
type: "String"
syntax: "public static final String PROXY_AUTHENTICATION_TYPE"
desc: "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"
- uid: "com.azure.core.amqp.ProxyOptions.PROXY_PASSWORD"
fullName: "com.azure.core.amqp.ProxyOptions.PROXY_PASSWORD"
name: "PROXY_PASSWORD"
nameWithType: "ProxyOptions.PROXY_PASSWORD"
summary: "The configuration key for containing the password for the username who authenticates with the proxy."
modifiers:
- "static"
- "final"
field:
value: "PROXY_PASSWORD"
type: "String"
syntax: "public static final String PROXY_PASSWORD"
desc: "The configuration key for containing the password for the username who authenticates with the proxy."
- uid: "com.azure.core.amqp.ProxyOptions.PROXY_USERNAME"
fullName: "com.azure.core.amqp.ProxyOptions.PROXY_USERNAME"
name: "PROXY_USERNAME"
nameWithType: "ProxyOptions.PROXY_USERNAME"
summary: "The configuration key for containing the username who authenticates with the proxy."
modifiers:
- "static"
- "final"
field:
value: "PROXY_USERNAME"
type: "String"
syntax: "public static final String PROXY_USERNAME"
desc: "The configuration key for containing the username who authenticates with the proxy."
- uid: "com.azure.core.amqp.ProxyOptions.SYSTEM_DEFAULTS"
fullName: "com.azure.core.amqp.ProxyOptions.SYSTEM_DEFAULTS"
name: "SYSTEM_DEFAULTS"
nameWithType: "ProxyOptions.SYSTEM_DEFAULTS"
summary: "Gets the system defaults for proxy configuration and authentication."
modifiers:
- "static"
- "final"
field:
type: ""
syntax: "public static final ProxyOptions SYSTEM_DEFAULTS"
desc: "Gets the system defaults for proxy configuration and authentication."
methods:
- uid: "com.azure.core.amqp.ProxyOptions.close()"
fullName: "com.azure.core.amqp.ProxyOptions.close()"
name: "close()"
nameWithType: "ProxyOptions.close()"
summary: "Disposes of the configuration along with potential credentials."
syntax: "public void close()"
desc: "Disposes of the configuration along with potential credentials."
- uid: "com.azure.core.amqp.ProxyOptions.fromConfiguration(com.azure.core.util.Configuration)"
fullName: "com.azure.core.amqp.ProxyOptions.fromConfiguration(Configuration configuration)"
name: "fromConfiguration(Configuration configuration)"
nameWithType: "ProxyOptions.fromConfiguration(Configuration configuration)"
summary: "Attempts to load a proxy from the configuration."
modifiers:
- "static"
parameters:
- description: "The that is used to load proxy configurations from the environment. If\n null
is passed then will be used."
name: "configuration"
type: ""
syntax: "public static ProxyOptions fromConfiguration(Configuration configuration)"
desc: "Attempts to load a proxy from the configuration."
returns:
description: "A reflecting a proxy loaded from the environment, if no proxy is found null
\n will be returned."
type: ""
- uid: "com.azure.core.amqp.ProxyOptions.getAuthentication()"
fullName: "com.azure.core.amqp.ProxyOptions.getAuthentication()"
name: "getAuthentication()"
nameWithType: "ProxyOptions.getAuthentication()"
summary: "Gets the proxy authentication type."
syntax: "public ProxyAuthenticationType getAuthentication()"
desc: "Gets the proxy authentication type."
returns:
description: "the proxy authentication type to use. Returns null
if no authentication type was set. This occurs\n when user uses ."
type: ""
- uid: "com.azure.core.amqp.ProxyOptions.getCredential()"
fullName: "com.azure.core.amqp.ProxyOptions.getCredential()"
name: "getCredential()"
nameWithType: "ProxyOptions.getCredential()"
summary: "Gets the credentials user provided for authentication of proxy server."
syntax: "public PasswordAuthentication getCredential()"
desc: "Gets the credentials user provided for authentication of proxy server."
returns:
description: "the username and password to use. Return null
if no credential was set. This occurs when user\n uses ."
type: "PasswordAuthentication"
- uid: "com.azure.core.amqp.ProxyOptions.getProxyAddress()"
fullName: "com.azure.core.amqp.ProxyOptions.getProxyAddress()"
name: "getProxyAddress()"
nameWithType: "ProxyOptions.getProxyAddress()"
summary: "Gets the proxy address."
syntax: "public Proxy getProxyAddress()"
desc: "Gets the proxy address."
returns:
description: "the proxy address. Return null
if no proxy address was set This occurs when user uses\n ."
type: "Proxy"
- uid: "com.azure.core.amqp.ProxyOptions.hasUserDefinedCredentials()"
fullName: "com.azure.core.amqp.ProxyOptions.hasUserDefinedCredentials()"
name: "hasUserDefinedCredentials()"
nameWithType: "ProxyOptions.hasUserDefinedCredentials()"
summary: "Gets whether the user has defined credentials."
syntax: "public boolean hasUserDefinedCredentials()"
desc: "Gets whether the user has defined credentials."
returns:
description: "true if the user has defined the credentials to use, false otherwise."
type: ""
- uid: "com.azure.core.amqp.ProxyOptions.isProxyAddressConfigured()"
fullName: "com.azure.core.amqp.ProxyOptions.isProxyAddressConfigured()"
name: "isProxyAddressConfigured()"
nameWithType: "ProxyOptions.isProxyAddressConfigured()"
summary: "Gets whether the proxy address has been configured."
syntax: "public boolean isProxyAddressConfigured()"
desc: "Gets whether the proxy address has been configured. Used to determine whether to use system-defined or user-defined proxy."
returns:
description: "true if the proxy url has been set, and false otherwise."
type: ""
type: "class"
desc: "Properties for configuring proxies with Event Hubs."
implements:
- "AutoCloseable"
metadata: {}
package: "com.azure.core.amqp"
artifact: com.azure:azure-core-amqp:2.9.9