java.lang.Object
- org.apache.activemq.artemis.ra.ActiveMQRAMessage

All Implemented Interfaces:

jakarta.jms.Message

Direct Known Subclasses:

ActiveMQRABytesMessage, ActiveMQRAMapMessage, ActiveMQRAObjectMessage, ActiveMQRAStreamMessage, ActiveMQRATextMessage
```
public class ActiveMQRAMessage
extends java.lang.Object
implements jakarta.jms.Message
```
A wrapper for a message

Field Summary

Fields
Modifier and Type Field Description

protected jakarta.jms.Message message
The message

protected ActiveMQRASession session
The session
- Fields inherited from interface jakarta.jms.Message
  DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors
Constructor Description

ActiveMQRAMessage(jakarta.jms.Message message, ActiveMQRASession session)
Create a new wrapper

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`acknowledge()`	Acknowledge
`void`	`clearBody()`	Clear body
`void`	`clearProperties()`	Clear properties
`boolean`	`equals(java.lang.Object object)`	Check for equality
`<T> T`	`getBody(java.lang.Class<T> c)`
`boolean`	`getBooleanProperty(java.lang.String name)`	Get property
`byte`	`getByteProperty(java.lang.String name)`	Get property
`double`	`getDoubleProperty(java.lang.String name)`	Get property
`float`	`getFloatProperty(java.lang.String name)`	Get property
`int`	`getIntProperty(java.lang.String name)`	Get property
`java.lang.String`	`getJMSCorrelationID()`	Get correlation id
`byte[]`	`getJMSCorrelationIDAsBytes()`	Get correlation id
`int`	`getJMSDeliveryMode()`	Get delivery mode
`long`	`getJMSDeliveryTime()`
`jakarta.jms.Destination`	`getJMSDestination()`	Get destination
`long`	`getJMSExpiration()`	Get expiration
`java.lang.String`	`getJMSMessageID()`	Get message id
`int`	`getJMSPriority()`	Get priority
`boolean`	`getJMSRedelivered()`	Get redelivered status
`jakarta.jms.Destination`	`getJMSReplyTo()`	Get reply to destination
`long`	`getJMSTimestamp()`	Get timestamp
`java.lang.String`	`getJMSType()`	Get type
`long`	`getLongProperty(java.lang.String name)`	Get property
`java.lang.Object`	`getObjectProperty(java.lang.String name)`	Get property
`java.util.Enumeration`	`getPropertyNames()`	Get property names
`short`	`getShortProperty(java.lang.String name)`	Get property
`java.lang.String`	`getStringProperty(java.lang.String name)`	Get property
`int`	`hashCode()`	Return the hash code
`boolean`	`isBodyAssignableTo(java.lang.Class c)`
`boolean`	`propertyExists(java.lang.String name)`	Do property exist
`void`	`setBooleanProperty(java.lang.String name, boolean value)`	Set property
`void`	`setByteProperty(java.lang.String name, byte value)`	Set property
`void`	`setDoubleProperty(java.lang.String name, double value)`	Set property
`void`	`setFloatProperty(java.lang.String name, float value)`	Set property
`void`	`setIntProperty(java.lang.String name, int value)`	Set property
`void`	`setJMSCorrelationID(java.lang.String correlationID)`	Set correlation id
`void`	`setJMSCorrelationIDAsBytes(byte[] correlationID)`	Set correlation id
`void`	`setJMSDeliveryMode(int deliveryMode)`	Set delivery mode
`void`	`setJMSDeliveryTime(long deliveryTime)`
`void`	`setJMSDestination(jakarta.jms.Destination destination)`	Set destination
`void`	`setJMSExpiration(long expiration)`	Set expiration
`void`	`setJMSMessageID(java.lang.String id)`	Set message id
`void`	`setJMSPriority(int priority)`	Set priority
`void`	`setJMSRedelivered(boolean redelivered)`	Set redelivered status
`void`	`setJMSReplyTo(jakarta.jms.Destination replyTo)`	Set reply to
`void`	`setJMSTimestamp(long timestamp)`	Set timestamp
`void`	`setJMSType(java.lang.String type)`	Set type
`void`	`setLongProperty(java.lang.String name, long value)`	Set property
`void`	`setObjectProperty(java.lang.String name, java.lang.Object value)`	Set property
`void`	`setShortProperty(java.lang.String name, short value)`	Set property
`void`	`setStringProperty(java.lang.String name, java.lang.String value)`	Set property
`java.lang.String`	`toString()`	Return string representation

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - message
```
protected jakarta.jms.Message message
```
    The message
  - session
```
protected ActiveMQRASession session
```
    The session
- Constructor Detail
  - ActiveMQRAMessage
```
public ActiveMQRAMessage(jakarta.jms.Message message,
                         ActiveMQRASession session)
```
    Create a new wrapper
    
    Parameters:
    
    message - the message
    
    session - the session
- Method Detail
  - acknowledge
```
public void acknowledge()
                 throws jakarta.jms.JMSException
```
    Acknowledge
    
    Specified by:
    
    acknowledge in interface jakarta.jms.Message
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - clearBody
```
public void clearBody()
               throws jakarta.jms.JMSException
```
    Clear body
    
    Specified by:
    
    clearBody in interface jakarta.jms.Message
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - clearProperties
```
public void clearProperties()
                     throws jakarta.jms.JMSException
```
    Clear properties
    
    Specified by:
    
    clearProperties in interface jakarta.jms.Message
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getBooleanProperty
```
public boolean getBooleanProperty(java.lang.String name)
                           throws jakarta.jms.JMSException
```
    Get property
    
    Specified by:
    
    getBooleanProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getByteProperty
```
public byte getByteProperty(java.lang.String name)
                     throws jakarta.jms.JMSException
```
    Get property
    
    Specified by:
    
    getByteProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getDoubleProperty
```
public double getDoubleProperty(java.lang.String name)
                         throws jakarta.jms.JMSException
```
    Get property
    
    Specified by:
    
    getDoubleProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getFloatProperty
```
public float getFloatProperty(java.lang.String name)
                       throws jakarta.jms.JMSException
```
    Get property
    
    Specified by:
    
    getFloatProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getIntProperty
```
public int getIntProperty(java.lang.String name)
                   throws jakarta.jms.JMSException
```
    Get property
    
    Specified by:
    
    getIntProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getJMSCorrelationID
```
public java.lang.String getJMSCorrelationID()
                                     throws jakarta.jms.JMSException
```
    Get correlation id
    
    Specified by:
    
    getJMSCorrelationID in interface jakarta.jms.Message
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getJMSCorrelationIDAsBytes
```
public byte[] getJMSCorrelationIDAsBytes()
                                  throws jakarta.jms.JMSException
```
    Get correlation id
    
    Specified by:
    
    getJMSCorrelationIDAsBytes in interface jakarta.jms.Message
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getJMSDeliveryMode
```
public int getJMSDeliveryMode()
                       throws jakarta.jms.JMSException
```
    Get delivery mode
    
    Specified by:
    
    getJMSDeliveryMode in interface jakarta.jms.Message
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getJMSDestination
```
public jakarta.jms.Destination getJMSDestination()
                                          throws jakarta.jms.JMSException
```
    Get destination
    
    Specified by:
    
    getJMSDestination in interface jakarta.jms.Message
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getJMSExpiration
```
public long getJMSExpiration()
                      throws jakarta.jms.JMSException
```
    Get expiration
    
    Specified by:
    
    getJMSExpiration in interface jakarta.jms.Message
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getJMSMessageID
```
public java.lang.String getJMSMessageID()
                                 throws jakarta.jms.JMSException
```
    Get message id
    
    Specified by:
    
    getJMSMessageID in interface jakarta.jms.Message
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getJMSPriority
```
public int getJMSPriority()
                   throws jakarta.jms.JMSException
```
    Get priority
    
    Specified by:
    
    getJMSPriority in interface jakarta.jms.Message
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getJMSRedelivered
```
public boolean getJMSRedelivered()
                          throws jakarta.jms.JMSException
```
    Get redelivered status
    
    Specified by:
    
    getJMSRedelivered in interface jakarta.jms.Message
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getJMSReplyTo
```
public jakarta.jms.Destination getJMSReplyTo()
                                      throws jakarta.jms.JMSException
```
    Get reply to destination
    
    Specified by:
    
    getJMSReplyTo in interface jakarta.jms.Message
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getJMSTimestamp
```
public long getJMSTimestamp()
                     throws jakarta.jms.JMSException
```
    Get timestamp
    
    Specified by:
    
    getJMSTimestamp in interface jakarta.jms.Message
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getJMSType
```
public java.lang.String getJMSType()
                            throws jakarta.jms.JMSException
```
    Get type
    
    Specified by:
    
    getJMSType in interface jakarta.jms.Message
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getLongProperty
```
public long getLongProperty(java.lang.String name)
                     throws jakarta.jms.JMSException
```
    Get property
    
    Specified by:
    
    getLongProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getObjectProperty
```
public java.lang.Object getObjectProperty(java.lang.String name)
                                   throws jakarta.jms.JMSException
```
    Get property
    
    Specified by:
    
    getObjectProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getPropertyNames
```
public java.util.Enumeration getPropertyNames()
                                       throws jakarta.jms.JMSException
```
    Get property names
    
    Specified by:
    
    getPropertyNames in interface jakarta.jms.Message
    
    Returns:
    
    The values
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getShortProperty
```
public short getShortProperty(java.lang.String name)
                       throws jakarta.jms.JMSException
```
    Get property
    
    Specified by:
    
    getShortProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getStringProperty
```
public java.lang.String getStringProperty(java.lang.String name)
                                   throws jakarta.jms.JMSException
```
    Get property
    
    Specified by:
    
    getStringProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - propertyExists
```
public boolean propertyExists(java.lang.String name)
                       throws jakarta.jms.JMSException
```
    Do property exist
    
    Specified by:
    
    propertyExists in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    Returns:
    
    The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setBooleanProperty
```
public void setBooleanProperty(java.lang.String name,
                               boolean value)
                        throws jakarta.jms.JMSException
```
    Set property
    
    Specified by:
    
    setBooleanProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    value - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setByteProperty
```
public void setByteProperty(java.lang.String name,
                            byte value)
                     throws jakarta.jms.JMSException
```
    Set property
    
    Specified by:
    
    setByteProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    value - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setDoubleProperty
```
public void setDoubleProperty(java.lang.String name,
                              double value)
                       throws jakarta.jms.JMSException
```
    Set property
    
    Specified by:
    
    setDoubleProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    value - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setFloatProperty
```
public void setFloatProperty(java.lang.String name,
                             float value)
                      throws jakarta.jms.JMSException
```
    Set property
    
    Specified by:
    
    setFloatProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    value - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setIntProperty
```
public void setIntProperty(java.lang.String name,
                           int value)
                    throws jakarta.jms.JMSException
```
    Set property
    
    Specified by:
    
    setIntProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    value - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setJMSCorrelationID
```
public void setJMSCorrelationID(java.lang.String correlationID)
                         throws jakarta.jms.JMSException
```
    Set correlation id
    
    Specified by:
    
    setJMSCorrelationID in interface jakarta.jms.Message
    
    Parameters:
    
    correlationID - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setJMSCorrelationIDAsBytes
```
public void setJMSCorrelationIDAsBytes(byte[] correlationID)
                                throws jakarta.jms.JMSException
```
    Set correlation id
    
    Specified by:
    
    setJMSCorrelationIDAsBytes in interface jakarta.jms.Message
    
    Parameters:
    
    correlationID - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setJMSDeliveryMode
```
public void setJMSDeliveryMode(int deliveryMode)
                        throws jakarta.jms.JMSException
```
    Set delivery mode
    
    Specified by:
    
    setJMSDeliveryMode in interface jakarta.jms.Message
    
    Parameters:
    
    deliveryMode - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setJMSDestination
```
public void setJMSDestination(jakarta.jms.Destination destination)
                       throws jakarta.jms.JMSException
```
    Set destination
    
    Specified by:
    
    setJMSDestination in interface jakarta.jms.Message
    
    Parameters:
    
    destination - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setJMSExpiration
```
public void setJMSExpiration(long expiration)
                      throws jakarta.jms.JMSException
```
    Set expiration
    
    Specified by:
    
    setJMSExpiration in interface jakarta.jms.Message
    
    Parameters:
    
    expiration - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setJMSMessageID
```
public void setJMSMessageID(java.lang.String id)
                     throws jakarta.jms.JMSException
```
    Set message id
    
    Specified by:
    
    setJMSMessageID in interface jakarta.jms.Message
    
    Parameters:
    
    id - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setJMSPriority
```
public void setJMSPriority(int priority)
                    throws jakarta.jms.JMSException
```
    Set priority
    
    Specified by:
    
    setJMSPriority in interface jakarta.jms.Message
    
    Parameters:
    
    priority - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setJMSRedelivered
```
public void setJMSRedelivered(boolean redelivered)
                       throws jakarta.jms.JMSException
```
    Set redelivered status
    
    Specified by:
    
    setJMSRedelivered in interface jakarta.jms.Message
    
    Parameters:
    
    redelivered - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setJMSReplyTo
```
public void setJMSReplyTo(jakarta.jms.Destination replyTo)
                   throws jakarta.jms.JMSException
```
    Set reply to
    
    Specified by:
    
    setJMSReplyTo in interface jakarta.jms.Message
    
    Parameters:
    
    replyTo - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setJMSTimestamp
```
public void setJMSTimestamp(long timestamp)
                     throws jakarta.jms.JMSException
```
    Set timestamp
    
    Specified by:
    
    setJMSTimestamp in interface jakarta.jms.Message
    
    Parameters:
    
    timestamp - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setJMSType
```
public void setJMSType(java.lang.String type)
                throws jakarta.jms.JMSException
```
    Set type
    
    Specified by:
    
    setJMSType in interface jakarta.jms.Message
    
    Parameters:
    
    type - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setLongProperty
```
public void setLongProperty(java.lang.String name,
                            long value)
                     throws jakarta.jms.JMSException
```
    Set property
    
    Specified by:
    
    setLongProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    value - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setObjectProperty
```
public void setObjectProperty(java.lang.String name,
                              java.lang.Object value)
                       throws jakarta.jms.JMSException
```
    Set property
    
    Specified by:
    
    setObjectProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    value - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setShortProperty
```
public void setShortProperty(java.lang.String name,
                             short value)
                      throws jakarta.jms.JMSException
```
    Set property
    
    Specified by:
    
    setShortProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    value - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - setStringProperty
```
public void setStringProperty(java.lang.String name,
                              java.lang.String value)
                       throws jakarta.jms.JMSException
```
    Set property
    
    Specified by:
    
    setStringProperty in interface jakarta.jms.Message
    
    Parameters:
    
    name - The name
    
    value - The value
    
    Throws:
    
    jakarta.jms.JMSException - Thrown if an error occurs
  - getJMSDeliveryTime
```
public long getJMSDeliveryTime()
                        throws jakarta.jms.JMSException
```
    Specified by:
    
    getJMSDeliveryTime in interface jakarta.jms.Message
    
    Throws:
    
    jakarta.jms.JMSException
  - setJMSDeliveryTime
```
public void setJMSDeliveryTime(long deliveryTime)
                        throws jakarta.jms.JMSException
```
    Specified by:
    
    setJMSDeliveryTime in interface jakarta.jms.Message
    
    Throws:
    
    jakarta.jms.JMSException
  - getBody
```
public <T> T getBody(java.lang.Class<T> c)
              throws jakarta.jms.JMSException
```
    Specified by:
    
    getBody in interface jakarta.jms.Message
    
    Throws:
    
    jakarta.jms.JMSException
  - isBodyAssignableTo
```
public boolean isBodyAssignableTo(java.lang.Class c)
                           throws jakarta.jms.JMSException
```
    Specified by:
    
    isBodyAssignableTo in interface jakarta.jms.Message
    
    Throws:
    
    jakarta.jms.JMSException
  - hashCode
```
public int hashCode()
```
    Return the hash code
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    The hash code
  - equals
```
public boolean equals(java.lang.Object object)
```
    Check for equality
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - The other object
    
    Returns:
    
    True / false
  - toString
```
public java.lang.String toString()
```
    Return string representation
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The string

Modifier and Type	Field	Description
`protected jakarta.jms.Message`	`message`	The message
`protected ActiveMQRASession`	`session`	The session

Class ActiveMQRAMessage

Field Summary

Fields inherited from interface jakarta.jms.Message

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

message

session

Constructor Detail

ActiveMQRAMessage

Method Detail

acknowledge

clearBody

clearProperties

getBooleanProperty

getByteProperty

getDoubleProperty

getFloatProperty

getIntProperty

getJMSCorrelationID

getJMSCorrelationIDAsBytes

getJMSDeliveryMode

getJMSDestination

getJMSExpiration

getJMSMessageID

getJMSPriority

getJMSRedelivered

getJMSReplyTo

getJMSTimestamp

getJMSType

getLongProperty

getObjectProperty

getPropertyNames

getShortProperty

getStringProperty

propertyExists

setBooleanProperty

setByteProperty

setDoubleProperty

setFloatProperty

setIntProperty

setJMSCorrelationID

setJMSCorrelationIDAsBytes

setJMSDeliveryMode

setJMSDestination

setJMSExpiration

setJMSMessageID

setJMSPriority

setJMSRedelivered

setJMSReplyTo

setJMSTimestamp

setJMSType

setLongProperty

setObjectProperty

setShortProperty

setStringProperty

getJMSDeliveryTime

setJMSDeliveryTime

getBody

isBodyAssignableTo

hashCode

equals

toString