ActiveMQ supports the AMQP 1.0 protocol which is an OASIS standard.

Availability

Available from ActiveMQ version 5.8 onwards.

Enabling the ActiveMQ Broker for AMQP

Its very easy to enable ActiveMQ for AMQP. Just add a connector to the broker using the amqp URL.

+

ActiveMQ supports the AMQP 1.0 protocol which is an OASIS standard.

Availability

Available from ActiveMQ version 5.8 onward.

Enabling the ActiveMQ Broker for AMQP

To enable AMQP protocol support on the broker add the following transport connector configuration referencing the amqp scheme in its URI:

<transportConnectors>
    <transportConnector name="amqp" uri="amqp://0.0.0.0:5672"/>
 </transportConnectors>

-

It is enabled in the default ActiveMQ server configuration.

For more help see Run Broker.

Security

The AMQP implementation fully supports an ActiveMQ security mechanism. This means that the broker accepts plain SASL authentication. Also, the authorization policies will be applied when you try to access (read/write) certain destinations.

SSL

For additional security, you can use AMQP over SSL as described in the following section.

Enabling AMQP over NIO

For better scalability (and performance) you might want to run the AMQP protocol over the NIO trans port. To do that just use amqp+nio transport prefix instead of amqp. For example, add the following transport configuration in your XML file:

-

     <transportConnector name="amqp+nio" uri="amqp+nio://localhost:5672"/>
+

It is enabled in the default ActiveMQ server configuration. For more help see Run Broker.

Security

The AMQP implementation fully supports an ActiveMQ security mechanism. This allows the broker to accept plain SASL authentication. Authorization policies are applied to a destination when it's accessed (read/write).

SSL

For additional security AMQP can be configured to run over SSL as described in the following section.

Enabling AMQP over NIO

For better scalability (and performance) the AMQP protocol should be configured to use NIO, rather than the default o f TCP. To use NIO use the transport scheme amqp+nio instead of amqp.

Example:

+

<transportConnector name="amqp+nio" uri="amqp+nio://localhost:5672"/>

-

This transport uses the NIO transport underneath and will generally use much less threads than the standard connector. This connector can help if you want to use large number of queues

Enabling AMQP over SSL

It's easy to configure ActiveMQ to use AMQP over a SSL connection. All you have to do is use the amqp+ssl transport prefix instead of amqp. For example, add the following transport configuration in your XML file:

-

     <transportConnector name="amqp+ssl" uri="amqp+ssl://localhost:5671"/>
+

This transport uses the NIO transport underneath and will generally use much less threads than the standard connector. This connector can help if you want to use large number of queues

Enabling AMQP over SSL

It's easy to configure ActiveMQ to use AMQP over a SSL connection. To use SSL use the transport scheme amqp+ssl instead of amqp.

Example:

+

<transportConnector name="amqp+ssl" uri="amqp+ssl://localhost:5671"/>

-

For more details on using SSL with ActiveMQ, see the following article (How do I use SSL).

Working with Destinations with AMQP

You should prefix destination address with `queue://` to use Queue based destinations or `topic://` to use topic based destinations. If an AMQP address is used without the prefix, it will be used as a Queue.

Prefetch size and credit

When AMQP receiver connects to the broker, its mapped to the JMS consumer. This JMS consumer has to have appropriate prefetch size set. The broker will respect the credit set by the client or use default value of 1000 if client don't set it.

You can also tune a default value using pref etch transport attribute, like

-

<transportConnector name="amqp" uri="amqp://0.0.0.0:5672?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600&amp;transport.prefetch=10"/>

-

In this case, client preference will be ignored and the configured value will be used.

You can also tune broker-side amqp receiver link that handles incoming messages. It will use credit of 1000 messages by default, but you can override this by using producerCredit property, like

-

<transportConnector name="amqp" uri="amqp://0.0.0.0:5672?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600&amp;transport.producerCredit=10000"/>

-

Mapping to JMS

There are three basic conversion strategies that can be used with AMQP and interoperating with the JMS API.

Strategy	Description
native	Default Wraps the bytes of the AMQP message into a JMS BytesMessage and also maps the headers of the AMQP message to headers on the JMS message
raw	Wraps the bytes of the AMQP message into a JMS BytesMessage
jms	Maps headers of the AMQP message to JMS message headers and maps the body of the AMQP message to JMS body

Set the transformer transport option on the transportConnector to the desired mapping strategy. For example, to interoperate with JMS at the payload level, set the transformer option to jms

-

     <transportConnector name="amqp" uri="amqp://localhost:5672?transport.transformer=jms"/>
+

For more details on using SSL with ActiveMQ, see the following article (How do I use SSL).

Working with Destinations with AMQP

You should prefix destination address with queue:// to use queue based destinations or topic:// to use topic based destinations. The destination type defaults to queue when the destination prefix is omitted.

Prefetch Size and Credit

When AMQP receiver connects to the broker it's mapped to the JMS consumer. This JMS consumer has to have appropriate prefetch size set. The broker will honor the credit set by the client or use the default value of 1000< /strong> if client doesn't set it.

Example: tuning the default prefetch size:

+<transportConnector name="amqp" uri="amqp://0.0.0.0:5672?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600&amp;transport.prefetch=10"/>
+

In this case, client preference will be ignored and the configured value will be used.

You can also tune broker-side amqp receiver link that handles incoming messages. It will use credit of 1000 messages by default, but you can override this by using producerCredit property, like

+<transportConnector name="amqp" uri="amqp://0.0.0.0:5672?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600&amp;transport.producerCredit=10000"/>
+

Mapping to JMS

There are three basic conversion strategies that can be used with AMQP and inter-operating with the JMS API.

Strategy	Description
`native`	(Default) Wraps the bytes of the AMQP message into a JMS `BytesMessage` and maps the headers of the AMQP message to headers on the JMS message.
`raw`	Wraps the bytes of the AMQP message into a JMS `BytesMessage`.
`jms`	Maps headers of the AMQP message to JMS message headers and the body of the AMQP message to the JMS body.

Set the transformer transport option on the transportConnector to the desired mapping strategy. For example, to inter-operate with JMS at the payload level, set the transformer option to jms:

+<transportConnector name="amqp" uri="amqp://localhost:5672?transport.transformer=jms"/>
 
-

How AMQP message headers are mapped to JMS Headers:

The following headers are mapped regardless of the transformer used:

AMQP Message	JMS Message	Notes
	JMS_AMQP_NATIVE	Will be set to true if the transformer is 'native' or 'raw', false otherwise.
message-format	JMS_AMQP_MESSAGE_FORMAT

The following headers are mapped if the transformer is 'native' or 'jms':

AMQP Message	JMS Message	Notes
header.durable	JMSDeliveryMode	javax.jms.Message.DEFAULT_DELIVERY_MODE if not set
header.priority	JMSPriority	javax.jms.Message.DEFAULT_PRIORITY if not set
header.ttl	JMSExpiration	javax.jms.Message.DEFAULT_TIME_TO_LIVE if not set
header.first-acquirer	JMS_AMQP_FirstAcquirer
header.deliveryCount	JMSXDeliveryCount
delivery-annotations.name	JMS_AMQP_DA_name
message-annotations.x-opt-jms-type	JMSType
message-annotations.x-opt-to-type	Type of the JMSDestination	Comma separated list of 'queue', 'topic', or 'temporary', defaults to queue if not set.
message-annotations.x-opt-reply-type	Type of the JMSReplyTo	Comma separated list of 'queue', 'topic', or 'temporary', defaults to queue if not set.
message-annotations.name	JMS_AMQP_MA_name
application-properties.JMSXGroupID	JMSXGroupID
application-properties.JMSXGroupSequence	JMSXGroupSequence
application-properties.JMSXUserID	JMSXUserID
application-properties.name	name
properties.message-id	JMSMessageID	Auto generated if not set
properties.user-id	JMSXUserID	properties.user-id is decoded as a UTF-8 String
properties.to	JMSDestination	The name of the JMSDestination
properties.subject	JMS_AMQP_Subject
properties.reply-to	JMSReplyTo	The name of the JMSReplyTo
properties.correlation-id	JMSCorrelationID
properties.content-type	J MS_AMQP_ContentType
properties.content-encoding	JMS_AMQP_ContentEncoding
properties.creation-time	JMSTimestamp
properties.group-sequence	JMSXGroupSequence
properties.reply-to-group-id	JMS_AMQP_ReplyToGroupID
footer.name	JMS_AMQP_FT_name

AMQP property value types are converted as follows:

AMQP Type	Java Type	Notes
bool	Boolean
byte	Byte
short	Short
int	Integer
long	Long
ubyte	Byte or Short	Short is used if value > Byte.MAX_VALUE
ushort	Short or Integer	Integer is used if value > Short.MAX_VALUE
uint	Integer or Long	Long is used if value > Integer.MAX_VALUE
ulong	Long
double	Double	&# 160;
float	Float
symbol	String
binary	String	Hex encoding of the binary value

How AMQP messages bodies are mapped to JMS Messages:

If the transformer is set to 'jms', the they type of JMS message will depend on the body type of the AMQP message.

Body Type	JMS Message Type
null	Message
Data	BytesMessage
AmqpSequence	StreamMessage
AmqpValue holding a null	Message
AmqpValue holding a String	TextMessage
AmqpValue holding a binary	BytesMessage
AmqpValue holding a list	StreamMessage
AmqpValue	ObjectMessage

AMQP 1.0 client library

You can use Apache Qpid Proton.

+

How AMQP Message Headers are Mapped to JMS Headers

The following headers are mapped regardless of the transformer used:

AMQP Message	JMS Message	Notes
	`JMS_AMQP_NATIVE`	Will be set to `true` if the transformer is `native` or `raw`, `false` otherwise.
`message-format`	`JMS_AMQP_MESSAGE_FORMAT`

The following header mappings apply when the transformer is either native or jms:

AMQP Message	JMS Message	Notes
`application-properties.JMSXGroupID`	`JMSXGroupID`
`application-properties.JMSXGroupSeq uence`	`JMSXGroupSequence`
`application-properties.JMSXUserID`	`JMSXUserID`
`application-properties.name`	`name`
`delivery-annotations.name`	`JMS_AMQP_DA_name`
`footer.name`	`JMS_AMQP_FT_name`
`header.deliveryCount`	`JMSXDeliveryCount`
`header.durable`	`JMSDeliveryMode`	`javax.jms.Message.DEFAULT_DELIVERY_MODE` if not set.
`header.first-acquirer`	`JMS_AMQP_FirstAcquirer`
`header.priority`	`JMSPriority`	`javax.jms.Message.DEFAULT_PRIORITY` if not set.
`header.ttl`	`JMSExpiration`	`javax.jms.Message.DEFAULT_TIME_TO_LIVE` if not set.
`message-annotations.name`	`JMS_AMQP_MA_name`
`message-annotations.x-opt-jms-type`	`JMSType`
`message-annotations.x-opt-reply-type`	Type of the `JMSReplyTo`	Comma separated list of `queue`, `topic`, or `temporary`. Defaults to `queue` if not set.
`messag e-annotations.x-opt-to-type`	Type of the `JMSDestination`	Comma separated list of `queue`, `topic`, or `temporary`. Defaults to `queue` if not set.
`properties.content-encoding`	`JMS_AMQP_ContentEncoding`
`properties.content-type`	`JMS_AMQP_ContentType`
`properties.correlation-id`	`JMSCorrelationID`
`properties.creation-time`	`JMSTimestamp`
`properties.group-sequence`	`JMSXGroupSequence`
`properties.message-id`	`JMSMessageID`	Auto generated if not set.
`properties.reply-to`	`JMSReplyTo`	The name of the `JMSReplyTo`
`properties.reply-to-group-id`	`JMS_AMQP_ReplyToGroupID`
`properties.subject`	`JMS_AMQP_Subject`
`properties.to`	`JMSDestination`	The name of the `JMSDestination`
`properties.user-id`	`JMSXUserID`	`properties.user-id` is decoded as a UTF-8 String.

AMQP property value types are converted as follows:

AMQP Type	Java Type	Notes
`binary`	`String`	Hex encoding of the binary value
`bool`	`Boolean`
`byte`	`Byte`
`double`	`Double`
`float`	`Floa t`
`int`	`Integer`
`long`	`Long`
`short`	`Short`
`symbol`	`String`
`ubyte`	`Byte` or `Short`	`Short` is used if: `value >` `Byte.MAX_VALUE`
`uint`	`Integer` or `Long`	`Long` is used if: `value >` `Integer.MAX_VALUE`
`ulong`	`Long`
`ushort`	`Short` or `Integer`	`Integer` is used if: `value >` `Short.MAX_VALUE`

How a AMQP Messages Body is Mapped to a JMS Message

If the transformer is set to jms then the JMS message type will depend on the body type of the AMQP message.

Body Type	JMS Message Type
AmqpSequence	`StreamMessage`
`AmqpValue`	`ObjectMessage`
`AmqpValue` holding a `null`	`Message`
`AmqpValue` holding a `String`	`TextMessage`
`AmqpValue` holding a `binary`	`BytesMessage`
`Amq pValue` holding a `list`	`StreamMessage`
`Data`	`BytesMessage`
`null`	`Message`

AMQP 1.0 client library

You can use Apache Qpid Proton.

Parameter Name	Default Value	Description
`maxDataLength`	`104857600`	Maximum size of the message body (content) that can be sent.
`maxFrameSize`	(v5.12.0) Maximum frame size that can be sent. A Stomp frame includes a command, optional headers, and an optional body. Can help help prevent OOM DOS attacks

Parameter Name	Default Value	Description
`maxDataLength`	`104857600`	Maximum size of the message body (content) that can be sent.
`maxFrameSize`	(v5.12.0) Maximum frame size that can be sent. A Stomp frame includes a command, optional headers, and an optional body. Can help help prevent OOM DOS attacks

Inclusion of content-length header	Resulting Message
yes	`BytesMessage`
no	`TextMessage`

Inclusion of content-length header	Resulting Message
yes	`BytesMessage`
no	`TextMessage`

Enabling the ActiveMQ Broker for AMQP

Enabling the ActiveMQ Broker for AMQP

Security

Enabling AMQP over NIO

Security

Enabling AMQP over NIO

Enabling AMQP over SSL

Enabling AMQP over SSL

Working with Destinations with AMQP

Prefetch size and credit

Mapping to JMS

Working with Destinations with AMQP

Prefetch Size and Credit

Mapping to JMS

How AMQP message headers are mapped to JMS Headers:

How AMQP messages bodies are mapped to JMS Messages:

AMQP 1.0 client library

How AMQP Message Headers are Mapped to JMS Headers

How a AMQP Messages Body is Mapped to a JMS Message

AMQP 1.0 client library

Enabling the ActiveMQ Broker for Stomp

Enabling the ActiveMQ Broker for Stomp

The Stomp Wire Format

Example Wire Format Configuration

The Stomp Wire Format

Security

Enabling Stomp over NIO

Security

Enabling Stomp over NIO

Enabling Stomp over SSL

Enabling Stomp over SSL

Heart-beat grace periods

Heart-beat grace periods

Working with Destinations with Stomp

Persistence of Stomp messages

Message transformations

Working with Destinations with Stomp

Working with JMS Text/Bytes Messages and Stomp

Message transformations