AMQPClassic Adapter

An easy-to-use AMQP 0.9.1 client implementation, with support for RabbitMQ extensions.

Remarks

The AMQPClassic adapter provides an easy-to-use AMQP 0.9.1 client implementation, and it also supports certain RabbitMQ extensions to the AMQP 0.9.1 specification. The adapter supports both plaintext and TLS-enabled connections over TCP.

Connecting

The AMQP 0.9.1 transport protocol has two layers: an overall connection between the client and server, and one or more channels running over that connection.

AMQPClassic Receive Adapter

At a minimum, you must supply an RemoteHost, RemotePort, and ChannelName for the connection. In order to authenticate with the AMQPClassic broker you will need to specify a User and Password. The AuthScheme property contains a preferential list of authentication methods to be enabled on the adapter.

Setting ChannelName will create a channel with the specified name on the broker. Once the adapter has connected to the server it is possible to manipulate exchanges and queues and consume messages.

AMQPClassic Send Adapter

Setting ChannelName will create a channel with the specified name on the broker. Once the adapter has connected to the server it is possible to manipulate exchanges and queues and publish messages.

By default, the adapter will attempt to send the contents of the outbound BizTalk Server message as the message body. This can be overridden by setting a static message in the send port's MessageBody property at design-time. To set a dynamic message, you can write to the same property in the message context at runtime. The adapter will send the contents of the MessageBody property.

The AMQPClassic Sender and Receiver Adapters have support for SSL transport layer security. This may be enabled by setting SSLStartMode, SSLCert and SSLAcceptServerCert to appropriate values.

Declaring Exchanges

Set DeclareExchange to true to declare an exchange. ChannelName, ExchangeName, ExchangeType, ExchangeType, ExchangePassive, and ExchangeAutoDelete may also be set.

Declaring Queues

Set DeclareQueue to true to declare a queue. ChannelName, QueueName, QueuePassive, QueueDurable, QueueExclusive, and QueueAutoDelete may also be set.

Binding Queues to Exchanges

Set BindQueue to true to bind a exchange with specified RoutingKey.

Creating Consumers

The receiver adapter will use the Consumer properties to start a consumer for QueueName. Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.

Receiver Property List

The following is the full list of the properties of the receiver adapter with short descriptions. Click on the links for further details.


AppId	The Id of the application that created the message.
AsynchronousMode	Indicates whether the server handles the request in asynchronous mode.
AuthScheme	The authentication scheme to use when connecting.
BindQueue	Bind the queue to the exchange with given RoutingKey.
ChannelName	The name of the channel the message is associated with.
ClientProperties	A collection of table fields that describe properties of the client.
ConsumerExclusive	Whether the consumer is exclusive.
ConsumerNoAck	Whether each message is acknowledged by the component.
ConsumerNoLocal	Whether the consumer will consume messages published on the same channel.
ConsumerTag	The consumer tag used to uniquely identify a consumer on a channel.
ContentEncoding	The content encoding of the message's body.
ContentType	The content type (MIME type) of the message's body.
CorrelationId	The correlation Id of the message.
DeclareExchange	This is used to verify that an exchange named ExchangeName exists, and potentially creates it if no such exchange exists.
DeclareQueue	This is used to verify that a queue named QueueName exists; and potentially creates it if no such queue exists.
DeleteExchange	Specifies whether delete the exchange named ExchangeName.
DeleteQueue	Deletes a queue.
DeliveryMode	The delivery mode of the message.
ExchangeAutoDelete	This specifies whether the server should automatically delete the exchange when all queues have been unbound from it.
ExchangeDurable	This specifies what happens to the exchange in the event of a server restart.
ExchangeIfUnused	Specifies whether the server will delete the exchange if no queues are bound to it.
ExchangeName	The name of the exchange.
ExchangePassive	This specifies how the server will deal with a preexisting exchange.
ExchangeType	This specifies the exchange type.
Expiration	The time-to-live value for this message.
Firewall	A set of properties related to firewall access.
Headers	Headers associated with the message.
MaxThreads	The maximum number of threads that the component may consume.
MessageId	The unique Id of the message.
MessageType	The message's type.
Other	Defines a set of configuration settings to be used by the component.
Password	A password to use for SASL authentication.
PersistentConnection	Instructs the component whether to keep the connection to the server open.
Priority	The priority of the message.
QueueAutoDelete	This specifies whether the server should automatically delete the queue when all consumers have finished using it.
QueueDurable	Durable specifies what happens to the queue in the event of a server restart.
QueueExclusive	Exclusive , if True , indicates that the queue may only be accessed by the current connection.
QueueIfEmpty	Specifies whether to delete the queue when consumers are attached.
QueueIfUnused	Specifies whether to delete the queue when no messages are in it.
QueueName	The name of the queue.
QueuePassive	This specifies how the server will deal with a preexisting queue.
RemoteHost	The address of the remote host. Domain names are resolved to IP addresses.
RemotePort	The port of the AQMP server (default is 5672). The default port for SSL is 5671.
ReplyTo	The address to send replies to for the message.
Requeue	This property controls how the server should attempt to redeliver the messages awaiting acknowledgement.
RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached.
RoutingKey	The RoutingKey parameter specifies the binding's routing key.
RuntimeLicense	Specifies the component runtime license key.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
SSLStartMode	Determines how the component starts the SSL negotiation.
Timeout	A timeout for the component.
Timestamp	The message's timestamp.
TransportLog	Tells the component where and how to report information about its operations.
UnBindQueue	Unbind the queue to the exchange with given RoutingKey.
URI	The Uniform Resource Identifier (URI) of the send port or receive location.
User	A username to use for SASL authentication.
UserId	The identity of the user responsible for producing the message.
VirtualHost	The virtual host to connect to.

Sender Property List

The following is the full list of the properties of the sender adapter with short descriptions. Click on the links for further details.


AppId	The Id of the application that created the message.
AsynchronousMode	Indicates whether the server handles the request in asynchronous mode.
AuthScheme	The authentication scheme to use when connecting.
BindQueue	Bind the queue to the exchange with given RoutingKey.
ChannelName	The name of the channel the message is associated with.
ClientProperties	A collection of table fields that describe properties of the client.
ConnectionLifetime	Instructs the component whether or not to leave the connection to the server open.
ContentEncoding	The content encoding of the message's body.
ContentType	The content type (MIME type) of the message's body.
CorrelationId	The correlation Id of the message.
DeclareExchange	This is used to verify that an exchange named ExchangeName exists, and potentially creates it if no such exchange exists.
DeclareQueue	This is used to verify that a queue named QueueName exists; and potentially creates it if no such queue exists.
DeleteExchange	Specifies whether delete the exchange named ExchangeName.
DeleteQueue	Deletes a queue.
DeliveryMode	The delivery mode of the message.
ExchangeAutoDelete	This specifies whether the server should automatically delete the exchange when all queues have been unbound from it.
ExchangeDurable	This specifies what happens to the exchange in the event of a server restart.
ExchangeIfUnused	Specifies whether the server will delete the exchange if no queues are bound to it.
ExchangeName	The name of the exchange.
ExchangePassive	This specifies how the server will deal with a preexisting exchange.
ExchangeType	This specifies the exchange type.
Expiration	The time-to-live value for this message.
Firewall	A set of properties related to firewall access.
Headers	Headers associated with the message.
Immediate	Controls what the server should do if the message cannot be immediately delivered to any consumer.
Mandatory	Controls what the server should do if a message cannot be routed to any queue.
MaxPersistentConnections	The maximum number of simultaneous persistent connections when sending.
MaxThreads	The maximum number of threads that the component may consume.
MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch.
MessageBody	The message body.
MessageId	The unique Id of the message.
MessageType	The message's type.
Other	Defines a set of configuration settings to be used by the component.
Password	A password to use for SASL authentication.
Priority	The priority of the message.
PublishConfirms	Enables publish confirmations mode for a channel.
QueueAutoDelete	This specifies whether the server should automatically delete the queue when all consumers have finished using it.
QueueDurable	Durable specifies what happens to the queue in the event of a server restart.
QueueExclusive	Exclusive , if True , indicates that the queue may only be accessed by the current connection.
QueueIfEmpty	Specifies whether to delete the queue when consumers are attached.
QueueIfUnused	Specifies whether to delete the queue when no messages are in it.
QueueName	The name of the queue.
QueuePassive	This specifies how the server will deal with a preexisting queue.
Recover	Requests the server to redeliver all messages on a given channel that have not been acknowledged.
RemoteHost	The address of the remote host. Domain names are resolved to IP addresses.
RemotePort	The port of the AQMP server (default is 5672). The default port for SSL is 5671.
ReplyTo	The address to send replies to for the message.
Requeue	This property controls how the server should attempt to redeliver the messages awaiting acknowledgement.
RoutingKey	The RoutingKey parameter specifies the binding's routing key.
RuntimeLicense	Specifies the component runtime license key.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
SSLStartMode	Determines how the component starts the SSL negotiation.
Timeout	A timeout for the component.
Timestamp	The message's timestamp.
TransactionMode	Whether the channel is operating in Transaction mode.
TransmitBatchMode	How the transmitter processes batches.
TransportLog	Tells the component where and how to report information about its operations.
UnBindQueue	Unbind the queue to the exchange with given RoutingKey.
URI	The Uniform Resource Identifier (URI) of the send port or receive location.
User	A username to use for SASL authentication.
UserId	The identity of the user responsible for producing the message.
VirtualHost	The virtual host to connect to.

Configuration Settings

The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.