Class JMSTextMessage

java.lang.Object

com.ibm.jakarta.jms.JMSMessage

com.ibm.jakarta.jms.JMSTextMessage

All Implemented Interfaces:

JmsMessage, jakarta.jms.Message, jakarta.jms.TextMessage, Serializable

public class JMSTextMessage
extends JMSMessage
implements jakarta.jms.TextMessage

A TextMessage is used to send a message containing a java.lang.String. It inherits from JMSMessage and adds a text body.

When a client receives a TextMessage, it is in read-only mode. If a client attempts to write to the message at this point, a MessageNotWriteableException is thrown. If clearBody() is called, the message can then be both read from and written to.

To create a text message please call Session.createTextMessage(). Do not call the default constructor.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	sccsid	The SCCSID which is expanded when the file is extracted from CMVC

Fields inherited from interface jakarta.jms.Message

DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Constructor	Description
JMSTextMessage()	Deprecated.

Method Summary

Modifier and Type	Method	Description
String	getText()	Gets the String containing this message's data.
void	setText(String messageText)	Sets the String containing this message's data.

Methods inherited from class JMSMessage

acknowledge, clearBody, clearProperties, getBody, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, isBodyAssignableTo, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty, toString, updateFromMessage

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface JmsMessage

getDelegate

Methods inherited from interface jakarta.jms.Message

acknowledge, clearBody, clearProperties, getBody, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, isBodyAssignableTo, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty

Field Details

sccsid

public static final String sccsid

The SCCSID which is expanded when the file is extracted from CMVC

See Also:

• Constant Field Values

Constructor Details

JMSTextMessage

public JMSTextMessage()

Deprecated.

To create a text message please call Session.createTextMessage().

Do not call this default constructor.

Method Details

getText

public String getText()
               throws jakarta.jms.JMSException

Gets the String containing this message's data. The default value is null.

Specified by:

getText in interface jakarta.jms.TextMessage

Returns:

the message data in String form

Throws:

jakarta.jms.JMSException - if the character set is not supported

setText

public void setText(String messageText)
             throws jakarta.jms.JMSException

Sets the String containing this message's data.

Specified by:

setText in interface jakarta.jms.TextMessage

Parameters:

messageText - the String containing the message's data

Throws:

jakarta.jms.JMSException - if an internal error occurs

jakarta.jms.MessageNotWriteableException - if the message is in read-only mode