org.mule.modules.microsoftservicebus

Class MicrosoftServiceBusConnector

java.lang.Object

org.mule.modules.microsoftservicebus.MicrosoftServiceBusConnector

@MetaDataScope(value=TopicCategory.class)
 @Connector(name="microsoftservicebus",
           schemaVersion="1.0",
           friendlyName="Microsoft Service Bus")
 @RequiresEnterpriseLicense(allowEval=true)
public class MicrosoftServiceBusConnector
extends Object

Anypoint Connector

Author:

MuleSoft, Inc.

Constructor Summary

Constructors

Constructor and Description
MicrosoftServiceBusConnector()

Method Summary

Modifier and Type	Method and Description
void	acknowledgeMessage(AmqpMessage amqpMessage) Acknowledges an Aqmp message
ConnectionStrategy	getConnection()
ServiceBusQueue	queueCreate(String queuePath, ServiceBusQueueDescription queueDescription) Creates a queue in the service bus instance
void	queueDelete(String queuePath) Deletes the specified queue in the service bus instance
ServiceBusQueue	queueGet(String queuePath) Retrieves the specified queue from the service bus instance
org.mule.api.callback.StopSourceCallback	queueReceive(org.mule.api.callback.SourceCallback sourceCallback, String sourceQueue) Endpoint for receiving message from a Queue
void	queueSend(String destinationQueue, Object body, AmqpHeader header, AmqpProperties properties, org.mule.api.MuleEvent event) Sends a message to a Queue
List<ServiceBusQueue>	queuesList() Retrieves all existing queues from the service bus instance
ServiceBusQueue	queueUpdate(String queuePath, ServiceBusQueueDescription queueDescription) Updates the specified queue in the service bus instance
ServiceBusRule	ruleCreate(String topicPath, String subscriptionPath, String rulePath, ServiceBusRuleDescription ruleDescription) Creates a rule in the specified topic and subscription
void	ruleDelete(String topicPath, String subscriptionPath, String rulePath) Deletes the specified rule from the specified topic and subscription
ServiceBusRule	ruleGet(String topicPath, String subscriptionPath, String rulePath) Retrieves the specified rule from the specified topic and subscription
List<ServiceBusRule>	rulesList(String topicPath, String subscriptionPath) Retrieves all rules from the specified topic and subscription
ServiceBusRule	ruleUpdate(String topicPath, String subscriptionPath, String rulePath, ServiceBusRuleDescription ruleDescription) Updates the specified rule from the specified topic and subscription
void	setConnection(ConnectionStrategy connection)
ServiceBusSubscription	subscriptionCreate(String topicPath, String subscriptionPath, ServiceBusSubscriptionDescription subscriptionDescription) Creates a subscription in the specified topic
void	subscriptionDelete(String topicPath, String subscriptionPath) Deletes the specified subscription from the specified topic
ServiceBusSubscription	subscriptionGet(String topicPath, String subscriptionPath) Retrieves the specified subscription from the specified topic
List<ServiceBusSubscription>	subscriptionsList(String topicPath) Retrieves all subscriptions from the specified topic
ServiceBusSubscription	subscriptionUpdate(String topicPath, String subscriptionPath, ServiceBusSubscriptionDescription subscriptionDescription) Updates the specified subscription from the specified topic
ServiceBusTopic	topicCreate(String topicPath, ServiceBusTopicDescription topicDescription) Creates a topic in the service bus instance
void	topicDelete(String topicPath) Deletes the specified topic from the service bus instance
ServiceBusTopic	topicGet(String topicPath) Retrieves the specified topic from the service bus instance
org.mule.api.callback.StopSourceCallback	topicReceive(org.mule.api.callback.SourceCallback sourceCallback, String sourceTopic, String subscription, boolean verifySynchronous) Endpoint for receiving message from a Topic
void	topicSend(String destinationTopic, Object body, AmqpHeader header, AmqpProperties properties, org.mule.api.MuleEvent event) Sends a message to a Topic
List<ServiceBusTopic>	topicsList() Retrieves all existing topics from the service bus instance
ServiceBusTopic	topicUpdate(String topicPath, ServiceBusTopicDescription topicDescription) Updates the specified topic from the service bus instance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MicrosoftServiceBusConnector

public MicrosoftServiceBusConnector()

Method Detail

topicSend

@Processor
public void topicSend(@MetaDataKeyParam(affects=INPUT)
                                 String destinationTopic,
                                 @RefOnly @Default(value="#[payload]")
                                 Object body,
                                 @Optional @Placement(group="Amqp Header") @RefOnly
                                 AmqpHeader header,
                                 @Optional @Placement(group="Amqp Properties") @RefOnly
                                 AmqpProperties properties,
                                 org.mule.api.MuleEvent event)
                          throws ServiceBusException

Sends a message to a Topic

Parameters:

destinationTopic - The name of the destination of the message

body - The content of the message

header - The supported Header fields defined in the AMQP 1.0 standard

properties - The supported Amqp Properties defined in the AMQP 1.0 Standard

event - Mule event

Throws:

ServiceBusException - when there is an error

queueSend

@MetaDataScope(value=QueueCategory.class)
 @Processor
public void queueSend(@MetaDataKeyParam(affects=INPUT)
                                                                            String destinationQueue,
                                                                            @RefOnly @Default(value="#[payload]")
                                                                            Object body,
                                                                            @Optional @Placement(group="Amqp Header") @RefOnly
                                                                            AmqpHeader header,
                                                                            @Optional @Placement(group="Amqp Properties") @RefOnly
                                                                            AmqpProperties properties,
                                                                            org.mule.api.MuleEvent event)
                                                                     throws ServiceBusException

Sends a message to a Queue

Parameters:

destinationQueue - The name of the destination of the message

body - The content of the message

header - The supported Header fields defined in the AMQP 1.0 standard

properties - The supported Amqp Properties defined in the AMQP 1.0 Standard

event - Mule event

Throws:

ServiceBusException - when there is an error

acknowledgeMessage

@Processor
public void acknowledgeMessage(@Default(value="#[payload]") @RefOnly
                                          AmqpMessage amqpMessage)
                                   throws ServiceBusException

Acknowledges an Aqmp message

Parameters:

amqpMessage - Message to be acknowledged

Throws:

ServiceBusException - when there is an error

queueReceive

@MetaDataScope(value=QueueCategory.class)
 @Source(threadingModel=NONE,
        sourceStrategy=NONE)
 @ReconnectOn(exceptions=java.lang.Exception.class)
public org.mule.api.callback.StopSourceCallback queueReceive(org.mule.api.callback.SourceCallback sourceCallback,
                                                                                                                                                                                                                      @MetaDataKeyParam(affects=OUTPUT)
                                                                                                                                                                                                                      String sourceQueue)
                                                                                                                                                                                                               throws ServiceBusException

Endpoint for receiving message from a Queue

Parameters:

sourceCallback - Source callback

sourceQueue - The name of the source from where the messages will be retrieved

Returns:

stop source callback instance

Throws:

ServiceBusException - when there is an error

topicReceive

@Source(threadingModel=NONE,
        sourceStrategy=NONE)
 @ReconnectOn(exceptions=java.lang.Exception.class)
public org.mule.api.callback.StopSourceCallback topicReceive(org.mule.api.callback.SourceCallback sourceCallback,
                                                                                                                                                                           @MetaDataKeyParam(affects=OUTPUT)
                                                                                                                                                                           String sourceTopic,
                                                                                                                                                                           String subscription,
                                                                                                                                                                           @FriendlyName(value="verify If processing is Synchronous") @Default(value="false")
                                                                                                                                                                           boolean verifySynchronous)
                                                                                                                                                                    throws ServiceBusException

Endpoint for receiving message from a Topic

Parameters:

sourceCallback - Source callback

sourceTopic - The name of the source from where the messages will be retrieved

subscription - The name of the subscription from where the messages will be retrieved

verifySynchronous - if checked, verifies if the flow strategy is synchronous and logs a warning if it's not

Returns:

stop source callback instance

Throws:

ServiceBusException - when there is an error

queuesList

@Processor
public List<ServiceBusQueue> queuesList()
                                            throws ServiceBusException

Retrieves all existing queues from the service bus instance

Returns:

A List of ServiceBusQueue Object containing every existing queue

Throws:

ServiceBusException - when there is an error

queueGet

@MetaDataScope(value=QueueCategory.class)
 @Processor
public ServiceBusQueue queueGet(@MetaDataKeyParam(affects=OUTPUT)
                                                                                      String queuePath)
                                                                               throws ServiceBusException

Retrieves the specified queue from the service bus instance

Parameters:

queuePath - The name of the queue

Returns:

A ServiceBusQueue Object containing the representation of the queue retrieved

Throws:

ServiceBusException - when there is an error

queueCreate

@MetaDataScope(value=QueueCategory.class)
 @Processor
public ServiceBusQueue queueCreate(@MetaDataKeyParam(affects=BOTH)
                                                                                         String queuePath,
                                                                                         @Placement(group="Queue Description") @RefOnly @Default(value="#[payload]")
                                                                                         ServiceBusQueueDescription queueDescription)
                                                                                  throws ServiceBusException

Creates a queue in the service bus instance

Parameters:

queuePath - The name of the queue

queueDescription - A ServiceBusQueueDescription object containing the desired values of the queue’s properties that will be created

Returns:

A ServiceBusQueue Object containing the representation of the queue created

Throws:

ServiceBusException - when there is an error

queueUpdate

@MetaDataScope(value=QueueCategory.class)
 @Processor
public ServiceBusQueue queueUpdate(@MetaDataKeyParam(affects=BOTH)
                                                                                         String queuePath,
                                                                                         @Placement(group="Queue Description") @RefOnly @Default(value="#[payload]")
                                                                                         ServiceBusQueueDescription queueDescription)
                                                                                  throws ServiceBusException

Updates the specified queue in the service bus instance

Parameters:

queuePath - The name of the queue

queueDescription - A ServiceBusQueueDescription oject containing the desired values of the queue’s properties that will be updated

Returns:

ServiceBusQueue

Throws:

ServiceBusException - when there is an error

queueDelete

@MetaDataScope(value=QueueCategory.class)
 @Processor
public void queueDelete(@MetaDataKeyParam
                                                                              String queuePath)
                                                                       throws ServiceBusException

Deletes the specified queue in the service bus instance

Parameters:

queuePath - The name of the queue

Throws:

ServiceBusException - when there is an error

topicsList

@Processor
public List<ServiceBusTopic> topicsList()
                                            throws ServiceBusException

Retrieves all existing topics from the service bus instance

Returns:

A List of ServiceBusTopic Object containing every existing topic

Throws:

ServiceBusException - when there is an error

topicGet

@Processor
public ServiceBusTopic topicGet(@MetaDataKeyParam(affects=OUTPUT)
                                           String topicPath)
                                    throws ServiceBusException

Retrieves the specified topic from the service bus instance

Parameters:

topicPath - The name of the topic

Returns:

A ServiceBusTopic Object containing the representation of the retrieved topic

Throws:

ServiceBusException - when there is an error

topicCreate

@Processor
public ServiceBusTopic topicCreate(@MetaDataKeyParam(affects=BOTH)
                                              String topicPath,
                                              @Placement(group="Topic Description") @RefOnly @Default(value="#[payload]")
                                              ServiceBusTopicDescription topicDescription)
                                       throws ServiceBusException

Creates a topic in the service bus instance

Parameters:

topicPath - The name of the topic

topicDescription - A ServiceBusTopicDescription object containing the desired values of the topic’s properties that will be created.

Returns:

A ServiceBusTopic Object containing the representation of the created topic

Throws:

ServiceBusException - when there is an error

topicUpdate

@Processor
public ServiceBusTopic topicUpdate(@MetaDataKeyParam(affects=BOTH)
                                              String topicPath,
                                              @Placement(group="Topic Description") @RefOnly @Default(value="#[payload]")
                                              ServiceBusTopicDescription topicDescription)
                                       throws ServiceBusException

Updates the specified topic from the service bus instance

Parameters:

topicPath - The name of the topic

topicDescription - A ServiceBusTopicDescription object containing the desired values of the topic’s properties that will be updated.

Returns:

A ServiceBusTopic Object containing the representation of the retrieved topic

Throws:

ServiceBusException - when there is an error

topicDelete

@Processor
public void topicDelete(@MetaDataKeyParam
                                   String topicPath)
                            throws ServiceBusException

Deletes the specified topic from the service bus instance

Parameters:

topicPath - The name of the topic

Throws:

ServiceBusException - when there is an error

subscriptionsList

@Processor
public List<ServiceBusSubscription> subscriptionsList(@MetaDataKeyParam(affects=OUTPUT)
                                                                 String topicPath)
                                                          throws ServiceBusException

Retrieves all subscriptions from the specified topic

Parameters:

topicPath - The name of the topic

Returns:

A List of ServiceBusSubscription Object containing every existing subscription in the topic

Throws:

ServiceBusException - when there is an error

subscriptionGet

@Processor
public ServiceBusSubscription subscriptionGet(@MetaDataKeyParam(affects=OUTPUT) @Placement(order=1)
                                                         String topicPath,
                                                         @Placement(order=2)
                                                         String subscriptionPath)
                                                  throws ServiceBusException

Retrieves the specified subscription from the specified topic

Parameters:

topicPath - The name of the topic

subscriptionPath - The name of the subscription

Returns:

A ServiceBusSubscription Object containing the representation of the retrieved subscription

Throws:

ServiceBusException - when there is an error

subscriptionCreate

@Processor
public ServiceBusSubscription subscriptionCreate(@MetaDataKeyParam(affects=BOTH) @Placement(order=1)
                                                            String topicPath,
                                                            @Placement(order=2)
                                                            String subscriptionPath,
                                                            @Placement(group="Subscription Description") @RefOnly @Default(value="#[payload]")
                                                            ServiceBusSubscriptionDescription subscriptionDescription)
                                                     throws ServiceBusException

Creates a subscription in the specified topic

Parameters:

topicPath - The name of the topic

subscriptionPath - The name of the subscription

subscriptionDescription - A ServiceBusSubscriptionDescription object containing the desired values of the subscription’s properties that will be created

Returns:

A ServiceBusSubscription Object containing the representation of the created subscription

Throws:

ServiceBusException - when there is an error

subscriptionUpdate

@Processor
public ServiceBusSubscription subscriptionUpdate(@MetaDataKeyParam(affects=BOTH) @Placement(order=1)
                                                            String topicPath,
                                                            @Placement(order=2)
                                                            String subscriptionPath,
                                                            @Placement(group="Subscription Description") @RefOnly @Default(value="#[payload]")
                                                            ServiceBusSubscriptionDescription subscriptionDescription)
                                                     throws ServiceBusException

Updates the specified subscription from the specified topic

Parameters:

topicPath - The name of the topic

subscriptionPath - The name of the subscription

subscriptionDescription - A ServiceBusSubscriptionDescription object containing the desired values of the subscription’s properties that will be updated

Returns:

A ServiceBusSubscription Object containing the representation of the updated subscription

Throws:

ServiceBusException - when there is an error

subscriptionDelete

@Processor
public void subscriptionDelete(@MetaDataKeyParam @Placement(order=1)
                                          String topicPath,
                                          @Placement(order=2)
                                          String subscriptionPath)
                                   throws ServiceBusException

Deletes the specified subscription from the specified topic

Parameters:

topicPath - The name of the topic

subscriptionPath - The name of the subscription

Throws:

ServiceBusException - when there is an error

rulesList

@Processor
public List<ServiceBusRule> rulesList(@MetaDataKeyParam(affects=OUTPUT) @Placement(order=1)
                                                 String topicPath,
                                                 @Placement(order=2)
                                                 String subscriptionPath)
                                          throws ServiceBusException

Retrieves all rules from the specified topic and subscription

Parameters:

topicPath - The name of the topic

subscriptionPath - The name of the subscription

Returns:

A List of ServiceBusRule Object containing every existing rule in the specified subscription and topic

Throws:

ServiceBusException - when there is an error

ruleGet

@Processor
public ServiceBusRule ruleGet(@MetaDataKeyParam(affects=OUTPUT) @Placement(order=1)
                                         String topicPath,
                                         @Placement(order=2)
                                         String subscriptionPath,
                                         @Placement(order=3)
                                         String rulePath)
                                  throws ServiceBusException

Retrieves the specified rule from the specified topic and subscription

Parameters:

topicPath - The name of the topic

subscriptionPath - The name of the subscription

rulePath - The name of the rule

Returns:

A ServiceBusRule Object containing the representation of the retrieved rule

Throws:

ServiceBusException - when there is an error

ruleCreate

@Processor
public ServiceBusRule ruleCreate(@MetaDataKeyParam(affects=BOTH) @Placement(order=1)
                                            String topicPath,
                                            @Placement(order=2)
                                            String subscriptionPath,
                                            @Placement(order=3)
                                            String rulePath,
                                            @Placement(group="Rule Description") @RefOnly @Default(value="#[payload]")
                                            ServiceBusRuleDescription ruleDescription)
                                     throws ServiceBusException

Creates a rule in the specified topic and subscription

Parameters:

topicPath - The name of the topic

subscriptionPath - The name of the subscription

rulePath - The name of the rule

ruleDescription - A ServiceBusRuleDescription object containing the desired values of the rule’s properties that will be created

Returns:

A ServiceBusRule Object containing the representation of the created rule

Throws:

ServiceBusException - when there is an error

ruleUpdate

@Processor
public ServiceBusRule ruleUpdate(@MetaDataKeyParam(affects=BOTH) @Placement(order=1)
                                            String topicPath,
                                            @Placement(order=2)
                                            String subscriptionPath,
                                            @Placement(order=3)
                                            String rulePath,
                                            @Placement(group="Rule Description") @RefOnly @Default(value="#[payload]")
                                            ServiceBusRuleDescription ruleDescription)
                                     throws ServiceBusException

Updates the specified rule from the specified topic and subscription

Parameters:

topicPath - The name of the topic

subscriptionPath - The name of the subscription

rulePath - The name of the rule

ruleDescription - A ServiceBusRuleDescription object containing the desired values of the rule’s properties that will be updated

Returns:

A ServiceBusRule Object containing the representation of the updated rule

Throws:

ServiceBusException - when there is an error

ruleDelete

@Processor
public void ruleDelete(@MetaDataKeyParam @Placement(order=1)
                                  String topicPath,
                                  @Placement(order=2)
                                  String subscriptionPath,
                                  @Placement(order=3)
                                  String rulePath)
                           throws ServiceBusException

Deletes the specified rule from the specified topic and subscription

Parameters:

topicPath - The name of the topic

subscriptionPath - The name of the subscription

rulePath - The name of the rule

Throws:

ServiceBusException - when there is an error

getConnection

public ConnectionStrategy getConnection()

setConnection

public void setConnection(ConnectionStrategy connection)