Public Member Functions |
virtual | ~TextMessage () |
virtual std::string | getText () const =0 |
| Gets the message character buffer.
|
virtual void | setText (const char *msg)=0 |
| Sets the message contents, does not take ownership of the passed char*, but copies it instead.
|
virtual void | setText (const std::string &msg)=0 |
| Sets the message contents.
|
virtual | ~Message () |
virtual Message * | clone () const =0 |
| Clone this message exactly, returns a new instance that the caller is required to delete.
|
virtual void | acknowledge () const =0 |
| Acknowledges all consumed messages of the session of this consumed message.
|
virtual void | clearBody ()=0 |
| Clears out the body of the message.
|
virtual void | clearProperties ()=0 |
| Clears out the message body.
|
virtual std::vector< std::string > | getPropertyNames () const =0 |
| Retrieves the property names.
|
virtual bool | propertyExists (const std::string &name) const =0 |
| Indicates whether or not a given property exists.
|
virtual ValueType | getPropertyValueType (const std::string &name) const =0 |
| Returns the value type for the given property key.
|
virtual bool | getBooleanProperty (const std::string &name) const =0 |
| Gets a boolean property.
|
virtual unsigned char | getByteProperty (const std::string &name) const =0 |
| Gets a byte property.
|
virtual double | getDoubleProperty (const std::string &name) const =0 |
| Gets a double property.
|
virtual float | getFloatProperty (const std::string &name) const =0 |
| Gets a float property.
|
virtual int | getIntProperty (const std::string &name) const =0 |
| Gets a int property.
|
virtual long long | getLongProperty (const std::string &name) const =0 |
| Gets a long property.
|
virtual short | getShortProperty (const std::string &name) const =0 |
| Gets a short property.
|
virtual std::string | getStringProperty (const std::string &name) const =0 |
| Gets a string property.
|
virtual void | setBooleanProperty (const std::string &name, bool value)=0 |
| Sets a boolean property.
|
virtual void | setByteProperty (const std::string &name, unsigned char value)=0 |
| Sets a byte property.
|
virtual void | setDoubleProperty (const std::string &name, double value)=0 |
| Sets a double property.
|
virtual void | setFloatProperty (const std::string &name, float value)=0 |
| Sets a float property.
|
virtual void | setIntProperty (const std::string &name, int value)=0 |
| Sets a int property.
|
virtual void | setLongProperty (const std::string &name, long long value)=0 |
| Sets a long property.
|
virtual void | setShortProperty (const std::string &name, short value)=0 |
| Sets a short property.
|
virtual void | setStringProperty (const std::string &name, const std::string &value)=0 |
| Sets a string property.
|
virtual std::string | getCMSCorrelationID () const =0 |
| Gets the correlation ID for the message.
|
virtual void | setCMSCorrelationID (const std::string &correlationId)=0 |
| Sets the correlation ID for the message.
|
virtual int | getCMSDeliveryMode () const =0 |
| Gets the DeliveryMode for this message.
|
virtual void | setCMSDeliveryMode (int mode)=0 |
| Sets the DeliveryMode for this message.
|
virtual const Destination * | getCMSDestination () const =0 |
| Gets the Destination object for this message.
|
virtual void | setCMSDestination (const Destination *destination)=0 |
| Sets the Destination object for this message.
|
virtual long long | getCMSExpiration () const =0 |
| Gets the message's expiration value.
|
virtual void | setCMSExpiration (long long expireTime)=0 |
| Sets the message's expiration value.
|
virtual std::string | getCMSMessageID () const =0 |
| The CMSMessageID header field contains a value that uniquely identifies each message sent by a provider.
|
virtual void | setCMSMessageID (const std::string &id)=0 |
| Sets the message ID.
|
virtual int | getCMSPriority () const =0 |
| Gets the message priority level.
|
virtual void | setCMSPriority (int priority)=0 |
| Sets the Priority Value for this message.
|
virtual bool | getCMSRedelivered () const =0 |
| Gets an indication of whether this message is being redelivered.
|
virtual void | setCMSRedelivered (bool redelivered)=0 |
| Specifies whether this message is being redelivered.
|
virtual const cms::Destination * | getCMSReplyTo () const =0 |
| Gets the Destination object to which a reply to this message should be sent.
|
virtual void | setCMSReplyTo (const cms::Destination *destination)=0 |
| Sets the Destination object to which a reply to this message should be sent.
|
virtual long long | getCMSTimestamp () const =0 |
| Gets the message timestamp.
|
virtual void | setCMSTimestamp (long long timeStamp)=0 |
| Sets the message timestamp.
|
virtual std::string | getCMSType () const =0 |
| Gets the message type identifier supplied by the client when the message was sent.
|
virtual void | setCMSType (const std::string &type)=0 |
| Sets the message type.
|
Interface for a text message.
A TextMessage can contain any Text based pay load such as an XML Document or other Text based document.
Like all Messages, a TextMessage is received in Read-Only mode, any attempt to write to the Message will result in a MessageNotWritableException being thrown until the clearBody
method is called which will erase the contents and place the message back in a read / write mode.
- Since
- 1.0