106 строки
8.9 KiB
YAML
106 строки
8.9 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties"
|
|
name: "ServiceBusConnectionStringProperties"
|
|
nameWithType: "ServiceBusConnectionStringProperties"
|
|
summary: "A utility class that parses a connection string into sections."
|
|
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 final class **ServiceBusConnectionStringProperties**"
|
|
methods:
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties.getEndpoint()"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties.getEndpoint()"
|
|
name: "getEndpoint()"
|
|
nameWithType: "ServiceBusConnectionStringProperties.getEndpoint()"
|
|
summary: "Gets the \"Endpoint\" value of the connection string."
|
|
syntax: "public String getEndpoint()"
|
|
desc: "Gets the \"Endpoint\" value of the connection string."
|
|
returns:
|
|
description: "The endpoint."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties.getEntityPath()"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties.getEntityPath()"
|
|
name: "getEntityPath()"
|
|
nameWithType: "ServiceBusConnectionStringProperties.getEntityPath()"
|
|
summary: "Gets the \"Entity<wbr>Path\" value of the connection string."
|
|
syntax: "public String getEntityPath()"
|
|
desc: "Gets the \"EntityPath\" value of the connection string."
|
|
returns:
|
|
description: "The entity path, or <code>null</code> if the connection string doesn't have an \"EntityPath\"."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties.getFullyQualifiedNamespace()"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties.getFullyQualifiedNamespace()"
|
|
name: "getFullyQualifiedNamespace()"
|
|
nameWithType: "ServiceBusConnectionStringProperties.getFullyQualifiedNamespace()"
|
|
summary: "Gets the fully qualified namespace, or hostname, from the connection string \"Endpoint\" section."
|
|
syntax: "public String getFullyQualifiedNamespace()"
|
|
desc: "Gets the fully qualified namespace, or hostname, from the connection string \"Endpoint\" section."
|
|
returns:
|
|
description: "The fully qualified namespace."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties.getSharedAccessKey()"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties.getSharedAccessKey()"
|
|
name: "getSharedAccessKey()"
|
|
nameWithType: "ServiceBusConnectionStringProperties.getSharedAccessKey()"
|
|
summary: "Gets the \"Shared<wbr>Access<wbr>Signature\" section of the connection string."
|
|
syntax: "public String getSharedAccessKey()"
|
|
desc: "Gets the \"SharedAccessSignature\" section of the connection string."
|
|
returns:
|
|
description: "The shared access key value, or <code>null</code> if the connection string doesn't have a\n \"SharedAccessSignature\"."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties.getSharedAccessKeyName()"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties.getSharedAccessKeyName()"
|
|
name: "getSharedAccessKeyName()"
|
|
nameWithType: "ServiceBusConnectionStringProperties.getSharedAccessKeyName()"
|
|
summary: "Gets the \"Shared<wbr>Access<wbr>Key<wbr>Name\" section of the connection string."
|
|
syntax: "public String getSharedAccessKeyName()"
|
|
desc: "Gets the \"SharedAccessKeyName\" section of the connection string."
|
|
returns:
|
|
description: "The shared access key name, or <code>null</code> if the connection string doesn't have a\n \"SharedAccessKeyName\"."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties.getSharedAccessSignature()"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties.getSharedAccessSignature()"
|
|
name: "getSharedAccessSignature()"
|
|
nameWithType: "ServiceBusConnectionStringProperties.getSharedAccessSignature()"
|
|
summary: "Gets the \"Shared<wbr>Access<wbr>Signature\" section of the connection string."
|
|
syntax: "public String getSharedAccessSignature()"
|
|
desc: "Gets the \"SharedAccessSignature\" section of the connection string."
|
|
returns:
|
|
description: "The shared access signature, or <code>null</code> if the connection string doesn't have a\n \"SharedAccessSignature\"."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties.parse(java.lang.String)"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusConnectionStringProperties.parse(String connectionString)"
|
|
name: "parse(String connectionString)"
|
|
nameWithType: "ServiceBusConnectionStringProperties.parse(String connectionString)"
|
|
summary: "Parse a Service Bus connection string into an instance of this class."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The connection string to be parsed."
|
|
name: "connectionString"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public static ServiceBusConnectionStringProperties parse(String connectionString)"
|
|
desc: "Parse a Service Bus connection string into an instance of this class."
|
|
returns:
|
|
description: "An instance of this class."
|
|
type: "<xref href=\"com.azure.messaging.servicebus.ServiceBusConnectionStringProperties?alt=com.azure.messaging.servicebus.ServiceBusConnectionStringProperties&text=ServiceBusConnectionStringProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A utility class that parses a connection string into sections. A Service Bus connection string is a set of key value pairs separated by semi-colon. A typical example is `\"Endpoint=sb://foo.servicebus.windows.net/;SharedAccessKeyName=someKeyName;SharedAccessKey=someKeyValue\"`.\n\nA connection may have the following sections:\n\n * Endpoint, which is mandatory. The hostname part of it is the \"Fully qualified namespace\".\n * SharedAccessKeyName and SharedAccessKey, optional, used to authenticate the access to the ServiceBus.\n * SharedAccessSignature, optional, an alternative way to authenticate the access to the ServiceBus.\n * EntityPath, optional, the queue name or the topic name under the service namespace\n\nWhen you have a ServiceBus connection string, you can use <xref uid=\"com.azure.messaging.servicebus.ServiceBusClientBuilder.connectionString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusClientBuilder#connectionString(String)\"></xref> to build a client. If you'd like to use a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> to access a Service Bus, you can use this utility class to take the fully qualified namespace and optionally the entity path (queue/topic name) from the connection string and then use <xref uid=\"com.azure.messaging.servicebus.ServiceBusClientBuilder.credential(java.lang.String,com.azure.core.credential.TokenCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusClientBuilder#credential(String, TokenCredential)\"></xref>."
|
|
metadata: {}
|
|
package: "com.azure.messaging.servicebus"
|
|
artifact: com.azure:azure-messaging-servicebus:7.17.5
|