Anypoint Connector

Additional Info

Requires Mule Enterprise License

Yes  

Requires Entitlement

No  

Mule Version

3.5.0 or higher

Configs

Shared Access Signature

<microsoftservicebus:azureSASConfig>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

namespace

String

Azure Service Namespace

x 

sharedAccessSignature

String

Shared Access Signature (optional - can be left empty if advanced section is configured)

 

blobAccountName

String

 

blobAccountKey

String

 

blobContainerName

String

 

tokenProvider

SharedAccessSignatureProvider

 

tokens

List<String>

 

skipConnectivityTest

boolean

false

 

Azure Service Bus

<microsoftservicebus:azureConfig>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

namespace

String

Azure Service Namespace

x 

userName

String

Shared Key Name

x 

password

String

Shared Key

x 

blobAccountName

String

 

blobAccountKey

String

 

blobContainerName

String

 

skipConnectivityTest

boolean

false

 

Windows Service Bus

<microsoftservicebus:windowsConfig>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

namespace

String

Azure Service Namespace

x 

username

String

Shared Key Name

x 

password

String

Shared Key

x 

fqdn

String

Fully Qualified Domain Name

x 

port

String

9355

 

disableCnCheck

Boolean

false

 

skipConnectivityTest

boolean

false

 

Processors

Topic send

<microsoftservicebus:topic-send>

  DataSense enabled

Sends a message to a Topic ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

destinationTopic

String

The name of the destination of the message

x 

body

Object

The content of the message

#[payload]

 

header

AmqpHeader

The supported Header fields defined in the AMQP 1.0 standard

 

properties

AmqpProperties

The supported Amqp Properties defined in the AMQP 1.0 Standard

 

Queue send

<microsoftservicebus:queue-send>

  DataSense enabled

Sends a message to a Queue ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

destinationQueue

String

The name of the destination of the message

x 

body

Object

The content of the message

#[payload]

 

header

AmqpHeader

The supported Header fields defined in the AMQP 1.0 standard

 

properties

AmqpProperties

The supported Amqp Properties defined in the AMQP 1.0 Standard

 

Queues list

<microsoftservicebus:queues-list>

Retrieves all existing queues from the service bus instance ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List<ServiceBusQueue>

A List of ServiceBusQueue Object containing every existing queue

Queue get

<microsoftservicebus:queue-get>

  DataSense enabled

Retrieves the specified queue from the service bus instance ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

queuePath

String

The name of the queue

x 

Returns

Return Java Type Description

ServiceBusQueue

A ServiceBusQueue Object containing the representation of the queue retrieved

Queue create

<microsoftservicebus:queue-create>

  DataSense enabled

Creates a queue in the service bus instance ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

queuePath

String

The name of the queue

x 

queueDescription

ServiceBusQueueDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusQueue

A ServiceBusQueue Object containing the representation of the queue created

Queue update

<microsoftservicebus:queue-update>

  DataSense enabled

Updates the specified queue in the service bus instance ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

queuePath

String

The name of the queue

x 

queueDescription

ServiceBusQueueDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusQueue

ServiceBusQueue

Queue delete

<microsoftservicebus:queue-delete>

  DataSense enabled

Deletes the specified queue in the service bus instance ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

queuePath

String

The name of the queue

x 

Topics list

<microsoftservicebus:topics-list>

Retrieves all existing topics from the service bus instance ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List<ServiceBusTopic>

A List of ServiceBusTopic Object containing every existing topic

Topic get

<microsoftservicebus:topic-get>

  DataSense enabled

Retrieves the specified topic from the service bus instance ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

Returns

Return Java Type Description

ServiceBusTopic

A ServiceBusTopic Object containing the representation of the retrieved topic

Topic create

<microsoftservicebus:topic-create>

  DataSense enabled

Creates a topic in the service bus instance ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

topicDescription

ServiceBusTopicDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusTopic

A ServiceBusTopic Object containing the representation of the created topic

Topic update

<microsoftservicebus:topic-update>

  DataSense enabled

Updates the specified topic from the service bus instance ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

topicDescription

ServiceBusTopicDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusTopic

A ServiceBusTopic Object containing the representation of the retrieved topic

Topic delete

<microsoftservicebus:topic-delete>

  DataSense enabled

Deletes the specified topic from the service bus instance ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

Subscriptions list

<microsoftservicebus:subscriptions-list>

  DataSense enabled

Retrieves all subscriptions from the specified topic ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

Returns

Return Java Type Description

List<ServiceBusSubscription>

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

Subscription get

<microsoftservicebus:subscription-get>

  DataSense enabled

Retrieves the specified subscription from the specified topic ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

subscriptionPath

String

The name of the subscription

x 

Returns

Return Java Type Description

ServiceBusSubscription

A ServiceBusSubscription Object containing the representation of the retrieved subscription

Subscription create

<microsoftservicebus:subscription-create>

  DataSense enabled

Creates a subscription in the specified topic ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

subscriptionPath

String

The name of the subscription

x 

subscriptionDescription

ServiceBusSubscriptionDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusSubscription

A ServiceBusSubscription Object containing the representation of the created subscription

Subscription update

<microsoftservicebus:subscription-update>

  DataSense enabled

Updates the specified subscription from the specified topic ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

subscriptionPath

String

The name of the subscription

x 

subscriptionDescription

ServiceBusSubscriptionDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusSubscription

A ServiceBusSubscription Object containing the representation of the updated subscription

Subscription delete

<microsoftservicebus:subscription-delete>

  DataSense enabled

Deletes the specified subscription from the specified topic ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

subscriptionPath

String

The name of the subscription

x 

Rules list

<microsoftservicebus:rules-list>

  DataSense enabled

Retrieves all rules from the specified topic and subscription ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

subscriptionPath

String

The name of the subscription

x 

Returns

Return Java Type Description

List<ServiceBusRule>

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

Rule get

<microsoftservicebus:rule-get>

  DataSense enabled

Retrieves the specified rule from the specified topic and subscription ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

subscriptionPath

String

The name of the subscription

x 

rulePath

String

The name of the rule

x 

Returns

Return Java Type Description

ServiceBusRule

A ServiceBusRule Object containing the representation of the retrieved rule

Rule create

<microsoftservicebus:rule-create>

  DataSense enabled

Creates a rule in the specified topic and subscription ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

subscriptionPath

String

The name of the subscription

x 

rulePath

String

The name of the rule

x 

ruleDescription

ServiceBusRuleDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusRule

A ServiceBusRule Object containing the representation of the created rule

Rule update

<microsoftservicebus:rule-update>

  DataSense enabled

Updates the specified rule from the specified topic and subscription ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

subscriptionPath

String

The name of the subscription

x 

rulePath

String

The name of the rule

x 

ruleDescription

ServiceBusRuleDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusRule

A ServiceBusRule Object containing the representation of the updated rule

Rule delete

<microsoftservicebus:rule-delete>

  DataSense enabled

Deletes the specified rule from the specified topic and subscription ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

subscriptionPath

String

The name of the subscription

x 

rulePath

String

The name of the rule

x 

Sources

Queue receive

<microsoftservicebus:queue-receive>

Endpoint for receiving message from a Queue ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

sourceCallback

SourceCallback

Source callback

x 

sourceQueue

String

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

x 

Returns

Return Java Type Description

StopSourceCallback

Topic receive

<microsoftservicebus:topic-receive>

Endpoint for receiving message from a Topic ../../../doc/microsoftservicebus-connector.xml.sample microsoftservicebus:myProcessor

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

sourceCallback

SourceCallback

Source callback

x 

sourceTopic

String

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

x 

subscription

String

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

x 

Returns

Return Java Type Description

StopSourceCallback