The ITextMessage type exposes the following members.

Methods

  NameDescription
Public methodAcknowledge
Acknowledges all consumed messages of the session of this consumed message.

All consumed JMS messages support the acknowledge method for use when a client has specified that its JMS session's consumed messages are to be explicitly acknowledged. By invoking acknowledge on a consumed message, a client acknowledges all messages consumed by the session that the message was delivered to.

Calls to acknowledge are ignored for both transacted sessions and sessions specified to use implicit acknowledgement modes.

A client may individually acknowledge each message as it is consumed, or it may choose to acknowledge messages as an application-defined group (which is done by calling acknowledge on the last received message of the group, thereby acknowledging all messages consumed by the session.)

Messages that have been received but not acknowledged may be redelivered.

(Inherited from IMessage.)
Public methodClearBody
Clears out the message body. Clearing a message's body does not clear its header values or property entries.

If this message body was read-only, calling this method leaves the message body in the same state as an empty body in a newly created message.

(Inherited from IMessage.)
Public methodClearProperties
Clears a message's properties.

The message's header fields and body are not cleared.

(Inherited from IMessage.)
Public methodGetBooleanProperty
Returns the value of the boolean property with the specified name.
(Inherited from IMessage.)
Public methodGetByteProperty
Returns the value of the byte property with the specified name.
(Inherited from IMessage.)
Public methodGetDoubleProperty
Returns the value of the double property with the specified name.
(Inherited from IMessage.)
Public methodGetFloatProperty
Returns the value of the float property with the specified name.
(Inherited from IMessage.)
Public methodGetIntProperty
Returns the value of the int property with the specified name.
(Inherited from IMessage.)
Public methodGetLongProperty
Returns the value of the long property with the specified name.
(Inherited from IMessage.)
Public methodGetObjectProperty
Returns the value of the object property with the specified name.

This method can be used to return, in objectified format, an object that has been stored as a property in the message with the equivalent SetObjectProperty method call, or its equivalent primitive SettypeProperty method.

(Inherited from IMessage.)
Public methodGetShortProperty
Returns the value of the short property with the specified name.
(Inherited from IMessage.)
Public methodGetStringProperty
Returns the value of the String property with the specified name.
(Inherited from IMessage.)
Public methodPropertyExists
Indicates whether a property value exists.
(Inherited from IMessage.)
Public methodSetBooleanProperty
Sets a boolean property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetByteProperty
Sets a byte property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetDoubleProperty
Sets a double property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetFloatProperty
Sets a float property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetIntProperty
Sets an int property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetLongProperty
Sets a long property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetObjectProperty
Sets a object property value with the specified name into the message.

Note that this method works only for the objectified primitive object types (Integer, Double, Long ...) and String objects.

(Inherited from IMessage.)
Public methodSetShortProperty
Sets a short property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetStringProperty
Sets a String property value with the specified name into the message.
(Inherited from IMessage.)

Properties

  NameDescription
Public propertyJMSCorrelationID
Sets the correlation ID for the message.

A client can use the JMSCorrelationID header field to link one message with another. A typical use is to link a response message with its request message.

JMSCorrelationID can hold one of the following:

  • A provider-specific message ID
  • An application-specific String
  • A provider-native byte[] value

Since each message sent by a JMS provider is assigned a message ID value, it is convenient to link messages via message ID. All message ID values must start with the 'ID:' prefix.

In some cases, an application (made up of several clients) needs to use an application-specific value for linking messages. For instance, an application may use JMSCorrelationID to hold a value referencing some external information. Application-specified values must not start with the 'ID:' prefix; this is reserved for provider-generated message ID values.

If a provider supports the native concept of correlation ID, a JMS client may need to assign specific JMSCorrelationID values to match those expected by clients that do not use the JMS API. A byte[] value is used for this purpose. JMS providers without native correlation ID values are not required to support byte[] values. The use of a byte[] value for JMSCorrelationID is non-portable.

(Inherited from IMessage.)
Public propertyJMSCorrelationIDAsBytes
Sets the correlation ID as an array of bytes for the message.

The array is copied before the method returns, so future modifications to the array will not alter this message header.

If a provider supports the native concept of correlation ID, a JMS client may need to assign specific JMSCorrelationID values to match those expected by native messaging clients. JMS providers without native correlation ID values are not required to support this method and its corresponding get method;

The use of a byte[] value for JMSCorrelationID is non-portable.

(Inherited from IMessage.)
Public propertyJMSDeliveryMode
Gets the DeliveryMode value specified for this message.
(Inherited from IMessage.)
Public propertyJMSDestination
Gets the Destination object for this message.

The JMSDestination header field contains the destination to which the message is being sent.

When a message is sent, this field is ignored. After completion of the send or publish method, the field holds the destination specified by the method.

When a message is received, its JMSDestination value must be equivalent to the value assigned when it was sent.

(Inherited from IMessage.)
Public propertyJMSExpiration
Gets the message's expiration value.

When a message is sent, the JMSExpiration header field is left unassigned. After completion of the send or publish method, it holds the expiration time of the message. This is the sum of the time-to-live value specified by the client and the GMT at the time of the send or publish.

If the time-to-live is specified as zero, JMSExpiration is set to zero to indicate that the message does not expire.

When a message's expiration time is reached, a provider should discard it. The JMS API does not define any form of notification of message expiration.

Clients should not receive messages that have expired; however, the JMS API does not guarantee that this will not happen.

(Inherited from IMessage.)
Public propertyJMSMessageID
Sets the message ID.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

(Inherited from IMessage.)
Public propertyJMSPriority
Gets the message priority level.

The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest. In addition, clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority.

The JMS API does not require that a provider strictly implement priority ordering of messages; however, it should do its best to deliver expedited messages ahead of normal messages.

(Inherited from IMessage.)
Public propertyJMSRedelivered
Specifies whether this message is being redelivered.

This field is set at the time the message is delivered. This method can be used to change the value for a message that has been received.

(Inherited from IMessage.)
Public propertyJMSReplyTo

Sets the Destination object to which a reply to this message should be sent.

The JMSReplyTo header field contains the destination where a reply to the current message should be sent. If it is null, no reply is expected. The destination may be either a Queue object or a Topic object.

Messages sent with a null JMSReplyTo value may be a notification of some event, or they may just be some data the sender thinks is of interest.

Messages with a JMSReplyTo value typically expect a response. A response is optional; it is up to the client to decide. These messages are called requests. A message sent in response to a request is called a reply.

In some cases a client may wish to match a request it sent earlier with a reply it has just received. The client can use the JMSCorrelationID header field for this purpose.

(Inherited from IMessage.)
Public propertyJMSTimestamp
Sets the message timestamp.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

(Inherited from IMessage.)
Public propertyJMSType
Sets the message type.

Some JMS providers use a message repository that contains the definitions of messages sent by applications. The JMSType header field may reference a message's definition in the provider's repository.

The JMS API does not define a standard message definition repository, nor does it define a naming policy for the definitions it contains.

Some messaging systems require that a message type definition for each application message be created and that each message specify its type. In order to work with such JMS providers, JMS clients should assign a value to JMSType, whether the application makes use of it or not. This ensures that the field is properly set for those providers that require it.

To ensure portability, JMS clients should use symbolic values for JMSType that can be configured at installation time to the values defined in the current provider's message repository. If string literals are used, they may not be valid type names for some JMS providers.

(Inherited from IMessage.)
Public propertyPropertyNames
Returns an Enumeration of all the property names.

Note that JMS standard header fields are not considered properties and are not returned in this enumeration.

(Inherited from IMessage.)
Public propertyText

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

See Also