Freigeben über

ConnectionStringBuilder Klasse

  • Referenz
Paket:
com.microsoft.azure.servicebus.primitives
Maven-Artefakt:
com.microsoft.azure:azure-servicebus:3.6.7
  • java.lang.Object
    • com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder

public class ConnectionStringBuilder

Diese Klasse kann verwendet werden, um eine Verbindungszeichenfolge zu erstellen, die die Kommunikation mit ServiceBus-Entitäten herstellen kann. Es kann auch verwendet werden, um eine grundlegende Überprüfung für eine vorhandene Verbindungszeichenfolge durchzuführen.

Codebeispiel:

ConnectionStringBuilder connectionStringBuilder = new ConnectionStringBuilder(
                                          "ServiceBusNamespaceName", 
                                          "ServiceBusEntityName", // QueueName or TopicName or SubscriptionPath
                                          "SharedAccessSignatureKeyName", 
                                          "SharedAccessSignatureKey");
  
 String connectionString = connectionStringBuilder.toString();

Eine Verbindungszeichenfolge ist im Grunde eine Zeichenfolge, die aus einem Schlüssel-Wert-Paar besteht, das durch ";" getrennt ist. Das Standardformat ist {=[;=]}, wobei der unterstützte Schlüsselname wie folgt lautet:

  • Endpunkt: URL, die auf den Servicebusnamespace verweist
  • EntityPath: Pfad zur Service Bus-Entität (queue/topic/subscription/). Bei Warteschlangen und Themen ist es nur der Entitätsname. Für Abonnements lautet der Pfad /subscriptions/
  • SharedAccessKeyName: Schlüsselname für die entsprechende SAS-Richtlinienregel für den Namespace oder die Entität.
  • SharedAccessKey: Schlüsselwert für die entsprechende SAS-Richtlinienregel des Namespaces oder der Entität.
  • SharedAccessSignatureToken: Anstelle eines Schlüsselnamens und Schlüsselwerts können Clients ein bereits generiertes SAS-Token bereitstellen.
  • OperationTimeout: Standardtimeout, das für alle Absender, Empfänger und Clients verwendet werden soll, die aus dieser Verbindungszeichenfolge erstellt wurden.
  • RetryPolicy: Name der Wiederholungsrichtlinie.

Feldzusammenfassung

Modifizierer und Typ Feld und Beschreibung
static final Duration DefaultOperationTimeout

Standardmäßiges Vorgangstimeout, wenn das Timeout in der Verbindungszeichenfolge nicht angegeben ist.
static final String MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE

Der Für das Feld Authentifizierung verwendete Verbindungszeichenfolgenwert gibt an, dass der Verwaltete Identitätstokenanbieterfür Authentifizierungszwecke verwendet wird.
static final String MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
ConnectionStringBuilder(String connectionString)

Erstellt eine neue instance aus der angegebenen Verbindungszeichenfolge.
ConnectionStringBuilder(String namespaceConnectionString, String entityPath)

Erstellt eine neue instance aus der angegebenen Verbindungszeichenfolge und dem angegebenen Entitätspfad.
ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessSingature)

Erstellt eine neue instance aus Namespace, Entitätspfad und bereits generiertem SAS-Token.
ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessKeyName, String sharedAccessKey)

Erstellt eine neue instance aus Namespace, Entitätspfad und SAS-Schlüsselname und -wert.
ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessSingature)

Erstellt eine neue instance aus der Endpunktadresse der Namensapce, des Entitätspfads und des bereits generierten SAS-Tokens.
ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessKeyName, String sharedAccessKey)

Erstellt eine neue instance aus der Endpunktadresse der Nameapce, des Entitätspfads und des SAS-Schlüsselnamens und -werts.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
String getAuthentication()
URI getEndpoint()

Abrufen des Endpunkts, der zum Herstellen einer Verbindung mit dem ServiceBus-Namespace verwendet werden kann
String getEntityPath()

Abrufen des Entitätspfadwerts aus der Verbindungszeichenfolge
Duration getOperationTimeout()

Ruft die Dauer ab, nach der für einen ausstehenden Vorgang wie Senden oder EMPFANGEN ein Timeout auftritt.
RetryPolicy getRetryPolicy()

Rufen Sie die Wiederholungsrichtlinie instance ab, die im Rahmen der Erstellung dieses Generators erstellt wurde.
String getSasKey()

Rufen Sie den Schlüsselwert für die Shared Access-Richtlinie aus der Verbindungszeichenfolge oder NULL ab.
String getSasKeyName()

Rufen Sie den Namen des Besitzers der Shared Access-Richtlinie aus der Verbindungszeichenfolge oder NULL ab.
String getSharedAccessSignatureToken()

Gibt das Shared Access Signature Token aus der Verbindungszeichenfolge oder NULL zurück.
TransportType getTransportType()

Transporttyp, für den die gesamte Kommunikation für Service Bus mithilfe dieser Verbindungszeichenfolgeerstellt wurde.
void setOperationTimeout(Duration operationTimeout)

Legen Sie den Wert des Vorgangstimeoutin der Verbindungszeichenfolge fest.
void setRetryPolicy(RetryPolicy retryPolicy)

Legen Sie die Wiederholungsrichtlinie fest.
ConnectionStringBuilder setTransportType(TransportType transportType)

Legen Sie den Wert Transporttypin der Verbindungszeichenfolge fest.
String toLoggableString()
String toString()

Gibt eine interoperabilitätsfähige Verbindungszeichenfolge zurück, die zum Herstellen einer Verbindung mit dem ServiceBus-Namespace verwendet werden kann.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Felddetails

DefaultOperationTimeout

public static final Duration DefaultOperationTimeout

Timeout des Standardvorgangs, wenn timeout nicht in der Verbindungszeichenfolge angegeben ist. 30 Sekunden.

MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE

public static final String MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE

Der Für das Feld Authentifizierung verwendete Verbindungszeichenfolgenwert gibt an, dass managed Identity TokenProvider für Authentifizierungszwecke verwendet wird.

MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE

public static final String MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE

Details zum Konstruktor

ConnectionStringBuilder

public ConnectionStringBuilder(String connectionString)

Erstellt eine neue instance aus der angegebenen Verbindungszeichenfolge. ConnectionString-Format: Endpoint=sb://namespace_DNS_Name; EntityPath=EVENT_HUB_NAME; SharedAccessKeyName=SHARED_ACCESS_KEY_NAME; SharedAccessKey=SHARED_ACCESS_KEY oder Endpoint=sb://namespace_DNS_Name; EntityPath=EVENT_HUB_NAME; SharedAccessSignatureToken=SHARED_ACCESS_SIGNATURE_TOKEN

Parameter:

connectionString - ServiceBus ConnectionString

ConnectionStringBuilder

public ConnectionStringBuilder(String namespaceConnectionString, String entityPath)

Erstellt eine neue instance aus der angegebenen Verbindungszeichenfolge und dem angegebenen Entitätspfad. Eine Verbindungszeichenfolge kann den Entitätspfad enthalten oder nicht. ConnectionString-Format: Endpoint=sb://namespace_DNS_Name; EntityPath=EVENT_HUB_NAME; SharedAccessKeyName=SHARED_ACCESS_KEY_NAME; SharedAccessKey=SHARED_ACCESS_KEY oder Endpoint=sb://namespace_DNS_Name; EntityPath=EVENT_HUB_NAME; SharedAccessSignatureToken=SHARED_ACCESS_SIGNATURE_TOKEN

Parameter:

namespaceConnectionString - Connections-Zeichenfolge des ServiceBus-Namespace. Dies schließt den Entitätspfad nicht ein.
entityPath - Pfad zur Entität im Namespace

ConnectionStringBuilder

public ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessSingature)

Erstellt eine neue instance aus Namespace, Entitätspfad und bereits generiertem SAS-Token.

Parameter:

namespaceName - Namespacename (DNS-Suffix – z. B. .servicebus.windows.net ist nicht erforderlich)
entityPath - Entitätspfad. Verwenden Sie für Warteschlange oder Thema den Namen. Verwenden Sie <für ein Abonnement topicName>/subscriptions/<subscriptionName.>
sharedAccessSingature - Shared Access Signature bereits generiert

ConnectionStringBuilder

public ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessKeyName, String sharedAccessKey)

Erstellt eine neue instance aus Namespace, Entitätspfad und SAS-Schlüsselname und -wert.

Parameter:

namespaceName - Namespacename (DNS-Suffix – z. B. .servicebus.windows.net ist nicht erforderlich)
entityPath - Entitätspfad. Verwenden Sie für Warteschlange oder Thema den Namen. Verwenden Sie <für ein Abonnement topicName>/subscriptions/<subscriptionName.>
sharedAccessKeyName - Name des freigegebenen Zugriffsschlüssels
sharedAccessKey - Schlüssel für den gemeinsamen Zugriff

ConnectionStringBuilder

public ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessSingature)

Erstellt eine neue instance aus der Endpunktadresse der Namensapce, des Entitätspfads und des bereits generierten SAS-Tokens.

Parameter:

endpointAddress - Endpunkt auf Namespaceebene. Dies muss im Format scheme://fullyQualifiedServiceBusNamespaceEndpointName
entityPath - Entitätspfad. Verwenden Sie für Warteschlange oder Thema den Namen. Verwenden Sie <für ein Abonnement topicName>/subscriptions/<subscriptionName.>
sharedAccessSingature - Shared Access Signature bereits generiert

ConnectionStringBuilder

public ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessKeyName, String sharedAccessKey)

Erstellt eine neue instance aus der Endpunktadresse der Nameapce, des Entitätspfads und des SAS-Schlüsselnamens und -werts.

Parameter:

endpointAddress - Endpunkt auf Namespaceebene. Dies muss im Format scheme://fullyQualifiedServiceBusNamespaceEndpointName
entityPath - Entitätspfad. Verwenden Sie für Warteschlange oder Thema den Namen. Verwenden Sie <für ein Abonnement topicName>/subscriptions/<subscriptionName.>
sharedAccessKeyName - Name des freigegebenen Zugriffsschlüssels
sharedAccessKey - Schlüssel für den gemeinsamen Zugriff

Details zur Methode

getAuthentication

public String getAuthentication()

Gibt zurück:

Gibt die Authentifizierungsmethode zurück.

getEndpoint

public URI getEndpoint()

Abrufen des Endpunkts, der zum Herstellen einer Verbindung mit dem ServiceBus-Namespace verwendet werden kann

Gibt zurück:

Endpunkt, der den Service Bus-Namespace darstellt

getEntityPath

public String getEntityPath()

Abrufen des Entitätspfadwerts aus der Verbindungszeichenfolge

Gibt zurück:

Entitätspfad

getOperationTimeout

public Duration getOperationTimeout()

Ruft die Dauer ab, nach der für einen ausstehenden Vorgang wie Senden oder EMPFANGEN ein Timeout auftritt. Wenn kein Timeout angegeben wird, wird standardmäßig Dieser Wert von allen Vorgängen verwendet, die diesen ConnectionStringBuilderverwenden, es sei denn, es wird explizit überschriebenDefaultOperationTimeout.

Gibt zurück:

operationTimeout

getRetryPolicy

public RetryPolicy getRetryPolicy()

Rufen Sie die Wiederholungsrichtlinie instance ab, die im Rahmen der Erstellung dieses Generators erstellt wurde.

Gibt zurück:

RetryPolicy für jeden Vorgang angewendet, der mit diesem ConnectionString ausgeführt wird

getSasKey

public String getSasKey()

Rufen Sie den Schlüsselwert für die Shared Access-Richtlinie aus der Verbindungszeichenfolge oder NULL ab.

Gibt zurück:

Wert der Shared Access-Signatur

getSasKeyName

public String getSasKeyName()

Rufen Sie den Namen des Besitzers der Shared Access-Richtlinie aus der Verbindungszeichenfolge oder NULL ab.

Gibt zurück:

Schlüsselname der Shared Access-Signatur

getSharedAccessSignatureToken

public String getSharedAccessSignatureToken()

Gibt das Shared Access Signature Token aus der Verbindungszeichenfolge oder NULL zurück.

Gibt zurück:

Shared Access Signature Token

getTransportType

public TransportType getTransportType()

TransportType, für den die gesamte Kommunikation für Service Bus mit diesem ConnectionString erstellt wurde. Der Standardwert ist AMQP.

Gibt zurück:

transportType

setOperationTimeout

public void setOperationTimeout(Duration operationTimeout)

Legen Sie den Wert OperationTimeout in der Verbindungszeichenfolge fest. Dieser Wert wird von allen Vorgängen verwendet, die diesen ConnectionStringBuilderverwenden, es sei denn, es wird explizit überschrieben.

ConnectionString mit OperationTimeout kann nicht zwischen Java und Clients auf anderen Plattformen zusammenarbeiten.

Parameter:

operationTimeout - Timeout bei Vorgang

setRetryPolicy

public void setRetryPolicy(RetryPolicy retryPolicy)

Legen Sie die Wiederholungsrichtlinie fest.

RetryPolicy wird nicht als Teil von toString() serialisiert und ist nicht mit ServiceBus-Clients auf anderen Plattformen interoperabel.

Parameter:

retryPolicy - RetryPolicy für jeden Vorgang angewendet, der mit diesem ConnectionString ausgeführt wird

setTransportType

public ConnectionStringBuilder setTransportType(TransportType transportType)

Legen Sie den Wert TransportType in der Verbindungszeichenfolge fest. Wenn kein TransportType festgelegt ist, ist dies standardmäßig .AMQP

Parameter:

transportType - Transporttyp

Gibt zurück:

der ConnectionStringBuilder instance festgelegt wird.

toLoggableString

public String toLoggableString()

toString

public String toString()

Gibt eine interoperabilitätsfähige Verbindungszeichenfolge zurück, die zum Herstellen einer Verbindung mit dem ServiceBus-Namespace verwendet werden kann.

Überschreibt:

ConnectionStringBuilder.toString()

Gibt zurück:

Verbindungszeichenfolge

Gilt für: