178 строки
12 KiB
YAML
178 строки
12 KiB
YAML
### 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:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **ProxyOptions**</br> implements <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html\">AutoCloseable</a>"
|
|
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: "<xref href=\"com.azure.core.amqp.ProxyAuthenticationType?alt=com.azure.core.amqp.ProxyAuthenticationType&text=ProxyAuthenticationType\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Proxy to use. If <code>null</code> is passed in, then the system configured <a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/Proxy.html\">Proxy</a>\n is used."
|
|
name: "proxyAddress"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/Proxy.html\">Proxy</a>"
|
|
- description: "Optional. Username used to authenticate with proxy. If not specified, the system-wide\n <a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/Authenticator.html\">Authenticator</a> is used to fetch credentials."
|
|
name: "username"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Optional. Password used to authenticate with proxy."
|
|
name: "password"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
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: "<xref href=\"com.azure.core.amqp.ProxyOptions?alt=com.azure.core.amqp.ProxyOptions&text=ProxyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
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 <xref uid=\"com.azure.core.util.Configuration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration\"></xref> that is used to load proxy configurations from the environment. If\n <code>null</code> is passed then <xref uid=\"com.azure.core.util.Configuration.getGlobalConfiguration*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration#getGlobalConfiguration()\"></xref> will be used."
|
|
name: "configuration"
|
|
type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static ProxyOptions fromConfiguration(Configuration configuration)"
|
|
desc: "Attempts to load a proxy from the configuration."
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.core.amqp.ProxyOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProxyOptions\"></xref> reflecting a proxy loaded from the environment, if no proxy is found <code>null</code>\n will be returned."
|
|
type: "<xref href=\"com.azure.core.amqp.ProxyOptions?alt=com.azure.core.amqp.ProxyOptions&text=ProxyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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 <code>null</code> if no authentication type was set. This occurs\n when user uses <xref uid=\"com.azure.core.amqp.ProxyOptions.SYSTEM_DEFAULTS\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProxyOptions#SYSTEM_DEFAULTS\"></xref>."
|
|
type: "<xref href=\"com.azure.core.amqp.ProxyAuthenticationType?alt=com.azure.core.amqp.ProxyAuthenticationType&text=ProxyAuthenticationType\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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 <code>null</code> if no credential was set. This occurs when user\n uses <xref uid=\"com.azure.core.amqp.ProxyOptions.SYSTEM_DEFAULTS\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProxyOptions#SYSTEM_DEFAULTS\"></xref>."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/PasswordAuthentication.html\">PasswordAuthentication</a>"
|
|
- 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 <code>null</code> if no proxy address was set This occurs when user uses\n <xref uid=\"com.azure.core.amqp.ProxyOptions.SYSTEM_DEFAULTS\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProxyOptions#SYSTEM_DEFAULTS\"></xref>."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/Proxy.html\">Proxy</a>"
|
|
- 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: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Properties for configuring proxies with Event Hubs."
|
|
implements:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html\">AutoCloseable</a>"
|
|
metadata: {}
|
|
package: "com.azure.core.amqp"
|
|
artifact: com.azure:azure-core-amqp:2.9.9
|