ServiceBusContract (Microsoft Azure SDK for Service Bus 0.7.0 API)

All Superinterfaces:

com.microsoft.windowsazure.core.FilterableService<ServiceBusContract>, com.microsoft.windowsazure.core.pipeline.jersey.JerseyFilterableService<ServiceBusContract>
```
public interface ServiceBusContract
extends com.microsoft.windowsazure.core.pipeline.jersey.JerseyFilterableService<ServiceBusContract>
```
Defines the service bus contract.

Method Summary

Methods
Modifier and Type	Method and Description
`CreateQueueResult`	`createQueue(QueueInfo queueInfo)` Creates a queue.
`CreateRuleResult`	`createRule(String topicPath, String subscriptionName, RuleInfo rule)` Creates a rule.
`CreateSubscriptionResult`	`createSubscription(String topicPath, SubscriptionInfo subscription)` Creates a subscription.
`CreateTopicResult`	`createTopic(TopicInfo topic)` Creates a topic.
`void`	`deleteMessage(BrokeredMessage message)` Deletes a message.
`void`	`deleteQueue(String queuePath)` Deletes a queue.
`void`	`deleteRule(String topicPath, String subscriptionName, String ruleName)` Deletes a rule.
`void`	`deleteSubscription(String topicPath, String subscriptionName)` Deletes a subscription.
`void`	`deleteTopic(String topicPath)` Deletes a topic.
`GetQueueResult`	`getQueue(String queuePath)` Retrieves a queue.
`GetRuleResult`	`getRule(String topicPath, String subscriptionName, String ruleName)` Retrieves a rule.
`GetSubscriptionResult`	`getSubscription(String topicPath, String subscriptionName)` Retrieves a subscription.
`GetTopicResult`	`getTopic(String topicPath)` Retrieves a topic.
`ListQueuesResult`	`listQueues()` Returns a list of queues.
`ListQueuesResult`	`listQueues(ListQueuesOptions options)` Returns a list of queues.
`ListRulesResult`	`listRules(String topicPath, String subscriptionName)` Returns a list of rules.
`ListRulesResult`	`listRules(String topicPath, String subscriptionName, ListRulesOptions options)` Returns a list of rules.
`ListSubscriptionsResult`	`listSubscriptions(String topicPath)` Returns a list of subscriptions.
`ListSubscriptionsResult`	`listSubscriptions(String topicPath, ListSubscriptionsOptions options)` Returns a list of subscriptions.
`ListTopicsResult`	`listTopics()` Returns a list of topics.
`ListTopicsResult`	`listTopics(ListTopicsOptions options)` Returns a list of topics.
`ReceiveMessageResult`	`receiveMessage(String path)` Receives a message.
`ReceiveMessageResult`	`receiveMessage(String path, ReceiveMessageOptions options)` Receives a message using the specified receive message options.
`ReceiveQueueMessageResult`	`receiveQueueMessage(String queuePath)` Receives a queue message.
`ReceiveQueueMessageResult`	`receiveQueueMessage(String queuePath, ReceiveMessageOptions options)` Receives a queue message using the specified receive message options.
`ReceiveSubscriptionMessageResult`	`receiveSubscriptionMessage(String topicPath, String subscriptionName)` Receives a subscription message.
`ReceiveSubscriptionMessageResult`	`receiveSubscriptionMessage(String topicPath, String subscriptionName, ReceiveMessageOptions options)` Receives a subscription message using the specified receive message options.
`void`	`renewQueueLock(String queueName, String messageId, String lockToken)` Renew queue lock.
`void`	`renewSubscriptionLock(String topicName, String subscriptionName, String messageId, String lockToken)` Renew subscription lock.
`void`	`sendMessage(String path, BrokeredMessage message)` Sends a message.
`void`	`sendQueueMessage(String queuePath, BrokeredMessage message)` Sends a queue message.
`void`	`sendTopicMessage(String topicPath, BrokeredMessage message)` Sends a topic message.
`void`	`unlockMessage(BrokeredMessage message)` Unlocks a message.
`QueueInfo`	`updateQueue(QueueInfo queueInfo)` Updates the information of a queue.
`SubscriptionInfo`	`updateSubscription(String topicName, SubscriptionInfo subscriptionInfo)` Updates a subscription.
`TopicInfo`	`updateTopic(TopicInfo topicInfo)` Updates a topic.

Methods inherited from interface com.microsoft.windowsazure.core.pipeline.jersey.JerseyFilterableService
withFilter

Methods inherited from interface com.microsoft.windowsazure.core.FilterableService
withRequestFilterFirst, withRequestFilterLast, withResponseFilterFirst, withResponseFilterLast

- Method Detail
  - sendQueueMessage
```
void sendQueueMessage(String queuePath,
                    BrokeredMessage message)
                      throws com.microsoft.windowsazure.exception.ServiceException
```
    Sends a queue message.
    
    Parameters:
    queuePath - A String object that represents the name of the queue to which the message will be sent.
    message - A Message object that represents the message to send.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - receiveQueueMessage
```
ReceiveQueueMessageResult receiveQueueMessage(String queuePath)
                                              throws com.microsoft.windowsazure.exception.ServiceException
```
    Receives a queue message.
    
    Parameters:
    queuePath - A String object that represents the name of the queue from which to receive the message.
    
    Returns:
    A ReceiveQueueMessageResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - receiveQueueMessage
```
ReceiveQueueMessageResult receiveQueueMessage(String queuePath,
                                            ReceiveMessageOptions options)
                                              throws com.microsoft.windowsazure.exception.ServiceException
```
    Receives a queue message using the specified receive message options.
    
    Parameters:
    queuePath - A String object that represents the name of the queue from which to receive the message.
    options - A ReceiveMessageOptions object that represents the receive message options.
    
    Returns:
    A ReceiveQueueMessageResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - sendTopicMessage
```
void sendTopicMessage(String topicPath,
                    BrokeredMessage message)
                      throws com.microsoft.windowsazure.exception.ServiceException
```
    Sends a topic message.
    
    Parameters:
    topicPath - A String object that represents the name of the topic to which the message will be sent.
    message - A Message object that represents the message to send.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - receiveSubscriptionMessage
```
ReceiveSubscriptionMessageResult receiveSubscriptionMessage(String topicPath,
                                                          String subscriptionName)
                                                            throws com.microsoft.windowsazure.exception.ServiceException
```
    Receives a subscription message.
    
    Parameters:
    topicPath - A String object that represents the name of the topic to receive.
    subscriptionName - A String object that represents the name of the subscription from the message will be received.
    
    Returns:
    A ReceiveSubscriptionMessageResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - receiveSubscriptionMessage
```
ReceiveSubscriptionMessageResult receiveSubscriptionMessage(String topicPath,
                                                          String subscriptionName,
                                                          ReceiveMessageOptions options)
                                                            throws com.microsoft.windowsazure.exception.ServiceException
```
    Receives a subscription message using the specified receive message options.
    
    Parameters:
    topicPath - A String object that represents the name of the topic to receive.
    subscriptionName - A String object that represents the name of the subscription from the message will be received.
    options - A ReceiveMessageOptions object that represents the receive message options.
    
    Returns:
    A ReceiveSubscriptionMessageResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - unlockMessage
```
void unlockMessage(BrokeredMessage message)
                   throws com.microsoft.windowsazure.exception.ServiceException
```
    Unlocks a message.
    
    Parameters:
    message - A Message object that represents the message to unlock.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - sendMessage
```
void sendMessage(String path,
               BrokeredMessage message)
                 throws com.microsoft.windowsazure.exception.ServiceException
```
    Sends a message.
    
    Parameters:
    path - A String object that represents the path to which the message will be sent. This may be the value of a queuePath or a topicPath.
    message - A Message object that represents the message to send.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - receiveMessage
```
ReceiveMessageResult receiveMessage(String path)
                                    throws com.microsoft.windowsazure.exception.ServiceException
```
    Receives a message.
    
    Parameters:
    path - A String object that represents the path from which a message will be received. This may either be the value of queuePath or a combination of the topicPath + "/subscriptions/" + subscriptionName.
    
    Returns:
    A ReceiveSubscriptionMessageResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - receiveMessage
```
ReceiveMessageResult receiveMessage(String path,
                                  ReceiveMessageOptions options)
                                    throws com.microsoft.windowsazure.exception.ServiceException
```
    Receives a message using the specified receive message options.
    
    Parameters:
    path - A String object that represents the path from which a message will be received. This may either be the value of queuePath or a combination of the topicPath + "/subscriptions/" + subscriptionName.
    options - A ReceiveMessageOptions object that represents the receive message options.
    
    Returns:
    A ReceiveSubscriptionMessageResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - deleteMessage
```
void deleteMessage(BrokeredMessage message)
                   throws com.microsoft.windowsazure.exception.ServiceException
```
    Deletes a message.
    
    Parameters:
    message - A Message object that represents the message to delete.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - createQueue
```
CreateQueueResult createQueue(QueueInfo queueInfo)
                              throws com.microsoft.windowsazure.exception.ServiceException
```
    Creates a queue.
    
    Parameters:
    queueInfo - A QueueInfo object that represents the queue to create.
    
    Returns:
    A CreateQueueResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - deleteQueue
```
void deleteQueue(String queuePath)
                 throws com.microsoft.windowsazure.exception.ServiceException
```
    Deletes a queue.
    
    Parameters:
    queuePath - A String object that represents the name of the queue to delete.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - getQueue
```
GetQueueResult getQueue(String queuePath)
                        throws com.microsoft.windowsazure.exception.ServiceException
```
    Retrieves a queue.
    
    Parameters:
    queuePath - A String object that represents the name of the queue to retrieve.
    
    Returns:
    A GetQueueResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - listQueues
```
ListQueuesResult listQueues()
                            throws com.microsoft.windowsazure.exception.ServiceException
```
    Returns a list of queues.
    
    Returns:
    A ListQueuesResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - listQueues
```
ListQueuesResult listQueues(ListQueuesOptions options)
                            throws com.microsoft.windowsazure.exception.ServiceException
```
    Returns a list of queues.
    
    Parameters:
    options - A ListQueueOptions object that represents the options to list the queue.
    
    Returns:
    A ListQueuesResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - updateQueue
```
QueueInfo updateQueue(QueueInfo queueInfo)
                      throws com.microsoft.windowsazure.exception.ServiceException
```
    Updates the information of a queue.
    
    Parameters:
    queueInfo - The information of a queue to be updated.
    
    Returns:
    A QueueInfo object that represents the updated queue.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - createTopic
```
CreateTopicResult createTopic(TopicInfo topic)
                              throws com.microsoft.windowsazure.exception.ServiceException
```
    Creates a topic.
    
    Parameters:
    topic - A Topic object that represents the topic to create.
    
    Returns:
    A CreateTopicResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - deleteTopic
```
void deleteTopic(String topicPath)
                 throws com.microsoft.windowsazure.exception.ServiceException
```
    Deletes a topic.
    
    Parameters:
    topicPath - A String object that represents the name of the queue to delete.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - getTopic
```
GetTopicResult getTopic(String topicPath)
                        throws com.microsoft.windowsazure.exception.ServiceException
```
    Retrieves a topic.
    
    Parameters:
    topicPath - A String object that represents the name of the topic to retrieve.
    
    Returns:
    A GetTopicResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - listTopics
```
ListTopicsResult listTopics()
                            throws com.microsoft.windowsazure.exception.ServiceException
```
    Returns a list of topics.
    
    Returns:
    A ListTopicsResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - listTopics
```
ListTopicsResult listTopics(ListTopicsOptions options)
                            throws com.microsoft.windowsazure.exception.ServiceException
```
    Returns a list of topics.
    
    Parameters:
    options - A ListTopicsOptions object that represents the options to list the topic.
    
    Returns:
    A ListTopicsResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - updateTopic
```
TopicInfo updateTopic(TopicInfo topicInfo)
                      throws com.microsoft.windowsazure.exception.ServiceException
```
    Updates a topic.
    
    Parameters:
    topicInfo - A TopicInfo object that represents the topic to be updated.
    
    Returns:
    A TopicInfo object that represents the update topic result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - createSubscription
```
CreateSubscriptionResult createSubscription(String topicPath,
                                          SubscriptionInfo subscription)
                                            throws com.microsoft.windowsazure.exception.ServiceException
```
    Creates a subscription.
    
    Parameters:
    topicPath - A String object that represents the name of the topic for the subscription.
    subscription - A Subscription object that represents the subscription to create.
    
    Returns:
    A CreateSubscriptionResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - deleteSubscription
```
void deleteSubscription(String topicPath,
                      String subscriptionName)
                        throws com.microsoft.windowsazure.exception.ServiceException
```
    Deletes a subscription.
    
    Parameters:
    topicPath - A String object that represents the name of the topic for the subscription.
    subscriptionName - A String object that represents the name of the subscription to delete.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - getSubscription
```
GetSubscriptionResult getSubscription(String topicPath,
                                    String subscriptionName)
                                      throws com.microsoft.windowsazure.exception.ServiceException
```
    Retrieves a subscription.
    
    Parameters:
    topicPath - A String object that represents the name of the topic for the subscription.
    subscriptionName - A String object that represents the name of the subscription to retrieve.
    
    Returns:
    A GetSubscriptionResult object that represents the result. A String object that represents the name of the subscription to retrieve.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - listSubscriptions
```
ListSubscriptionsResult listSubscriptions(String topicPath)
                                          throws com.microsoft.windowsazure.exception.ServiceException
```
    Returns a list of subscriptions.
    
    Parameters:
    topicPath - A String object that represents the name of the topic for the subscriptions to retrieve.
    
    Returns:
    A ListSubscriptionsResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - listSubscriptions
```
ListSubscriptionsResult listSubscriptions(String topicPath,
                                        ListSubscriptionsOptions options)
                                          throws com.microsoft.windowsazure.exception.ServiceException
```
    Returns a list of subscriptions.
    
    Parameters:
    topicPath - A String object that represents the name of the topic for the subscriptions to retrieve.
    options - A ListSubscriptionsOptions object that represents the options to list subscriptions.
    
    Returns:
    A ListSubscriptionsResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - the service exception
  - updateSubscription
```
SubscriptionInfo updateSubscription(String topicName,
                                  SubscriptionInfo subscriptionInfo)
                                    throws com.microsoft.windowsazure.exception.ServiceException
```
    Updates a subscription.
    
    Parameters:
    topicName - A String option which represents the name of the topic.
    subscriptionInfo - A SubscriptionInfo option which represents the information of the subscription.
    
    Returns:
    A SubscriptionInfo object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - createRule
```
CreateRuleResult createRule(String topicPath,
                          String subscriptionName,
                          RuleInfo rule)
                            throws com.microsoft.windowsazure.exception.ServiceException
```
    Creates a rule.
    
    Parameters:
    topicPath - A String object that represents the name of the topic for the subscription.
    subscriptionName - A String object that represents the name of the subscription for which the rule will be created.
    rule - A Rule object that represents the rule to create.
    
    Returns:
    A CreateRuleResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - deleteRule
```
void deleteRule(String topicPath,
              String subscriptionName,
              String ruleName)
                throws com.microsoft.windowsazure.exception.ServiceException
```
    Deletes a rule.
    
    Parameters:
    topicPath - A String object that represents the name of the topic for the subscription.
    subscriptionName - A String object that represents the name of the subscription for which the rule will be deleted.
    ruleName - A String object that represents the name of the rule to delete.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - getRule
```
GetRuleResult getRule(String topicPath,
                    String subscriptionName,
                    String ruleName)
                      throws com.microsoft.windowsazure.exception.ServiceException
```
    Retrieves a rule.
    
    Parameters:
    topicPath - A String object that represents the name of the topic for the subscription.
    subscriptionName - A String object that represents the name of the subscription for which the rule will be retrieved.
    ruleName - A String object that represents the name of the rule to retrieve.
    
    Returns:
    A GetRuleResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - listRules
```
ListRulesResult listRules(String topicPath,
                        String subscriptionName)
                          throws com.microsoft.windowsazure.exception.ServiceException
```
    Returns a list of rules.
    
    Parameters:
    topicPath - A String object that represents the name of the topic for the subscription.
    subscriptionName - A String object that represents the name of the subscription whose rules are being retrieved.
    
    Returns:
    A ListRulesResult object that represents the result.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - listRules
```
ListRulesResult listRules(String topicPath,
                        String subscriptionName,
                        ListRulesOptions options)
                          throws com.microsoft.windowsazure.exception.ServiceException
```
    Returns a list of rules.
    
    Parameters:
    topicPath - A String object that represents the name of the topic for the subscription.
    subscriptionName - A String object that represents the name of the subscription whose rules are being retrieved.
    options - A ListRulesOptions object that represents the options to retrieve rules.
    
    Returns:
    the list rules result
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - renewQueueLock
```
void renewQueueLock(String queueName,
                  String messageId,
                  String lockToken)
                    throws com.microsoft.windowsazure.exception.ServiceException
```
    Renew queue lock.
    
    Parameters:
    queueName - A String object that represents the name of the queue.
    messageId - A String object that represents the ID of the message.
    lockToken - A String object that represents the token of the lock.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.
  - renewSubscriptionLock
```
void renewSubscriptionLock(String topicName,
                         String subscriptionName,
                         String messageId,
                         String lockToken)
                           throws com.microsoft.windowsazure.exception.ServiceException
```
    Renew subscription lock.
    
    Parameters:
    topicName - A String object that represents the name of the topic.
    subscriptionName - The subscription name.
    messageId - A String object that represents the ID of the message.
    lockToken - A String object that represents the token of the lock.
    
    Throws:
    
    com.microsoft.windowsazure.exception.ServiceException - If a service exception is encountered.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Interface ServiceBusContract

Method Summary

Methods inherited from interface com.microsoft.windowsazure.core.pipeline.jersey.JerseyFilterableService

Methods inherited from interface com.microsoft.windowsazure.core.FilterableService

Method Detail

sendQueueMessage

receiveQueueMessage

receiveQueueMessage

sendTopicMessage

receiveSubscriptionMessage

receiveSubscriptionMessage

unlockMessage

sendMessage

receiveMessage

receiveMessage

deleteMessage

createQueue

deleteQueue

getQueue

listQueues

listQueues

updateQueue

createTopic

deleteTopic

getTopic

listTopics

listTopics

updateTopic

createSubscription

deleteSubscription

getSubscription

listSubscriptions

listSubscriptions

updateSubscription

createRule

deleteRule

getRule

listRules

listRules

renewQueueLock

renewSubscriptionLock