ManagementClientAsync Class

  • Reference
Package:
com.microsoft.azure.servicebus.management
Maven Artifact:
com.microsoft.azure:azure-servicebus:3.6.7
  • java.lang.Object
    • com.microsoft.azure.servicebus.management.ManagementClientAsync

public class ManagementClientAsync

Asynchronous client to perform management operations on Service Bus entities. Operations return CompletableFuture which asynchronously return the responses.

Constructor Summary

Constructor Description
ManagementClientAsync(ConnectionStringBuilder connectionStringBuilder)

Creates a new ManagementClientAsync.
ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)

Creates a new ManagementClientAsync.

Method Summary

Modifier and Type Method and Description
void close()

Disposes and closes the managementClient.
CompletableFuture<QueueDescription> createQueueAsync(QueueDescription queueDescription)

Creates a new queue in the service namespace with the given name.
CompletableFuture<QueueDescription> createQueueAsync(String queuePath)

Creates a new queue in the service namespace with the given name.
CompletableFuture<RuleDescription> createRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)

Creates a new rule for a given topic - subscription.
CompletableFuture<SubscriptionDescription> createSubscriptionAsync(SubscriptionDescription subscriptionDescription)

Creates a new subscription in the service namespace with the given name.
CompletableFuture<SubscriptionDescription> createSubscriptionAsync(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)

Creates a new subscription in the service namespace with the provided default rule.
CompletableFuture<SubscriptionDescription> createSubscriptionAsync(String topicPath, String subscriptionName)

Creates a new subscription for a given topic in the service namespace with the given name.
CompletableFuture<TopicDescription> createTopicAsync(TopicDescription topicDescription)

Creates a new topic in the service namespace with the given name.
CompletableFuture<TopicDescription> createTopicAsync(String topicPath)

Creates a new topic in the service namespace with the given name.
CompletableFuture<Void> deleteQueueAsync(String path)

Deletes the queue described by the path relative to the service namespace base address.
CompletableFuture<Void> deleteRuleAsync(String topicPath, String subscriptionName, String ruleName)

Deletes the rule for a given topic-subscription.
CompletableFuture<Void> deleteSubscriptionAsync(String topicPath, String subscriptionName)

Deletes the subscription described by the topicPath and the subscriptionName.
CompletableFuture<Void> deleteTopicAsync(String path)

Deletes the topic described by the path relative to the service namespace base address.
CompletableFuture<NamespaceInfo> getNamespaceInfoAsync()

Retrieves information related to the namespace.
CompletableFuture<QueueDescription> getQueueAsync(String path)

Retrieves a queue from the service namespace
CompletableFuture<QueueRuntimeInfo> getQueueRuntimeInfoAsync(String path)

Retrieves the runtime information of a queue.
CompletableFuture<List<QueueDescription>> getQueuesAsync()

Retrieves the list of queues present in the namespace.
CompletableFuture<List<QueueDescription>> getQueuesAsync(int count, int skip)

Retrieves the list of queues present in the namespace.
CompletableFuture<RuleDescription> getRuleAsync(String topicPath, String subscriptionName, String ruleName)

Retrieves a rule for a given topic and subscription from the service namespace
CompletableFuture<List<RuleDescription>> getRulesAsync(String topicName, String subscriptionName)

Retrieves the list of rules for a given topic-subscription in the namespace.
CompletableFuture<List<RuleDescription>> getRulesAsync(String topicName, String subscriptionName, int count, int skip)

Retrieves the list of rules for a given topic-subscription in the namespace.
CompletableFuture<SubscriptionDescription> getSubscriptionAsync(String topicPath, String subscriptionName)

Retrieves a subscription for a given topic from the service namespace
CompletableFuture<SubscriptionRuntimeInfo> getSubscriptionRuntimeInfoAsync(String topicPath, String subscriptionName)

Retrieves the runtime information of a subscription in a given topic
CompletableFuture<List<SubscriptionDescription>> getSubscriptionsAsync(String topicName)

Retrieves the list of subscriptions for a given topic in the namespace.
CompletableFuture<List<SubscriptionDescription>> getSubscriptionsAsync(String topicName, int count, int skip)

Retrieves the list of subscriptions for a given topic in the namespace.
CompletableFuture<TopicDescription> getTopicAsync(String path)

Retrieves a topic from the service namespace
CompletableFuture<TopicRuntimeInfo> getTopicRuntimeInfoAsync(String path)

Retrieves the runtime information of a topic
CompletableFuture<List<TopicDescription>> getTopicsAsync()

Retrieves the list of topics present in the namespace.
CompletableFuture<List<TopicDescription>> getTopicsAsync(int count, int skip)

Retrieves the list of topics present in the namespace.
CompletableFuture<Boolean> queueExistsAsync(String path)

Checks whether a given queue exists or not.
CompletableFuture<Boolean> ruleExistsAsync(String topicPath, String subscriptionName, String ruleName)

Checks whether a given rule exists or not for a given subscription.
CompletableFuture<Boolean> subscriptionExistsAsync(String topicPath, String subscriptionName)

Checks whether a given subscription exists or not.
CompletableFuture<Boolean> topicExistsAsync(String path)

Checks whether a given topic exists or not.
CompletableFuture<QueueDescription> updateQueueAsync(QueueDescription queueDescription)

Updates an existing queue.
CompletableFuture<RuleDescription> updateRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)

Updates an existing rule.
CompletableFuture<SubscriptionDescription> updateSubscriptionAsync(SubscriptionDescription subscriptionDescription)

Updates an existing subscription.
CompletableFuture<TopicDescription> updateTopicAsync(TopicDescription topicDescription)

Updates an existing topic.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ManagementClientAsync

public ManagementClientAsync(ConnectionStringBuilder connectionStringBuilder)

Creates a new ManagementClientAsync. User should call close() at the end of life of the client.

Parameters:

connectionStringBuilder -
  • connectionStringBuilder containing namespace information and client settings.

ManagementClientAsync

public ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)

Creates a new ManagementClientAsync. User should call close() at the end of life of the client.

Parameters:

namespaceEndpointURI -
  • URI of the namespace connecting to.
clientSettings -
  • client settings.

Method Details

close

public void close()

Disposes and closes the managementClient.

Throws:

IOException

 - if an I/O error occurs

createQueueAsync

public CompletableFuture createQueueAsync(QueueDescription queueDescription)

Creates a new queue in the service namespace with the given name. See QueueDescription for default values of queue properties.

Parameters:

queueDescription -
  • A QueueDescription object describing the attributes with which the new queue will be created.

Returns:

QueueDescription of the newly created queue.

createQueueAsync

public CompletableFuture createQueueAsync(String queuePath)

Creates a new queue in the service namespace with the given name. See QueueDescription for default values of queue properties.

Parameters:

queuePath -
  • The name of the queue relative to the service namespace base address.

Returns:

QueueDescription of the newly created queue.

createRuleAsync

public CompletableFuture createRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)

Creates a new rule for a given topic - subscription. See RuleDescription for default values of subscription properties.

Parameters:

topicName -
  • Name of the topic.
subscriptionName -
  • Name of the subscription.
ruleDescription -
  • A RuleDescription object describing the attributes with which the new rule will be created.

Returns:

RuleDescription of the newly created rule.

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(SubscriptionDescription subscriptionDescription)

Creates a new subscription in the service namespace with the given name. See SubscriptionDescription for default values of subscription properties.

Parameters:

subscriptionDescription -

Returns:

SubscriptionDescription of the newly created subscription.

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)

Creates a new subscription in the service namespace with the provided default rule. See SubscriptionDescription for default values of subscription properties.

Parameters:

subscriptionDescription -
defaultRule -
  • A RuleDescription object describing the default rule. If null, then pass-through filter will be created.

Returns:

SubscriptionDescription of the newly created subscription.

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(String topicPath, String subscriptionName)

Creates a new subscription for a given topic in the service namespace with the given name. See SubscriptionDescription for default values of subscription properties.

Parameters:

topicPath -
  • The name of the topic relative to the service namespace base address.
subscriptionName -
  • The name of the subscription.

Returns:

SubscriptionDescription of the newly created subscription.

createTopicAsync

public CompletableFuture createTopicAsync(TopicDescription topicDescription)

Creates a new topic in the service namespace with the given name. See TopicDescription for default values of topic properties.

Parameters:

topicDescription -
  • A QueueDescription object describing the attributes with which the new topic will be created.

Returns:

TopicDescription of the newly created topic.

createTopicAsync

public CompletableFuture createTopicAsync(String topicPath)

Creates a new topic in the service namespace with the given name. See TopicDescription for default values of topic properties.

Parameters:

topicPath -
  • The name of the topic relative to the service namespace base address.

Returns:

TopicDescription of the newly created topic.

deleteQueueAsync

public CompletableFuture deleteQueueAsync(String path)

Deletes the queue described by the path relative to the service namespace base address.

Parameters:

path -
  • The name of the entity relative to the service namespace base address.

Returns:

A completable future that completes when the queue is deleted.

deleteRuleAsync

public CompletableFuture deleteRuleAsync(String topicPath, String subscriptionName, String ruleName)

Deletes the rule for a given topic-subscription.

Parameters:

topicPath -
  • The name of the topic.
subscriptionName -
  • The name of the subscription.
ruleName -
  • The name of the rule.

Returns:

A completable future that completes when the rule is deleted.

deleteSubscriptionAsync

public CompletableFuture deleteSubscriptionAsync(String topicPath, String subscriptionName)

Deletes the subscription described by the topicPath and the subscriptionName.

Parameters:

topicPath -
  • The name of the topic.
subscriptionName -
  • The name of the subscription.

Returns:

A completable future that completes when the subscription is deleted.

deleteTopicAsync

public CompletableFuture deleteTopicAsync(String path)

Deletes the topic described by the path relative to the service namespace base address.

Parameters:

path -
  • The name of the entity relative to the service namespace base address.

Returns:

A completable future that completes when the topic is deleted.

getNamespaceInfoAsync

public CompletableFuture getNamespaceInfoAsync()

Retrieves information related to the namespace. Works with any claim (Send/Listen/Manage).

Returns:

getQueueAsync

public CompletableFuture getQueueAsync(String path)

Retrieves a queue from the service namespace

Parameters:

path -
  • The path of the queue relative to service bus namespace.

Returns:

  • QueueDescription containing information about the queue.

getQueueRuntimeInfoAsync

public CompletableFuture getQueueRuntimeInfoAsync(String path)

Retrieves the runtime information of a queue.

Parameters:

path -
  • The path of the queue relative to service bus namespace.

Returns:

  • QueueRuntimeInfo containing runtime information about the queue.

getQueuesAsync

public CompletableFuture<>> getQueuesAsync()

Retrieves the list of queues present in the namespace.

Returns:

the first 100 queues.

getQueuesAsync

public CompletableFuture<>> getQueuesAsync(int count, int skip)

Retrieves the list of queues present in the namespace. You can simulate pages of list of entities by manipulating count and skip parameters. skip(0)+count(100) gives first 100 entities. skip(100)+count(100) gives the next 100 entities.

Parameters:

count -
  • The number of queues to fetch. Defaults to 100. Maximum value allowed is 100.
skip -
  • The number of queues to skip. Defaults to 0. Cannot be negative.

Returns:

the list of queues.

getRuleAsync

public CompletableFuture getRuleAsync(String topicPath, String subscriptionName, String ruleName)

Retrieves a rule for a given topic and subscription from the service namespace

Parameters:

topicPath -
  • The path of the topic relative to service bus namespace.
subscriptionName -
  • The name of the subscription.
ruleName -
  • The name of the rule.

Returns:

  • RuleDescription containing information about the subscription.

getRulesAsync

public CompletableFuture<>> getRulesAsync(String topicName, String subscriptionName)

Retrieves the list of rules for a given topic-subscription in the namespace.

Parameters:

topicName -
  • The name of the topic.
subscriptionName -
  • The name of the subscription.

Returns:

the first 100 rules.

getRulesAsync

public CompletableFuture<>> getRulesAsync(String topicName, String subscriptionName, int count, int skip)

Retrieves the list of rules for a given topic-subscription in the namespace. You can simulate pages of list of entities by manipulating count and skip parameters. skip(0)+count(100) gives first 100 entities. skip(100)+count(100) gives the next 100 entities.

Parameters:

topicName -
  • The name of the topic.
subscriptionName -
  • The name of the subscription.
count -
  • The number of rules to fetch. Defaults to 100. Maximum value allowed is 100.
skip -
  • The number of rules to skip. Defaults to 0. Cannot be negative.

Returns:

the list of rules.

getSubscriptionAsync

public CompletableFuture getSubscriptionAsync(String topicPath, String subscriptionName)

Retrieves a subscription for a given topic from the service namespace

Parameters:

topicPath -
  • The path of the topic relative to service bus namespace.
subscriptionName -
  • The name of the subscription

Returns:

  • SubscriptionDescription containing information about the subscription.

getSubscriptionRuntimeInfoAsync

public CompletableFuture getSubscriptionRuntimeInfoAsync(String topicPath, String subscriptionName)

Retrieves the runtime information of a subscription in a given topic

Parameters:

topicPath -
  • The path of the topic relative to service bus namespace.
subscriptionName -
  • The name of the subscription

Returns:

  • SubscriptionRuntimeInfo containing the runtime information about the subscription.

getSubscriptionsAsync

public CompletableFuture<>> getSubscriptionsAsync(String topicName)

Retrieves the list of subscriptions for a given topic in the namespace.

Parameters:

topicName -
  • The name of the topic.

Returns:

the first 100 subscriptions.

getSubscriptionsAsync

public CompletableFuture<>> getSubscriptionsAsync(String topicName, int count, int skip)

Retrieves the list of subscriptions for a given topic in the namespace. You can simulate pages of list of entities by manipulating count and skip parameters. skip(0)+count(100) gives first 100 entities. skip(100)+count(100) gives the next 100 entities.

Parameters:

topicName -
  • The name of the topic.
count -
  • The number of subscriptions to fetch. Defaults to 100. Maximum value allowed is 100.
skip -
  • The number of subscriptions to skip. Defaults to 0. Cannot be negative.

Returns:

the list of subscriptions.

getTopicAsync

public CompletableFuture getTopicAsync(String path)

Retrieves a topic from the service namespace

Parameters:

path -
  • The path of the queue relative to service bus namespace.

Returns:

  • Description containing information about the topic.

getTopicRuntimeInfoAsync

public CompletableFuture getTopicRuntimeInfoAsync(String path)

Retrieves the runtime information of a topic

Parameters:

path -
  • The path of the queue relative to service bus namespace.

Returns:

  • TopicRuntimeInfo containing runtime information about the topic.

getTopicsAsync

public CompletableFuture<>> getTopicsAsync()

Retrieves the list of topics present in the namespace.

Returns:

the first 100 topics.

getTopicsAsync

public CompletableFuture<>> getTopicsAsync(int count, int skip)

Retrieves the list of topics present in the namespace. You can simulate pages of list of entities by manipulating count and skip parameters. skip(0)+count(100) gives first 100 entities. skip(100)+count(100) gives the next 100 entities.

Parameters:

count -
  • The number of topics to fetch. Defaults to 100. Maximum value allowed is 100.
skip -
  • The number of topics to skip. Defaults to 0. Cannot be negative.

Returns:

the list of topics.

queueExistsAsync

public CompletableFuture queueExistsAsync(String path)

Checks whether a given queue exists or not.

Parameters:

path -
  • Path of the entity to check

Returns:

  • True if the entity exists. False otherwise.

ruleExistsAsync

public CompletableFuture ruleExistsAsync(String topicPath, String subscriptionName, String ruleName)

Checks whether a given rule exists or not for a given subscription.

Parameters:

topicPath -
  • Path of the topic
subscriptionName -
  • Name of the subscription.
ruleName -
  • Name of the rule

Returns:

  • True if the entity exists. False otherwise.

subscriptionExistsAsync

public CompletableFuture subscriptionExistsAsync(String topicPath, String subscriptionName)

Checks whether a given subscription exists or not.

Parameters:

topicPath -
  • Path of the topic
subscriptionName -
  • Name of the subscription.

Returns:

  • True if the entity exists. False otherwise.

topicExistsAsync

public CompletableFuture topicExistsAsync(String path)

Checks whether a given topic exists or not.

Parameters:

path -
  • Path of the entity to check

Returns:

  • True if the entity exists. False otherwise.

updateQueueAsync

public CompletableFuture updateQueueAsync(QueueDescription queueDescription)

Updates an existing queue.

Parameters:

queueDescription -
  • A QueueDescription object describing the attributes with which the queue will be updated.

Returns:

QueueDescription of the updated queue.

updateRuleAsync

public CompletableFuture updateRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)

Updates an existing rule.

Parameters:

topicName -
  • Name of the topic.
subscriptionName -
  • Name of the subscription.
ruleDescription -
  • A RuleDescription object describing the attributes with which the rule will be updated.

Returns:

RuleDescription of the updated rule.

updateSubscriptionAsync

public CompletableFuture updateSubscriptionAsync(SubscriptionDescription subscriptionDescription)

Updates an existing subscription.

Parameters:

subscriptionDescription -

Returns:

SubscriptionDescription of the updated subscription.

updateTopicAsync

public CompletableFuture updateTopicAsync(TopicDescription topicDescription)

Updates an existing topic.

Parameters:

topicDescription -
  • A TopicDescription object describing the attributes with which the topic will be updated.

Returns:

TopicDescription of the updated topic.

Applies to