Compartilhar via

ConnectionStringBuilder Classe

  • Referência
Pacote:
com.microsoft.azure.servicebus.primitives
Artefato Maven:
com.microsoft.azure:azure-servicebus:3.6.7
  • java.lang.Object
    • com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder

public class ConnectionStringBuilder

Essa classe pode ser usada para construir uma cadeia de conexão que possa estabelecer comunicação com entidades do ServiceBus. Ele também pode ser usado para executar a validação básica em uma cadeia de conexão existente.

Código do exemplo:

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

Uma cadeia de conexão é basicamente uma cadeia de caracteres composta por par chave-valor separado por ";". O formato básico é {=[;=]} em que o nome da chave com suporte é o seguinte:

  • Ponto de extremidade – URL que aponta para o namespace do servicebus
  • EntityPath – caminho para a entidade do barramento de serviço (fila/tópico/assinatura/). Para filas e tópicos, é apenas o nome da entidade. Para assinaturas, o caminho é /subscriptions/
  • SharedAccessKeyName - Nome da chave para a regra de política de acesso compartilhado correspondente para o namespace ou entidade.
  • SharedAccessKey - Valor da chave para a regra de política de acesso compartilhado correspondente do namespace ou da entidade.
  • SharedAccessSignatureToken – em vez de um nome de chave e um valor de chave, os clientes podem fornecer um Token SAS já gerado.
  • OperationTimeout – tempo limite padrão a ser usado para todos os remetentes, receptores e clientes criados a partir dessa cadeia de conexão.
  • RetryPolicy - Nome da política de repetição.

Resumo do campo

Modificador e tipo Campo e descrição
static final Duration DefaultOperationTimeout

Tempo limite de operação padrão se o tempo limite não for especificado na cadeia de conexão.
static final String MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE

Valor da cadeia de conexão usado para o campo Autenticação, que indica que o Provedor de Tokende Identidade Gerenciada será usado para fins de autenticação.
static final String MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE

Resumo do Construtor

Construtor Description
ConnectionStringBuilder(String connectionString)

Cria uma nova instância da cadeia de conexão fornecida.
ConnectionStringBuilder(String namespaceConnectionString, String entityPath)

Cria uma nova instância da cadeia de conexão e do caminho da entidade fornecidos.
ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessSingature)

Cria uma nova instância do namespace, do caminho da entidade e do token SAS já gerado.
ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessKeyName, String sharedAccessKey)

Cria uma nova instância do namespace, do caminho da entidade e do nome e do valor da chave SAS.
ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessSingature)

Cria uma nova instância do endereço do ponto de extremidade do namesapce, do caminho da entidade e do token SAS já gerado.
ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessKeyName, String sharedAccessKey)

Cria uma nova instância do endereço do ponto de extremidade do nameapce, caminho da entidade e nome e valor da chave SAS

Resumo do método

Modificador e tipo Método e descrição
String getAuthentication()
URI getEndpoint()

Obter o ponto de extremidade que pode ser usado para se conectar ao Namespace do Barramento de Serviço
String getEntityPath()

Obter o valor do caminho da entidade da cadeia de conexão
Duration getOperationTimeout()

Obtém a duração após a qual uma operação pendente, como Enviar ou RECEBER, atingiu o tempo limite.
RetryPolicy getRetryPolicy()

Obtenha a instância de política de repetição que foi criada como parte da criação desse construtor.
String getSasKey()

Obtenha o valor da chave de política de acesso compartilhado da cadeia de conexão ou nulo.
String getSasKeyName()

Obtenha o nome do proprietário da política de acesso compartilhado da cadeia de conexão ou nulo.
String getSharedAccessSignatureToken()

Retorna o token de assinatura de acesso compartilhado da cadeia de conexão ou nulo.
TransportType getTransportType()

Tipo de transporteno qual toda a comunicação para o Barramento de Serviço foi criada usando essa Cadeia de Conexão.
void setOperationTimeout(Duration operationTimeout)

Defina o valor tempo limite da operaçãona cadeia de conexão.
void setRetryPolicy(RetryPolicy retryPolicy)

Defina a política de repetição.
ConnectionStringBuilder setTransportType(TransportType transportType)

Defina o valor tipo de transportena cadeia de conexão.
String toLoggableString()
String toString()

Retorna uma cadeia de conexão interoperável que pode ser usada para se conectar ao Namespace do Barramento de Serviço

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do campo

DefaultOperationTimeout

public static final Duration DefaultOperationTimeout

Tempo limite de operação padrão se o tempo limite não for especificado na cadeia de conexão. 30 segundos.

MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE

public static final String MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE

Valor da cadeia de conexão usado para o campo Autenticação, que indica que o Token de Identidade GerenciadaProvider será usado para fins de autenticação.

MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE

public static final String MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE

Detalhes do construtor

ConnectionStringBuilder

public ConnectionStringBuilder(String connectionString)

Cria uma nova instância da cadeia de conexão fornecida. Formato 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

Parâmetros:

connectionString - ServiceBus ConnectionString

ConnectionStringBuilder

public ConnectionStringBuilder(String namespaceConnectionString, String entityPath)

Cria uma nova instância da cadeia de conexão e do caminho da entidade fornecidos. Uma cadeia de conexão pode ou não incluir o caminho da entidade. Formato 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

Parâmetros:

namespaceConnectionString - cadeia de conexões do namespace ServiceBus. Isso não inclui o caminho da entidade.
entityPath - caminho para a entidade dentro do namespace

ConnectionStringBuilder

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

Cria uma nova instância do namespace, do caminho da entidade e do token SAS já gerado.

Parâmetros:

namespaceName - Nome do namespace (sufixo dns – ex: .servicebus.windows.net não é necessário)
entityPath - Caminho da entidade. Para fila ou tópico, use o nome. Para assinatura, use <topicName>/subscriptions/<subscriptionName>
sharedAccessSingature - Assinatura de Acesso Compartilhado já gerada

ConnectionStringBuilder

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

Cria uma nova instância do namespace, do caminho da entidade e do nome e do valor da chave SAS.

Parâmetros:

namespaceName - Nome do namespace (sufixo dns – ex: .servicebus.windows.net não é necessário)
entityPath - Caminho da entidade. Para fila ou tópico, use o nome. Para assinatura, use <topicName>/subscriptions/<subscriptionName>
sharedAccessKeyName - Nome da Chave de Acesso Compartilhado
sharedAccessKey - Chave de acesso compartilhada

ConnectionStringBuilder

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

Cria uma nova instância do endereço do ponto de extremidade do namesapce, do caminho da entidade e do token SAS já gerado.

Parâmetros:

endpointAddress - ponto de extremidade no nível do namespace. Isso precisa estar no formato de scheme://fullyQualifiedServiceBusNamespaceEndpointName
entityPath - Caminho da entidade. Para fila ou tópico, use o nome. Para assinatura, use <topicName>/subscriptions/<subscriptionName>
sharedAccessSingature - Assinatura de Acesso Compartilhado já gerada

ConnectionStringBuilder

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

Cria uma nova instância do endereço do ponto de extremidade do nameapce, caminho da entidade e nome e valor da chave SAS

Parâmetros:

endpointAddress - ponto de extremidade no nível do namespace. Isso precisa estar no formato de scheme://fullyQualifiedServiceBusNamespaceEndpointName
entityPath - Caminho da entidade. Para fila ou tópico, use o nome. Para assinatura, use <topicName>/subscriptions/<subscriptionName>
sharedAccessKeyName - Nome da Chave de Acesso Compartilhado
sharedAccessKey - Chave de acesso compartilhada

Detalhes do método

getAuthentication

public String getAuthentication()

Retornos:

Retorna o método de autenticação.

getEndpoint

public URI getEndpoint()

Obter o ponto de extremidade que pode ser usado para se conectar ao Namespace do ServiceBus

Retornos:

Ponto de extremidade que representa o namespace do barramento de serviço

getEntityPath

public String getEntityPath()

Obter o valor do caminho da entidade da cadeia de conexão

Retornos:

Caminho da Entidade

getOperationTimeout

public Duration getOperationTimeout()

Obtém a duração após a qual uma operação pendente, como Enviar ou RECEBER, atingiu o tempo limite. Se um tempo limite não for especificado, o padrão DefaultOperationTimeout será Esse valor será usado por todas as operações que usam esse ConnectionStringBuilder, a menos que explicitamente sobrecarregado.

Retornos:

operationTimeout

getRetryPolicy

public RetryPolicy getRetryPolicy()

Obtenha a instância de política de repetição que foi criada como parte da criação desse construtor.

Retornos:

RetryPolicy aplicada a qualquer operação executada usando esta ConnectionString

getSasKey

public String getSasKey()

Obtenha o valor da chave de política de acesso compartilhado da cadeia de conexão ou nulo.

Retornos:

Valor da chave de Assinatura de Acesso Compartilhado

getSasKeyName

public String getSasKeyName()

Obtenha o nome do proprietário da política de acesso compartilhado da cadeia de conexão ou nulo.

Retornos:

Nome da chave de Assinatura de Acesso Compartilhado

getSharedAccessSignatureToken

public String getSharedAccessSignatureToken()

Retorna o token de assinatura de acesso compartilhado da cadeia de conexão ou nulo.

Retornos:

Token de Assinatura de Acesso Compartilhado

getTransportType

public TransportType getTransportType()

TransportType no qual toda a comunicação para o Barramento de Serviço foi criada usando esta ConnectionString. O valor padrão é AMQP.

Retornos:

transportType

setOperationTimeout

public void setOperationTimeout(Duration operationTimeout)

Defina o valor OperationTimeout na Cadeia de Conexão. Esse valor será usado por todas as operações que usam esse ConnectionStringBuilder, a menos que seja explicitamente sobrecarregado.

ConnectionString com operationTimeout não é interoperável entre java e clientes em outras plataformas.

Parâmetros:

operationTimeout - Tempo limite da operação

setRetryPolicy

public void setRetryPolicy(RetryPolicy retryPolicy)

Defina a política de repetição.

RetryPolicy não é serializado como parte do toString() e não é interoperável com clientes ServiceBus em outras plataformas.

Parâmetros:

retryPolicy - RetryPolicy aplicada a qualquer operação executada usando esta ConnectionString

setTransportType

public ConnectionStringBuilder setTransportType(TransportType transportType)

Defina o valor TransportType na Cadeia de Conexão. Se nenhum TransportType estiver definido, o padrão AMQPserá .

Parâmetros:

transportType - Tipo de transporte

Retornos:

a ConnectionStringBuilder instância que está sendo definida.

toLoggableString

public String toLoggableString()

toString

public String toString()

Retorna uma cadeia de conexão interoperável que pode ser usada para se conectar ao Namespace do ServiceBus

Substituições:

ConnectionStringBuilder.toString()

Retornos:

cadeia de conexão

Aplica-se a