ConnectionStringBuilder Classe

Paquet:

com.microsoft.azure.servicebus.primitives

Artefact Maven:

com.microsoft.azure:azure-servicebus:3.6.7

• java.lang.Object
• • com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder

public class ConnectionStringBuilder

Cette classe peut être utilisée pour construire une chaîne de connexion qui peut établir la communication avec les entités ServiceBus. Il peut également être utilisé pour effectuer une validation de base sur une chaîne de connexion existante.

Exemple de code :

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

Une chaîne de connexion est essentiellement une chaîne composée d’une paire clé-valeur séparée par « ; ». Le format de base est {=[;=]} où le nom de clé pris en charge est le suivant :

• Point de terminaison : URL qui pointe vers l’espace de noms servicebus
• EntityPath : chemin d’accès à l’entité Service Bus (file d’attente/rubrique/abonnement/). Pour les files d’attente et les rubriques, il s’agit simplement du nom d’entité. Pour les abonnements, le chemin d’accès est /subscriptions/
• SharedAccessKeyName : nom de la clé de la règle de stratégie d’accès partagé correspondante pour l’espace de noms ou l’entité.
• SharedAccessKey : valeur de clé pour la règle de stratégie d’accès partagé correspondante de l’espace de noms ou de l’entité.
• SharedAccessSignatureToken : au lieu d’un nom de clé et d’une valeur de clé, les clients peuvent fournir un jeton SAP déjà généré.
• OperationTimeout : délai d’expiration par défaut à utiliser pour tous les expéditeurs, récepteurs et clients créés à partir de cette chaîne de connexion.
• RetryPolicy : nom de la stratégie de nouvelle tentative.

Récapitulatif du champ

Modificateur et type	Champ et description
static final Duration	DefaultOperationTimeout Délai d’expiration de l’opération par défaut si le délai d’expiration n’est pas spécifié dans la chaîne de connexion.
static final String	MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE Valeur de chaîne de connexion utilisée pour le champ Authentification qui indique que le fournisseur de jetonsd’identité managée sera utilisé à des fins d’authentification.
static final String	MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE

Récapitulatif du constructeur

Constructeur	Description
ConnectionStringBuilder(String connectionString)	Crée une instance à partir de la chaîne de connexion donnée.
ConnectionStringBuilder(String namespaceConnectionString, String entityPath)	Crée une instance à partir de la chaîne de connexion et du chemin d’entité donnés.
ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessSingature)	Crée un instance à partir d’un espace de noms, d’un chemin d’entité et d’un jeton SAP déjà généré.
ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessKeyName, String sharedAccessKey)	Crée une instance à partir de l’espace de noms, du chemin d’accès de l’entité et du nom et de la valeur de la clé SAP.
ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessSingature)	Crée une instance à partir de l’adresse de point de terminaison du nomapce, du chemin d’accès de l’entité et du jeton SAP déjà généré.
ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessKeyName, String sharedAccessKey)	Crée une instance à partir de l’adresse de point de terminaison de l’apce de noms, du chemin d’accès de l’entité et du nom et de la valeur de la clé SAS

Résumé de la méthode

Modificateur et type	Méthode et description
String	getAuthentication()
URI	getEndpoint() Obtenir le point de terminaison qui peut être utilisé pour se connecter à l’espace de noms ServiceBus
String	getEntityPath() Obtenir la valeur du chemin d’accès de l’entité à partir de la chaîne de connexion
Duration	getOperationTimeout() Obtient la durée d’expiration d’une opération en attente comme Send ou RECEIVE.
RetryPolicy	getRetryPolicy() Obtenez la stratégie de nouvelle tentative instance qui a été créée dans le cadre de la création de ce générateur.
String	getSasKey() Obtenez la valeur de la clé de stratégie d’accès partagé à partir de la chaîne de connexion ou de la valeur Null.
String	getSasKeyName() Obtenez le nom du propriétaire de la stratégie d’accès partagé à partir de la chaîne de connexion ou de la valeur Null.
String	getSharedAccessSignatureToken() Retourne le jeton de signature d’accès partagé à partir de la chaîne de connexion ou de la valeur Null.
TransportType	getTransportType() Type de transportsur lequel toutes les communications du Service Bus ont été créées à l’aide de cette chaîne de connexion.
void	setOperationTimeout(Duration operationTimeout) Définissez la valeur du délai d’expiration de l’opérationdans la chaîne de connexion.
void	setRetryPolicy(RetryPolicy retryPolicy) Définissez la stratégie de nouvelle tentative.
ConnectionStringBuilder	setTransportType(TransportType transportType) Définissez la valeur Type de transportdans la chaîne de connexion.
String	toLoggableString()
String	toString() Retourne une chaîne de connexion interopérable qui peut être utilisée pour se connecter à l’espace de noms ServiceBus

Méthodes héritées de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Détails du champ

DefaultOperationTimeout

public static final Duration DefaultOperationTimeout

Délai d’expiration de l’opération par défaut si le délai d’expiration n’est pas spécifié dans la chaîne de connexion. 30 secondes.

MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE

public static final String MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE

Valeur de chaîne de connexion utilisée pour le champ Authentification qui indique que Managed Identity TokenProvider sera utilisé à des fins d’authentification.

MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE

public static final String MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE

Détails du constructeur

ConnectionStringBuilder

public ConnectionStringBuilder(String connectionString)

Crée une instance à partir de la chaîne de connexion donnée. Format ConnectionString : Endpoint=sb://namespace_DNS_Name; EntityPath=EVENT_HUB_NAME; SharedAccessKeyName=SHARED_ACCESS_KEY_NAME ; SharedAccessKey=SHARED_ACCESS_KEY ou Endpoint=sb://namespace_DNS_Name; EntityPath=EVENT_HUB_NAME; SharedAccessSignatureToken=SHARED_ACCESS_SIGNATURE_TOKEN

Paramètres:

connectionString - ServiceBus ConnectionString

ConnectionStringBuilder

public ConnectionStringBuilder(String namespaceConnectionString, String entityPath)

Crée une instance à partir de la chaîne de connexion et du chemin d’entité donnés. Une chaîne de connexion peut inclure ou non le chemin d’accès de l’entité. Format ConnectionString : Endpoint=sb://namespace_DNS_Name; EntityPath=EVENT_HUB_NAME; SharedAccessKeyName=SHARED_ACCESS_KEY_NAME ; SharedAccessKey=SHARED_ACCESS_KEY ou Endpoint=sb://namespace_DNS_Name; EntityPath=EVENT_HUB_NAME; SharedAccessSignatureToken=SHARED_ACCESS_SIGNATURE_TOKEN

Paramètres:

namespaceConnectionString - chaîne de connexions de l’espace de noms ServiceBus. Cela n’inclut pas le chemin d’accès à l’entité.

entityPath - chemin d’accès à l’entité dans l’espace de noms

ConnectionStringBuilder

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

Crée un instance à partir d’un espace de noms, d’un chemin d’entité et d’un jeton SAP déjà généré.

Paramètres:

namespaceName - Nom de l’espace de noms (suffixe dns - ex : .servicebus.windows.net n’est pas obligatoire)

entityPath - Chemin d’entité. Pour la file d’attente ou la rubrique, utilisez le nom. Pour l’abonnement, utilisez <topicName>/subscriptions/<subscriptionName>

sharedAccessSingature - Signature d’accès partagé déjà générée

ConnectionStringBuilder

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

Crée une instance à partir de l’espace de noms, du chemin d’accès de l’entité et du nom et de la valeur de la clé SAP.

Paramètres:

namespaceName - Nom de l’espace de noms (suffixe dns - ex : .servicebus.windows.net n’est pas obligatoire)

entityPath - Chemin d’entité. Pour la file d’attente ou la rubrique, utilisez le nom. Pour l’abonnement, utilisez <topicName>/subscriptions/<subscriptionName>

sharedAccessKeyName - Nom de la clé d’accès partagé

sharedAccessKey - Clé d’accès partagé

ConnectionStringBuilder

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

Crée une instance à partir de l’adresse de point de terminaison du nomapce, du chemin d’accès de l’entité et du jeton SAP déjà généré.

Paramètres:

endpointAddress - point de terminaison au niveau de l’espace de noms. Cela doit être au format de scheme://fullyQualifiedServiceBusNamespaceEndpointName

entityPath - Chemin d’entité. Pour la file d’attente ou la rubrique, utilisez le nom. Pour l’abonnement, utilisez <topicName>/subscriptions/<subscriptionName>

sharedAccessSingature - Signature d’accès partagé déjà générée

ConnectionStringBuilder

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

Crée une instance à partir de l’adresse de point de terminaison de l’apce de noms, du chemin d’accès de l’entité et du nom et de la valeur de la clé SAS

Paramètres:

endpointAddress - point de terminaison au niveau de l’espace de noms. Cela doit être au format de scheme://fullyQualifiedServiceBusNamespaceEndpointName

entityPath - Chemin d’entité. Pour la file d’attente ou la rubrique, utilisez le nom. Pour l’abonnement, utilisez <topicName>/subscriptions/<subscriptionName>

sharedAccessKeyName - Nom de la clé d’accès partagé

sharedAccessKey - Clé d’accès partagé

Détails de la méthode

getAuthentication

public String getAuthentication()

Retours:

Retourne la méthode d’authentification.

getEndpoint

public URI getEndpoint()

Obtenir le point de terminaison qui peut être utilisé pour se connecter à l’espace de noms ServiceBus

Retours:

Point de terminaison représentant l’espace de noms Service Bus

getEntityPath

public String getEntityPath()

Obtenir la valeur du chemin d’accès de l’entité à partir de la chaîne de connexion

Retours:

Chemin d’accès de l’entité

getOperationTimeout

public Duration getOperationTimeout()

Obtient la durée d’expiration d’une opération en attente comme Send ou RECEIVE. Si aucun délai d’expiration n’est spécifié, cette valeur est utilisée par défaut DefaultOperationTimeout par toutes les opérations qui utilisent ce ConnectionStringBuilder, sauf si elle est explicitement surchargé.

Retours:

operationTimeout

getRetryPolicy

public RetryPolicy getRetryPolicy()

Obtenez la stratégie de nouvelle tentative instance qui a été créée dans le cadre de la création de ce générateur.

Retours:

RetryPolicy appliqué pour toute opération effectuée à l’aide de cette connectionString

getSasKey

public String getSasKey()

Obtenez la valeur de la clé de stratégie d’accès partagé à partir de la chaîne de connexion ou de la valeur Null.

Retours:

Valeur de clé de signature d’accès partagé

getSasKeyName

public String getSasKeyName()

Obtenez le nom du propriétaire de la stratégie d’accès partagé à partir de la chaîne de connexion ou de la valeur Null.

Retours:

Nom de la clé de signature d’accès partagé

getSharedAccessSignatureToken

public String getSharedAccessSignatureToken()

Retourne le jeton de signature d’accès partagé à partir de la chaîne de connexion ou de la valeur Null.

Retours:

Jeton de signature d’accès partagé

getTransportType

public TransportType getTransportType()

TransportType sur lequel toutes les communications du Service Bus ont été créées à l’aide de cette connectionString. La valeur par défaut est AMQP.

Retours:

transportType

setOperationTimeout

public void setOperationTimeout(Duration operationTimeout)

Définissez la valeur OperationTimeout dans la chaîne de connexion. Cette valeur sera utilisée par toutes les opérations qui utilisent ce ConnectionStringBuilder, sauf si elle est explicitement surchargé.

ConnectionString avec operationTimeout n’est pas interopérable entre Java et les clients d’autres plateformes.

Paramètres:

operationTimeout - Dépassement du délai d’attente de l’opération

setRetryPolicy

public void setRetryPolicy(RetryPolicy retryPolicy)

Définissez la stratégie de nouvelle tentative.

RetryPolicy n’est pas sérialisé dans le cadre de toString() et n’est pas interopérable avec les clients ServiceBus dans d’autres plateformes.

Paramètres:

retryPolicy - RetryPolicy appliqué pour toute opération effectuée à l’aide de cette connectionString

setTransportType

public ConnectionStringBuilder setTransportType(TransportType transportType)

Définissez la valeur TransportType dans la chaîne de connexion. Si aucun Type de transport n’est défini, la valeur par défaut est AMQP.

Paramètres:

transportType - Type de transport

Retours:

instance ConnectionStringBuilder défini.

toLoggableString

public String toLoggableString()

toString

public String toString()

Retourne une chaîne de connexion interopérable qui peut être utilisée pour se connecter à l’espace de noms ServiceBus

Remplacements:

ConnectionStringBuilder.toString()

Retours:

chaîne de connexion