public interface TextMessage extends Message
TextMessage
object is used to send a message containing a
java.lang.String
.
It inherits from the Message
interface and adds a text message
body.
This message type can be used to transport text-based messages, including those with XML content.
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 now be both read from and written to.
Session.createTextMessage()
,
Session.createTextMessage(String)
,
BytesMessage
,
MapMessage
,
Message
,
ObjectMessage
,
StreamMessage
,
String
Modifier and Type | Field and Description |
---|---|
static String |
SOLACE_JMS_PROP_ISXML
Solace defined boolean property indicating that a TextMessage contains XML content.
|
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
Modifier and Type | Method and Description |
---|---|
String |
getText()
Gets the string containing this message's data.
|
void |
setText(String string)
Sets the string containing this message's data.
|
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
static final String SOLACE_JMS_PROP_ISXML
This causes the TextMessage to be put in the XML payload of the Solace message rather than the binary attachment. This value is defined in com.solacesystems.jms.SupportedProperty
void setText(String string) throws JMSException
string
- the String
containing the message's dataJMSException
- if the JMS provider fails to set the text due to
some internal error.MessageNotWriteableException
- if the message is in read-only
mode.String getText() throws JMSException
String
containing the message's dataJMSException
- if the JMS provider fails to get the text due to
some internal error.Copyright 2004-2025 Solace Corporation. All rights reserved.