org.apache.activemq.artemis.protocol.amqp.converter

Class AMQPMessageSupport

java.lang.Object

org.apache.activemq.artemis.protocol.amqp.converter.AMQPMessageSupport

public final class AMQPMessageSupport
extends Object

Support class containing constant values and static methods that are used to map to / from AMQP Message types being sent or received.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AMQ_PROPERTY_PREFIX
static short	AMQP_DATA
static short	AMQP_NULL
static short	AMQP_SEQUENCE
static short	AMQP_UNKNOWN
static short	AMQP_VALUE_BINARY
static short	AMQP_VALUE_LIST
static short	AMQP_VALUE_MAP
static short	AMQP_VALUE_NULL
static short	AMQP_VALUE_STRING
static String	CONTENT_ENCODING
static String	CONTENT_TYPE
static String	DELIVERY_ANNOTATION_PREFIX
static String	DURABLE
static org.apache.qpid.proton.amqp.Binary	EMPTY_BINARY
static org.apache.qpid.proton.amqp.messaging.Data	EMPTY_BODY
static String	ENCODED_PREFIX
static String	FIRST_ACQUIRER
static String	FOOTER_PREFIX
static SimpleString	HDR_ORIGINAL_ADDRESS_ANNOTATION
static String	HEADER
static org.apache.qpid.proton.amqp.Symbol	INGRESS_TIME_MSG_ANNOTATION
static String	JMS_AMQP_CONTENT_ENCODING
static String	JMS_AMQP_CONTENT_TYPE
static String	JMS_AMQP_DELIVERY_ANNOTATION_PREFIX
static String	JMS_AMQP_ENCODED_DELIVERY_ANNOTATION_PREFIX
static String	JMS_AMQP_ENCODED_FOOTER_PREFIX
static String	JMS_AMQP_ENCODED_MESSAGE_ANNOTATION_PREFIX
static String	JMS_AMQP_FIRST_ACQUIRER
static String	JMS_AMQP_FOOTER_PREFIX
static String	JMS_AMQP_HEADER
static String	JMS_AMQP_HEADER_DURABLE
static String	JMS_AMQP_HEADER_PRIORITY
static String	JMS_AMQP_MESSAGE_ANNOTATION_PREFIX
static String	JMS_AMQP_NATIVE
static String	JMS_AMQP_ORIGINAL_ENCODING
static String	JMS_AMQP_PREFIX
static int	JMS_AMQP_PREFIX_LENGTH
static String	JMS_AMQP_PROPERTIES
static String	JMS_AMQP_REPLYTO_GROUP_ID
static byte	JMS_BYTES_MESSAGE Value mapping for JMS_MSG_TYPE which indicates the message is a JMS BytesMessage which has a body that consists of raw bytes.
static org.apache.qpid.proton.amqp.Symbol	JMS_DELIVERY_TIME Deprecated. Use the SCHEDULED_DELIVERY_TIME value as this is not JMS specific and will be removed.
static org.apache.qpid.proton.amqp.Symbol	JMS_DEST_TYPE_MSG_ANNOTATION
static byte	JMS_MAP_MESSAGE Value mapping for JMS_MSG_TYPE which indicates the message is a JMS MapMessage which has an Map instance serialized in its message body.
static byte	JMS_MESSAGE Value mapping for JMS_MSG_TYPE which indicates the message is a generic JMS Message which has no body.
static org.apache.qpid.proton.amqp.Symbol	JMS_MSG_TYPE Attribute used to mark the class type of JMS message that a particular message instance represents, used internally by the client.
static byte	JMS_OBJECT_MESSAGE Value mapping for JMS_MSG_TYPE which indicates the message is a JMS ObjectMessage which has an Object value serialized in its message body.
static org.apache.qpid.proton.amqp.Symbol	JMS_REPLY_TO_TYPE_MSG_ANNOTATION
static String	JMS_REPLY_TO_TYPE_MSG_ANNOTATION_SYMBOL_NAME
static byte	JMS_STREAM_MESSAGE Value mapping for JMS_MSG_TYPE which indicates the message is a JMS StreamMessage which has a body that is a structured collection of primitives values.
static byte	JMS_TEXT_MESSAGE Value mapping for JMS_MSG_TYPE which indicates the message is a JMS TextMessage which has a body that contains a UTF-8 encoded String.
static String	MESSAGE_ANNOTATION_PREFIX
static int	MESSAGE_DEFAULT_PRIORITY
static long	MESSAGE_DEFAULT_TIME_TO_LIVE
static String	NATIVE
static int	NON_PERSISTENT
static String	OCTET_STREAM_CONTENT_TYPE Content type used to mark Data sections as containing arbitrary bytes.
static String	ORIGINAL_ENCODING
static int	PERSISTENT
static String	PRIORITY
static String	PROPERTIES
static byte	QUEUE_TYPE
static String	REPLYTO_GROUP_ID
static org.apache.qpid.proton.amqp.Symbol	ROUTING_TYPE Attribute used to mark the Application defined delivery time assigned to the message
static org.apache.qpid.proton.amqp.Symbol	SCHEDULED_DELIVERY_DELAY Attribute used to mark the Application defined delivery time assigned to the message
static org.apache.qpid.proton.amqp.Symbol	SCHEDULED_DELIVERY_TIME Attribute used to mark the Application defined delivery time assigned to the message
static org.apache.qpid.proton.amqp.Symbol	SERIALIZED_JAVA_OBJECT_CONTENT_TYPE Content type used to mark Data sections as containing a serialized java object.
static byte	TEMP_QUEUE_TYPE
static byte	TEMP_TOPIC_TYPE
static byte	TOPIC_TYPE
static String	X_OPT_INGRESS_TIME
static String	X_OPT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AMQPMessageSupport()

Method Summary

Modifier and Type	Method and Description
static CoreBytesMessageWrapper	createBytesMessage(long id, byte[] array, int arrayOffset, int length, CoreMessageObjectPools coreMessageObjectPools)
static CoreBytesMessageWrapper	createBytesMessage(long id, CoreMessageObjectPools coreMessageObjectPools)
static CoreMapMessageWrapper	createMapMessage(long id, CoreMessageObjectPools coreMessageObjectPools)
static CoreMapMessageWrapper	createMapMessage(long id, Map<String,Object> content, CoreMessageObjectPools coreMessageObjectPools)
static CoreMessageWrapper	createMessage(long id, CoreMessageObjectPools coreMessageObjectPools)
static CoreMessageWrapper	createObjectMessage(long id, org.apache.qpid.proton.amqp.Binary serializedForm, CoreMessageObjectPools coreMessageObjectPools)
static CoreMessageWrapper	createObjectMessage(long id, byte[] array, int offset, int length, CoreMessageObjectPools coreMessageObjectPools)
static CoreObjectMessageWrapper	createObjectMessage(long id, CoreMessageObjectPools coreMessageObjectPools)
static CoreStreamMessageWrapper	createStreamMessage(long id, CoreMessageObjectPools coreMessageObjectPools)
static CoreTextMessageWrapper	createTextMessage(long id, CoreMessageObjectPools coreMessageObjectPools)
static CoreTextMessageWrapper	createTextMessage(long id, String text, CoreMessageObjectPools coreMessageObjectPools)
static String	destination(RoutingType destinationType, String address)
static byte	destinationType(String destination)
static Charset	getCharsetForTextualContent(String contentType)
static Object	getMessageAnnotation(String key, org.apache.qpid.proton.message.Message message) Safe way to access message annotations which will check internal structure and either return the annotation if it exists or null if the annotation or any annotations are present.
static org.apache.qpid.proton.amqp.Symbol	getSymbol(String key) Lookup and return the correct Proton Symbol instance based on the given key.
static boolean	isContentType(String contentType, org.apache.qpid.proton.message.Message message) Check whether the content-type field of the properties section (if present) in the given message matches the provided string (where null matches if there is no content type present.
static boolean	isContentType(String expected, org.apache.qpid.proton.amqp.Symbol actual) Check whether the content-type given matches the expect value.
static String	toAddress(String destination)
static String	toAnnotationName(String key)

Methods inherited from class java.lang.Object

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

Field Detail

NON_PERSISTENT

public static final int NON_PERSISTENT

See Also:

Constant Field Values

PERSISTENT

public static final int PERSISTENT

See Also:

Constant Field Values

MESSAGE_DEFAULT_TIME_TO_LIVE

public static final long MESSAGE_DEFAULT_TIME_TO_LIVE

See Also:

Constant Field Values

MESSAGE_DEFAULT_PRIORITY

public static final int MESSAGE_DEFAULT_PRIORITY

See Also:

Constant Field Values

HDR_ORIGINAL_ADDRESS_ANNOTATION

public static SimpleString HDR_ORIGINAL_ADDRESS_ANNOTATION

JMS_REPLY_TO_TYPE_MSG_ANNOTATION_SYMBOL_NAME

public static final String JMS_REPLY_TO_TYPE_MSG_ANNOTATION_SYMBOL_NAME

See Also:

Constant Field Values

JMS_MSG_TYPE

public static final org.apache.qpid.proton.amqp.Symbol JMS_MSG_TYPE

Attribute used to mark the class type of JMS message that a particular message instance represents, used internally by the client.

JMS_DELIVERY_TIME

@Deprecated
public static final org.apache.qpid.proton.amqp.Symbol JMS_DELIVERY_TIME

Deprecated. Use the SCHEDULED_DELIVERY_TIME value as this is not JMS specific and will be removed.

Attribute used to mark the Application defined delivery time assigned to the message

SCHEDULED_DELIVERY_TIME

public static final org.apache.qpid.proton.amqp.Symbol SCHEDULED_DELIVERY_TIME

Attribute used to mark the Application defined delivery time assigned to the message

SCHEDULED_DELIVERY_DELAY

public static final org.apache.qpid.proton.amqp.Symbol SCHEDULED_DELIVERY_DELAY

Attribute used to mark the Application defined delivery time assigned to the message

ROUTING_TYPE

public static final org.apache.qpid.proton.amqp.Symbol ROUTING_TYPE

Attribute used to mark the Application defined delivery time assigned to the message

JMS_MESSAGE

public static final byte JMS_MESSAGE

Value mapping for JMS_MSG_TYPE which indicates the message is a generic JMS Message which has no body.

See Also:

Constant Field Values

JMS_OBJECT_MESSAGE

public static final byte JMS_OBJECT_MESSAGE

Value mapping for JMS_MSG_TYPE which indicates the message is a JMS ObjectMessage which has an Object value serialized in its message body.

See Also:

Constant Field Values

JMS_MAP_MESSAGE

public static final byte JMS_MAP_MESSAGE

Value mapping for JMS_MSG_TYPE which indicates the message is a JMS MapMessage which has an Map instance serialized in its message body.

See Also:

Constant Field Values

JMS_BYTES_MESSAGE

public static final byte JMS_BYTES_MESSAGE

Value mapping for JMS_MSG_TYPE which indicates the message is a JMS BytesMessage which has a body that consists of raw bytes.

See Also:

Constant Field Values

JMS_STREAM_MESSAGE

public static final byte JMS_STREAM_MESSAGE

Value mapping for JMS_MSG_TYPE which indicates the message is a JMS StreamMessage which has a body that is a structured collection of primitives values.

See Also:

Constant Field Values

JMS_TEXT_MESSAGE

public static final byte JMS_TEXT_MESSAGE

Value mapping for JMS_MSG_TYPE which indicates the message is a JMS TextMessage which has a body that contains a UTF-8 encoded String.

See Also:

Constant Field Values

SERIALIZED_JAVA_OBJECT_CONTENT_TYPE

public static final org.apache.qpid.proton.amqp.Symbol SERIALIZED_JAVA_OBJECT_CONTENT_TYPE

Content type used to mark Data sections as containing a serialized java object.

JMS_AMQP_PREFIX

public static final String JMS_AMQP_PREFIX

See Also:

Constant Field Values

JMS_AMQP_PREFIX_LENGTH

public static final int JMS_AMQP_PREFIX_LENGTH

ORIGINAL_ENCODING

public static final String ORIGINAL_ENCODING

See Also:

Constant Field Values

NATIVE

public static final String NATIVE

See Also:

Constant Field Values

HEADER

public static final String HEADER

See Also:

Constant Field Values

PROPERTIES

public static final String PROPERTIES

See Also:

Constant Field Values

FIRST_ACQUIRER

public static final String FIRST_ACQUIRER

See Also:

Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

CONTENT_ENCODING

public static final String CONTENT_ENCODING

See Also:

Constant Field Values

REPLYTO_GROUP_ID

public static final String REPLYTO_GROUP_ID

See Also:

Constant Field Values

DURABLE

public static final String DURABLE

See Also:

Constant Field Values

PRIORITY

public static final String PRIORITY

See Also:

Constant Field Values

DELIVERY_ANNOTATION_PREFIX

public static final String DELIVERY_ANNOTATION_PREFIX

See Also:

Constant Field Values

MESSAGE_ANNOTATION_PREFIX

public static final String MESSAGE_ANNOTATION_PREFIX

See Also:

Constant Field Values

FOOTER_PREFIX

public static final String FOOTER_PREFIX

See Also:

Constant Field Values

ENCODED_PREFIX

public static final String ENCODED_PREFIX

See Also:

Constant Field Values

JMS_AMQP_HEADER

public static final String JMS_AMQP_HEADER

See Also:

Constant Field Values

JMS_AMQP_HEADER_DURABLE

public static final String JMS_AMQP_HEADER_DURABLE

See Also:

Constant Field Values

JMS_AMQP_HEADER_PRIORITY

public static final String JMS_AMQP_HEADER_PRIORITY

See Also:

Constant Field Values

JMS_AMQP_PROPERTIES

public static final String JMS_AMQP_PROPERTIES

See Also:

Constant Field Values

JMS_AMQP_NATIVE

public static final String JMS_AMQP_NATIVE

See Also:

Constant Field Values

JMS_AMQP_FIRST_ACQUIRER

public static final String JMS_AMQP_FIRST_ACQUIRER

See Also:

Constant Field Values

JMS_AMQP_CONTENT_TYPE

public static final String JMS_AMQP_CONTENT_TYPE

See Also:

Constant Field Values

JMS_AMQP_CONTENT_ENCODING

public static final String JMS_AMQP_CONTENT_ENCODING

See Also:

Constant Field Values

JMS_AMQP_REPLYTO_GROUP_ID

public static final String JMS_AMQP_REPLYTO_GROUP_ID

See Also:

Constant Field Values

JMS_AMQP_DELIVERY_ANNOTATION_PREFIX

public static final String JMS_AMQP_DELIVERY_ANNOTATION_PREFIX

See Also:

Constant Field Values

JMS_AMQP_MESSAGE_ANNOTATION_PREFIX

public static final String JMS_AMQP_MESSAGE_ANNOTATION_PREFIX

See Also:

Constant Field Values

JMS_AMQP_FOOTER_PREFIX

public static final String JMS_AMQP_FOOTER_PREFIX

See Also:

Constant Field Values

JMS_AMQP_ENCODED_DELIVERY_ANNOTATION_PREFIX

public static final String JMS_AMQP_ENCODED_DELIVERY_ANNOTATION_PREFIX

See Also:

Constant Field Values

JMS_AMQP_ENCODED_MESSAGE_ANNOTATION_PREFIX

public static final String JMS_AMQP_ENCODED_MESSAGE_ANNOTATION_PREFIX

See Also:

Constant Field Values

JMS_AMQP_ENCODED_FOOTER_PREFIX

public static final String JMS_AMQP_ENCODED_FOOTER_PREFIX

See Also:

Constant Field Values

JMS_AMQP_ORIGINAL_ENCODING

public static final String JMS_AMQP_ORIGINAL_ENCODING

See Also:

Constant Field Values

EMPTY_BINARY

public static final org.apache.qpid.proton.amqp.Binary EMPTY_BINARY

EMPTY_BODY

public static final org.apache.qpid.proton.amqp.messaging.Data EMPTY_BODY

X_OPT_PREFIX

public static final String X_OPT_PREFIX

See Also:

Constant Field Values

AMQ_PROPERTY_PREFIX

public static final String AMQ_PROPERTY_PREFIX

See Also:

Constant Field Values

X_OPT_INGRESS_TIME

public static final String X_OPT_INGRESS_TIME

See Also:

Constant Field Values

AMQP_UNKNOWN

public static final short AMQP_UNKNOWN

See Also:

Constant Field Values

AMQP_NULL

public static final short AMQP_NULL

See Also:

Constant Field Values

AMQP_DATA

public static final short AMQP_DATA

See Also:

Constant Field Values

AMQP_SEQUENCE

public static final short AMQP_SEQUENCE

See Also:

Constant Field Values

AMQP_VALUE_NULL

public static final short AMQP_VALUE_NULL

See Also:

Constant Field Values

AMQP_VALUE_STRING

public static final short AMQP_VALUE_STRING

See Also:

Constant Field Values

AMQP_VALUE_BINARY

public static final short AMQP_VALUE_BINARY

See Also:

Constant Field Values

AMQP_VALUE_MAP

public static final short AMQP_VALUE_MAP

See Also:

Constant Field Values

AMQP_VALUE_LIST

public static final short AMQP_VALUE_LIST

See Also:

Constant Field Values

JMS_DEST_TYPE_MSG_ANNOTATION

public static final org.apache.qpid.proton.amqp.Symbol JMS_DEST_TYPE_MSG_ANNOTATION

JMS_REPLY_TO_TYPE_MSG_ANNOTATION

public static final org.apache.qpid.proton.amqp.Symbol JMS_REPLY_TO_TYPE_MSG_ANNOTATION

INGRESS_TIME_MSG_ANNOTATION

public static final org.apache.qpid.proton.amqp.Symbol INGRESS_TIME_MSG_ANNOTATION

QUEUE_TYPE

public static final byte QUEUE_TYPE

See Also:

Constant Field Values

TOPIC_TYPE

public static final byte TOPIC_TYPE

See Also:

Constant Field Values

TEMP_QUEUE_TYPE

public static final byte TEMP_QUEUE_TYPE

See Also:

Constant Field Values

TEMP_TOPIC_TYPE

public static final byte TEMP_TOPIC_TYPE

See Also:

Constant Field Values

OCTET_STREAM_CONTENT_TYPE

public static final String OCTET_STREAM_CONTENT_TYPE

Content type used to mark Data sections as containing arbitrary bytes.

See Also:

Constant Field Values

Constructor Detail

AMQPMessageSupport

public AMQPMessageSupport()

Method Detail

getSymbol

public static org.apache.qpid.proton.amqp.Symbol getSymbol(String key)

Lookup and return the correct Proton Symbol instance based on the given key.

Parameters:

key - the String value name of the Symbol to locate.

Returns:

the Symbol value that matches the given key.

getMessageAnnotation

public static Object getMessageAnnotation(String key,
                                          org.apache.qpid.proton.message.Message message)

Safe way to access message annotations which will check internal structure and either return the annotation if it exists or null if the annotation or any annotations are present.

Parameters:

key - the String key to use to lookup an annotation.

message - the AMQP message object that is being examined.

Returns:

the given annotation value or null if not present in the message.

isContentType

public static boolean isContentType(String contentType,
                                    org.apache.qpid.proton.message.Message message)

Check whether the content-type field of the properties section (if present) in the given message matches the provided string (where null matches if there is no content type present.

Parameters:

contentType - content type string to compare against, or null if none

message - the AMQP message object that is being examined.

Returns:

true if content type matches

isContentType

public static boolean isContentType(String expected,
                                    org.apache.qpid.proton.amqp.Symbol actual)

Check whether the content-type given matches the expect value.

Parameters:

expected - content type string to compare against or null if not expected to be set

actual - the AMQP content type symbol from the Properties section

Returns:

true if content type matches

getCharsetForTextualContent

public static Charset getCharsetForTextualContent(String contentType)

Parameters:

contentType - the contentType of the received message

Returns:

the character set to use, or null if not to treat the message as text

toAnnotationName

public static String toAnnotationName(String key)

createBytesMessage

public static CoreBytesMessageWrapper createBytesMessage(long id,
                                                         CoreMessageObjectPools coreMessageObjectPools)

createBytesMessage

public static CoreBytesMessageWrapper createBytesMessage(long id,
                                                         byte[] array,
                                                         int arrayOffset,
                                                         int length,
                                                         CoreMessageObjectPools coreMessageObjectPools)

createStreamMessage

public static CoreStreamMessageWrapper createStreamMessage(long id,
                                                           CoreMessageObjectPools coreMessageObjectPools)

createMessage

public static CoreMessageWrapper createMessage(long id,
                                               CoreMessageObjectPools coreMessageObjectPools)

createTextMessage

public static CoreTextMessageWrapper createTextMessage(long id,
                                                       CoreMessageObjectPools coreMessageObjectPools)

createTextMessage

public static CoreTextMessageWrapper createTextMessage(long id,
                                                       String text,
                                                       CoreMessageObjectPools coreMessageObjectPools)

createObjectMessage

public static CoreObjectMessageWrapper createObjectMessage(long id,
                                                           CoreMessageObjectPools coreMessageObjectPools)

createObjectMessage

public static CoreMessageWrapper createObjectMessage(long id,
                                                     org.apache.qpid.proton.amqp.Binary serializedForm,
                                                     CoreMessageObjectPools coreMessageObjectPools)

createObjectMessage

public static CoreMessageWrapper createObjectMessage(long id,
                                                     byte[] array,
                                                     int offset,
                                                     int length,
                                                     CoreMessageObjectPools coreMessageObjectPools)

createMapMessage

public static CoreMapMessageWrapper createMapMessage(long id,
                                                     CoreMessageObjectPools coreMessageObjectPools)

createMapMessage

public static CoreMapMessageWrapper createMapMessage(long id,
                                                     Map<String,Object> content,
                                                     CoreMessageObjectPools coreMessageObjectPools)

toAddress

public static String toAddress(String destination)

destinationType

public static byte destinationType(String destination)

destination

public static String destination(RoutingType destinationType,
                                 String address)