Share via

ManagementClient 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.ManagementClient

public class ManagementClient

Synchronous client to perform management operations on Service Bus entities. Use ManagementClientAsync for asynchronous operations.

Constructor Summary

Constructor Description
ManagementClient(ConnectionStringBuilder connectionStringBuilder)
ManagementClient(URI namespaceEndpointURI, ClientSettings clientSettings)

Method Summary

Modifier and Type Method and Description
void close()

Disposes and closes the managementClient.
QueueDescription createQueue(QueueDescription queueDescription)

Creates a new queue in the service namespace with the given name.
QueueDescription createQueue(String queuePath)

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

Creates a new rule for a given topic - subscription.
SubscriptionDescription createSubscription(SubscriptionDescription subscriptionDescription)

Creates a new subscription in the service namespace with the given name.
SubscriptionDescription createSubscription(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)

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

Creates a new subscription for a given topic in the service namespace with the given name.
TopicDescription createTopic(TopicDescription topicDescription)

Creates a new topic in the service namespace with the given name.
TopicDescription createTopic(String topicPath)

Creates a new topic in the service namespace with the given name.
Void deleteQueue(String path)

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

Deletes the rule for a given topic-subscription.
Void deleteSubscription(String topicPath, String subscriptionName)

Deletes the subscription described by the topicPath and the subscriptionName.
Void deleteTopic(String path)

Deletes the topic described by the path relative to the service namespace base address.
NamespaceInfo getNamespaceInfo()

Retrieves information related to the namespace.
QueueDescription getQueue(String path)

Retrieves a queue from the service namespace
QueueRuntimeInfo getQueueRuntimeInfo(String path)

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

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

Retrieves the list of queues present in the namespace.
RuleDescription getRule(String topicPath, String subscriptionName, String ruleName)

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

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

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

Retrieves a subscription for a given topic from the service namespace
SubscriptionRuntimeInfo getSubscriptionRuntimeInfo(String topicPath, String subscriptionName)

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

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

Retrieves the list of subscriptions for a given topic in the namespace.
TopicDescription getTopic(String path)

Retrieves a topic from the service namespace
TopicRuntimeInfo getTopicRuntimeInfo(String path)

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

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

Retrieves the list of topics present in the namespace.
Boolean queueExists(String path)

Checks whether a given queue exists or not.
Boolean ruleExists(String topicPath, String subscriptionName, String ruleName)

Checks whether a given rule exists or not for a given subscription.
Boolean subscriptionExists(String topicPath, String subscriptionName)

Checks whether a given subscription exists or not.
Boolean topicExists(String path)

Checks whether a given topic exists or not.
QueueDescription updateQueue(QueueDescription queueDescription)

Updates an existing queue.
RuleDescription updateRule(String topicName, String subscriptionName, RuleDescription ruleDescription)

Updates an existing rule.
SubscriptionDescription updateSubscription(SubscriptionDescription subscriptionDescription)

Updates an existing subscription.
TopicDescription updateTopic(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

ManagementClient

public ManagementClient(ConnectionStringBuilder connectionStringBuilder)

Parameters:

connectionStringBuilder

ManagementClient

public ManagementClient(URI namespaceEndpointURI, ClientSettings clientSettings)

Parameters:

namespaceEndpointURI
clientSettings

Method Details

close

public void close()

Disposes and closes the managementClient.

Throws:

IOException

 - if an I/O error occurs

createQueue

public QueueDescription createQueue(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.

Throws:

ServiceBusException -
  • An entity with the same name exists under the same service namespace.

InterruptedException

 -
  • An entity with the same name exists under the same service namespace.

createQueue

public QueueDescription createQueue(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.

Throws:

ServiceBusException -
  • Entity name is null, empty, too long or uses illegal characters.

InterruptedException

 -
  • Entity name is null, empty, too long or uses illegal characters.

createRule

public RuleDescription createRule(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.

Throws:

ServiceBusException -
  • An entity with the same name exists under the same service namespace.

InterruptedException

 -
  • An entity with the same name exists under the same service namespace.

createSubscription

public SubscriptionDescription createSubscription(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.

Throws:

ServiceBusException -
  • An entity with the same name exists under the same service namespace.

InterruptedException

 -
  • An entity with the same name exists under the same service namespace.

createSubscription

public SubscriptionDescription createSubscription(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.

Throws:

ServiceBusException -
  • An entity with the same name exists under the same service namespace.

InterruptedException

 -
  • An entity with the same name exists under the same service namespace.

createSubscription

public SubscriptionDescription createSubscription(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.

Throws:

ServiceBusException -
  • Entity name is null, empty, too long or uses illegal characters.

InterruptedException

 -
  • Entity name is null, empty, too long or uses illegal characters.

createTopic

public TopicDescription createTopic(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.

Throws:

ServiceBusException -
  • An entity with the same name exists under the same service namespace.

InterruptedException

 -
  • An entity with the same name exists under the same service namespace.

createTopic

public TopicDescription createTopic(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.

Throws:

ServiceBusException -
  • Entity name is null, empty, too long or uses illegal characters.

InterruptedException

 -
  • Entity name is null, empty, too long or uses illegal characters.

deleteQueue

public Void deleteQueue(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.

Throws:

ServiceBusException -
  • path is not null / empty / too long / invalid.

InterruptedException

 -
  • path is not null / empty / too long / invalid.

deleteRule

public Void deleteRule(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.

Throws:

ServiceBusException -
  • path is not null / empty / too long / invalid.

InterruptedException

 -
  • path is not null / empty / too long / invalid.

deleteSubscription

public Void deleteSubscription(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.

Throws:

ServiceBusException -
  • path is not null / empty / too long / invalid.

InterruptedException

 -
  • path is not null / empty / too long / invalid.

deleteTopic

public Void deleteTopic(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.

Throws:

ServiceBusException -
  • path is not null / empty / too long / invalid.

InterruptedException

 -
  • path is not null / empty / too long / invalid.

getNamespaceInfo

public NamespaceInfo getNamespaceInfo()

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

Returns:

Throws:

ServiceBusException -
  • An internal error or an unexpected exception occurred.

InterruptedException

 -
  • An internal error or an unexpected exception occurred.

getQueue

public QueueDescription getQueue(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.

Throws:

ServiceBusException -
  • Thrown if path is null, empty, or not in right format or length.

InterruptedException

 -
  • Thrown if path is null, empty, or not in right format or length.

getQueueRuntimeInfo

public QueueRuntimeInfo getQueueRuntimeInfo(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.

Throws:

ServiceBusException -
  • Thrown if path is null, empty, or not in right format or length.

InterruptedException

 -
  • Thrown if path is null, empty, or not in right format or length.

getQueues

public List getQueues()

Retrieves the list of queues present in the namespace.

Returns:

the first 100 queues.

Throws:

ServiceBusException -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

InterruptedException

 -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

getQueues

public List getQueues(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.

Throws:

ServiceBusException -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

InterruptedException

 -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

getRule

public RuleDescription getRule(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.

Throws:

ServiceBusException -
  • Thrown if path is null, empty, or not in right format or length.

InterruptedException

 -
  • Thrown if path is null, empty, or not in right format or length.

getRules

public List getRules(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.

Throws:

ServiceBusException -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

InterruptedException

 -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

getRules

public List getRules(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.

Throws:

ServiceBusException -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

InterruptedException

 -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

getSubscription

public SubscriptionDescription getSubscription(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.

Throws:

ServiceBusException -
  • Thrown if path is null, empty, or not in right format or length.

InterruptedException

 -
  • Thrown if path is null, empty, or not in right format or length.

getSubscriptionRuntimeInfo

public SubscriptionRuntimeInfo getSubscriptionRuntimeInfo(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.

Throws:

ServiceBusException -
  • Thrown if path is null, empty, or not in right format or length.

InterruptedException

 -
  • Thrown if path is null, empty, or not in right format or length.

getSubscriptions

public List getSubscriptions(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.

Throws:

ServiceBusException -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

InterruptedException

 -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

getSubscriptions

public List getSubscriptions(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.

Throws:

ServiceBusException -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

InterruptedException

 -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

getTopic

public TopicDescription getTopic(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.

Throws:

ServiceBusException -
  • Thrown if path is null, empty, or not in right format or length.

InterruptedException

 -
  • Thrown if path is null, empty, or not in right format or length.

getTopicRuntimeInfo

public TopicRuntimeInfo getTopicRuntimeInfo(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.

Throws:

ServiceBusException -
  • Thrown if path is null, empty, or not in right format or length.

InterruptedException

 -
  • Thrown if path is null, empty, or not in right format or length.

getTopics

public List getTopics()

Retrieves the list of topics present in the namespace.

Returns:

the first 100 topics.

Throws:

ServiceBusException -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

InterruptedException

 -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

getTopics

public List getTopics(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.

Throws:

ServiceBusException -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

InterruptedException

 -
  • The operation times out. The timeout period is initiated through ClientSettings.operationTimeout

queueExists

public Boolean queueExists(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.

Throws:

ServiceBusException -
  • path is not null / empty / too long / invalid.

InterruptedException

 -
  • path is not null / empty / too long / invalid.

ruleExists

public Boolean ruleExists(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.

Throws:

ServiceBusException -
  • path is not null / empty / too long / invalid.

InterruptedException

 -
  • path is not null / empty / too long / invalid.

subscriptionExists

public Boolean subscriptionExists(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.

Throws:

ServiceBusException -
  • path is not null / empty / too long / invalid.

InterruptedException

 -
  • path is not null / empty / too long / invalid.

topicExists

public Boolean topicExists(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.

Throws:

ServiceBusException -
  • path is not null / empty / too long / invalid.

InterruptedException

 -
  • path is not null / empty / too long / invalid.

updateQueue

public QueueDescription updateQueue(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.

Throws:

ServiceBusException -
  • Described entity was not found.

InterruptedException

 -
  • Described entity was not found.

updateRule

public RuleDescription updateRule(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.

Throws:

ServiceBusException -
  • Described entity was not found.

InterruptedException

 -
  • Described entity was not found.

updateSubscription

public SubscriptionDescription updateSubscription(SubscriptionDescription subscriptionDescription)

Updates an existing subscription.

Parameters:

subscriptionDescription -

Returns:

SubscriptionDescription of the updated subscription.

Throws:

ServiceBusException -
  • Described entity was not found.

InterruptedException

 -
  • Described entity was not found.

updateTopic

public TopicDescription updateTopic(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.

Throws:

ServiceBusException -
  • Described entity was not found.

InterruptedException

 -
  • Described entity was not found.

Applies to