Package org.apache.activemq.artemis.jms.client

Class ActiveMQMessage

java.lang.Object

org.apache.activemq.artemis.jms.client.ActiveMQMessage

All Implemented Interfaces:

jakarta.jms.Message

Direct Known Subclasses:

ActiveMQBytesMessage, ActiveMQCompatibleMessage, ActiveMQMapMessage, ActiveMQObjectMessage, ActiveMQStreamMessage, ActiveMQTextMessage

public class ActiveMQMessage
extends Object
implements jakarta.jms.Message

ActiveMQ Artemis implementation of a JMS Message.
JMS Messages only live on the client side - the server only deals with MessageImpl instances

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientMessage	message
static SimpleString	OLD_QUEUE_QUALIFIED_PREFIX
static SimpleString	OLD_TEMP_QUEUE_QUALIFED_PREFIX
static SimpleString	OLD_TEMP_TOPIC_QUALIFED_PREFIX
static SimpleString	OLD_TOPIC_QUALIFIED_PREFIX
protected boolean	propertiesReadOnly
protected boolean	readOnly
protected jakarta.jms.Destination	replyTo
static byte	TYPE

Fields inherited from interface jakarta.jms.Message

DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Modifier	Constructor	Description
	ActiveMQMessage()
protected	ActiveMQMessage(byte type, ClientSession session)
protected	ActiveMQMessage(jakarta.jms.Message foreign, byte type, ClientSession session)
	ActiveMQMessage(jakarta.jms.Message foreign, ClientSession session)
	ActiveMQMessage(ClientMessage message, ClientSession session)	Constructor for when receiving a message from the server
protected	ActiveMQMessage(ClientSession session)

Method Summary

Modifier and Type	Method	Description
void	acknowledge()
void	checkBuffer()
protected SimpleString	checkPrefix(SimpleString address)
protected SimpleString	checkPrefixStr(SimpleString address)
protected void	checkRead()
protected void	checkWrite()
void	clearBody()
void	clearProperties()
static CompositeData	coreCompositeTypeToJMSCompositeType(CompositeDataSupport data)
static Map<String,Object>	coreMaptoJMSMap(Map<String,Object> coreMessage)
static ActiveMQMessage	createMessage(ClientMessage message, ClientSession session)
static ActiveMQMessage	createMessage(ClientMessage message, ClientSession session, ConnectionFactoryOptions options)
void	doBeforeReceive()
void	doBeforeSend()
<T> T	getBody(Class<T> c)
protected <T> T	getBodyInternal(Class<T> c)
boolean	getBooleanProperty(String name)
byte	getByteProperty(String name)
ClientMessage	getCoreMessage()
double	getDoubleProperty(String name)
float	getFloatProperty(String name)
int	getIntProperty(String name)
String	getJMSCorrelationID()
byte[]	getJMSCorrelationIDAsBytes()
int	getJMSDeliveryMode()
long	getJMSDeliveryTime()
jakarta.jms.Destination	getJMSDestination()
long	getJMSExpiration()
String	getJMSMessageID()
int	getJMSPriority()
boolean	getJMSRedelivered()
jakarta.jms.Destination	getJMSReplyTo()
long	getJMSTimestamp()
String	getJMSType()
long	getLongProperty(String name)
Object	getObjectProperty(String name)
Enumeration	getPropertyNames()
short	getShortProperty(String name)
String	getStringProperty(String name)
byte	getType()
protected boolean	hasNoBody()	Helper method for isBodyAssignableTo(Class).
boolean	isBodyAssignableTo(Class c)
static String	prefixOf(jakarta.jms.Destination dest)
boolean	propertyExists(String name)
void	resetMessageID(String newMsgID)
void	saveToOutputStream(OutputStream output)
void	setBooleanProperty(String name, boolean value)
void	setByteProperty(String name, byte value)
void	setClientAcknowledge()
void	setDoubleProperty(String name, double value)
void	setFloatProperty(String name, float value)
void	setIndividualAcknowledge()
void	setInputStream(InputStream input)
void	setIntProperty(String name, int value)
void	setJMSCorrelationID(String correlationID)
void	setJMSCorrelationIDAsBytes(byte[] correlationID)
void	setJMSDeliveryMode(int deliveryMode)
void	setJMSDeliveryTime(long deliveryTime)
void	setJMSDestination(jakarta.jms.Destination destination)
void	setJMSExpiration(long expiration)
void	setJMSMessageID(String jmsMessageID)
void	setJMSPriority(int priority)
void	setJMSRedelivered(boolean redelivered)
void	setJMSReplyTo(jakarta.jms.Destination dest)
void	setJMSTimestamp(long timestamp)
void	setJMSType(String type)
void	setLongProperty(String name, long value)
void	setObjectProperty(String name, Object value)
void	setOutputStream(OutputStream output)
void	setShortProperty(String name, short value)
void	setStringProperty(String name, String value)
String	toString()
boolean	waitCompletionOnStream(long timeWait)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final byte TYPE

See Also:

Constant Field Values

OLD_QUEUE_QUALIFIED_PREFIX

public static final SimpleString OLD_QUEUE_QUALIFIED_PREFIX

OLD_TEMP_QUEUE_QUALIFED_PREFIX

public static final SimpleString OLD_TEMP_QUEUE_QUALIFED_PREFIX

OLD_TOPIC_QUALIFIED_PREFIX

public static final SimpleString OLD_TOPIC_QUALIFIED_PREFIX

OLD_TEMP_TOPIC_QUALIFED_PREFIX

public static final SimpleString OLD_TEMP_TOPIC_QUALIFED_PREFIX

message

protected ClientMessage message

readOnly

protected boolean readOnly

propertiesReadOnly

protected boolean propertiesReadOnly

replyTo

protected jakarta.jms.Destination replyTo

Constructor Detail

ActiveMQMessage

protected ActiveMQMessage(byte type,
                          ClientSession session)

ActiveMQMessage

protected ActiveMQMessage(ClientSession session)

ActiveMQMessage

public ActiveMQMessage(ClientMessage message,
                       ClientSession session)

Constructor for when receiving a message from the server

ActiveMQMessage

public ActiveMQMessage(jakarta.jms.Message foreign,
                       ClientSession session)
                throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

ActiveMQMessage

public ActiveMQMessage()

ActiveMQMessage

protected ActiveMQMessage(jakarta.jms.Message foreign,
                          byte type,
                          ClientSession session)
                   throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

Method Detail

coreMaptoJMSMap

public static Map<String,Object> coreMaptoJMSMap(Map<String,Object> coreMessage)

coreCompositeTypeToJMSCompositeType

public static CompositeData coreCompositeTypeToJMSCompositeType(CompositeDataSupport data)
                                                         throws Exception

Throws:

Exception

createMessage

public static ActiveMQMessage createMessage(ClientMessage message,
                                            ClientSession session)

createMessage

public static ActiveMQMessage createMessage(ClientMessage message,
                                            ClientSession session,
                                            ConnectionFactoryOptions options)

getJMSMessageID

public String getJMSMessageID()

Specified by:

getJMSMessageID in interface jakarta.jms.Message

setJMSMessageID

public void setJMSMessageID(String jmsMessageID)
                     throws jakarta.jms.JMSException

Specified by:

setJMSMessageID in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSTimestamp

public long getJMSTimestamp()
                     throws jakarta.jms.JMSException

Specified by:

getJMSTimestamp in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSTimestamp

public void setJMSTimestamp(long timestamp)
                     throws jakarta.jms.JMSException

Specified by:

setJMSTimestamp in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSCorrelationIDAsBytes

public byte[] getJMSCorrelationIDAsBytes()
                                  throws jakarta.jms.JMSException

Specified by:

getJMSCorrelationIDAsBytes in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSCorrelationIDAsBytes

public void setJMSCorrelationIDAsBytes(byte[] correlationID)
                                throws jakarta.jms.JMSException

Specified by:

setJMSCorrelationIDAsBytes in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSCorrelationID

public void setJMSCorrelationID(String correlationID)
                         throws jakarta.jms.JMSException

Specified by:

setJMSCorrelationID in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSCorrelationID

public String getJMSCorrelationID()
                           throws jakarta.jms.JMSException

Specified by:

getJMSCorrelationID in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSReplyTo

public jakarta.jms.Destination getJMSReplyTo()
                                      throws jakarta.jms.JMSException

Specified by:

getJMSReplyTo in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSReplyTo

public void setJMSReplyTo(jakarta.jms.Destination dest)
                   throws jakarta.jms.JMSException

Specified by:

setJMSReplyTo in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

prefixOf

public static String prefixOf(jakarta.jms.Destination dest)

checkPrefix

protected SimpleString checkPrefix(SimpleString address)

checkPrefixStr

protected SimpleString checkPrefixStr(SimpleString address)

getJMSDestination

public jakarta.jms.Destination getJMSDestination()
                                          throws jakarta.jms.JMSException

Specified by:

getJMSDestination in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSDestination

public void setJMSDestination(jakarta.jms.Destination destination)
                       throws jakarta.jms.JMSException

Specified by:

setJMSDestination in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSDeliveryMode

public int getJMSDeliveryMode()
                       throws jakarta.jms.JMSException

Specified by:

getJMSDeliveryMode in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSDeliveryMode

public void setJMSDeliveryMode(int deliveryMode)
                        throws jakarta.jms.JMSException

Specified by:

setJMSDeliveryMode in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSRedelivered

public boolean getJMSRedelivered()
                          throws jakarta.jms.JMSException

Specified by:

getJMSRedelivered in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSRedelivered

public void setJMSRedelivered(boolean redelivered)
                       throws jakarta.jms.JMSException

Specified by:

setJMSRedelivered in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSType

public void setJMSType(String type)
                throws jakarta.jms.JMSException

Specified by:

setJMSType in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSType

public String getJMSType()
                  throws jakarta.jms.JMSException

Specified by:

getJMSType in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSExpiration

public long getJMSExpiration()
                      throws jakarta.jms.JMSException

Specified by:

getJMSExpiration in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSExpiration

public void setJMSExpiration(long expiration)
                      throws jakarta.jms.JMSException

Specified by:

setJMSExpiration in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSPriority

public int getJMSPriority()
                   throws jakarta.jms.JMSException

Specified by:

getJMSPriority in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSPriority

public void setJMSPriority(int priority)
                    throws jakarta.jms.JMSException

Specified by:

setJMSPriority in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

clearProperties

public void clearProperties()
                     throws jakarta.jms.JMSException

Specified by:

clearProperties in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

clearBody

public void clearBody()
               throws jakarta.jms.JMSException

Specified by:

clearBody in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

propertyExists

public boolean propertyExists(String name)
                       throws jakarta.jms.JMSException

Specified by:

propertyExists in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getBooleanProperty

public boolean getBooleanProperty(String name)
                           throws jakarta.jms.JMSException

Specified by:

getBooleanProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getByteProperty

public byte getByteProperty(String name)
                     throws jakarta.jms.JMSException

Specified by:

getByteProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getShortProperty

public short getShortProperty(String name)
                       throws jakarta.jms.JMSException

Specified by:

getShortProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getIntProperty

public int getIntProperty(String name)
                   throws jakarta.jms.JMSException

Specified by:

getIntProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getLongProperty

public long getLongProperty(String name)
                     throws jakarta.jms.JMSException

Specified by:

getLongProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getFloatProperty

public float getFloatProperty(String name)
                       throws jakarta.jms.JMSException

Specified by:

getFloatProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getDoubleProperty

public double getDoubleProperty(String name)
                         throws jakarta.jms.JMSException

Specified by:

getDoubleProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getStringProperty

public String getStringProperty(String name)
                         throws jakarta.jms.JMSException

Specified by:

getStringProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getObjectProperty

public Object getObjectProperty(String name)
                         throws jakarta.jms.JMSException

Specified by:

getObjectProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getPropertyNames

public Enumeration getPropertyNames()
                             throws jakarta.jms.JMSException

Specified by:

getPropertyNames in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setBooleanProperty

public void setBooleanProperty(String name,
                               boolean value)
                        throws jakarta.jms.JMSException

Specified by:

setBooleanProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setByteProperty

public void setByteProperty(String name,
                            byte value)
                     throws jakarta.jms.JMSException

Specified by:

setByteProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setShortProperty

public void setShortProperty(String name,
                             short value)
                      throws jakarta.jms.JMSException

Specified by:

setShortProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setIntProperty

public void setIntProperty(String name,
                           int value)
                    throws jakarta.jms.JMSException

Specified by:

setIntProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setLongProperty

public void setLongProperty(String name,
                            long value)
                     throws jakarta.jms.JMSException

Specified by:

setLongProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setFloatProperty

public void setFloatProperty(String name,
                             float value)
                      throws jakarta.jms.JMSException

Specified by:

setFloatProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setDoubleProperty

public void setDoubleProperty(String name,
                              double value)
                       throws jakarta.jms.JMSException

Specified by:

setDoubleProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setStringProperty

public void setStringProperty(String name,
                              String value)
                       throws jakarta.jms.JMSException

Specified by:

setStringProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setObjectProperty

public void setObjectProperty(String name,
                              Object value)
                       throws jakarta.jms.JMSException

Specified by:

setObjectProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

acknowledge

public void acknowledge()
                 throws jakarta.jms.JMSException

Specified by:

acknowledge in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

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(Class<T> c)
              throws jakarta.jms.JMSException

Specified by:

getBody in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getBodyInternal

protected <T> T getBodyInternal(Class<T> c)
                         throws jakarta.jms.MessageFormatException

Throws:

jakarta.jms.MessageFormatException

isBodyAssignableTo

public boolean isBodyAssignableTo(Class c)

Specified by:

isBodyAssignableTo in interface jakarta.jms.Message

hasNoBody

protected boolean hasNoBody()

Helper method for isBodyAssignableTo(Class).

Returns:

true if the message has no body.

setIndividualAcknowledge

public void setIndividualAcknowledge()

setClientAcknowledge

public void setClientAcknowledge()

resetMessageID

public void resetMessageID(String newMsgID)

getCoreMessage

public ClientMessage getCoreMessage()

doBeforeSend

public void doBeforeSend()
                  throws Exception

Throws:

Exception

checkBuffer

public void checkBuffer()

doBeforeReceive

public void doBeforeReceive()
                     throws ActiveMQException

Throws:

ActiveMQException

getType

public byte getType()

setInputStream

public void setInputStream(InputStream input)
                    throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

setOutputStream

public void setOutputStream(OutputStream output)
                     throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

saveToOutputStream

public void saveToOutputStream(OutputStream output)
                        throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

waitCompletionOnStream

public boolean waitCompletionOnStream(long timeWait)
                               throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

toString

public String toString()

Overrides:

toString in class Object

checkWrite

protected void checkWrite()
                   throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

checkRead

protected void checkRead()
                  throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException