| SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The Message interface is the root interface of all JMS
messages. It defines the message header and the acknowledge
method used for all messages.
Most message-oriented middleware (MOM) products treat messages as lightweight entities that consist of a header and a payload. The header contains fields used for message routing and identification; the payload contains the application data being sent.
Within this general form, the definition of a message varies significantly across products. It would be quite difficult for the JMS API to support all of these message models.
With this in mind, the JMS message model has the following goals:
JMS messages are composed of the following parts:
The JMS API defines Text and Bytes as message body:
TextMessage object's message body contains a
java.lang.String object. This message type can be used
to transport plain-text messages, and XML messages.
BytesMessage object's message body contains a
stream of uninterpreted bytes. This message type is for
literally encoding a body to match an existing message format. In
many cases, it is possible to use one of the other body types,
which are easier to use. Although the JMS API allows the use of
message properties with byte messages, they are typically not used,
since the inclusion of properties may affect the format.
The JMSCorrelationID header field is used for linking one
message with
another. It typically links a reply message with its requesting message.
JMSCorrelationID can hold a provider-specific message ID,
an application-specific String object, or a provider-native
byte[] value.
A Message object contains a built-in facility for supporting
application-defined property values. In effect, this provides a mechanism
for adding application-specific header fields to a message.
Properties allow an application, via message selectors, to have a JMS provider select, or filter, messages on its behalf using application-specific criteria.
Property names must obey the rules for a message selector identifier.
Property names must not be null, and must not be empty strings. If a property
name is set and it is either null or an empty string, an
IllegalArgumentException must be thrown.
Property values are set prior to sending a message. When a client
receives a message, its properties are in read-only mode. If a
client attempts to set properties at this point, a
MessageNotWriteableException is thrown. If
clearProperties is called, the properties can now be both
read from and written to. Note that header fields are distinct from
properties. Header fields are never in read-only mode.
A property value may duplicate a value in a message's body, or it may not. Although JMS does not define a policy for what should or should not be made a property, application developers should note that JMS providers will likely handle data in a message's body more efficiently than data in a message's properties. For best performance, applications should use message properties only when they need to customize a message's header. The primary reason for doing this is to support customized message selection.
Message properties support the following conversion table. The marked
cases must be supported. The unmarked cases must throw a
JMSException. The String-to-primitive conversions
may throw a runtime exception if the
primitive's valueOf method does not accept the
String as a valid representation of the primitive.
The order of property values is not defined. To iterate through a
message's property values, use getPropertyNames to retrieve
a property name enumeration and then use the various property get methods
to retrieve their values.
A message's properties are deleted by the clearProperties
method. This leaves the message with an empty set of properties.
Getting a property value for a name which has not been set returns a
null value. Only the getStringProperty and
getObjectProperty methods can return a null value.
Attempting to read a null value as a primitive type must be treated as
calling the primitive's corresponding valueOf(String)
conversion method with a null value.
The JMS API reserves the JMSX property name prefix for JMS
defined properties.
The full set of these properties is defined in the Java Message Service
specification. New JMS defined properties may be added in later versions
of the JMS API. Support for these properties is optional. The
String[] ConnectionMetaData.getJMSXPropertyNames method
returns the names of the JMSX properties supported by a connection.
JMSX properties may be referenced in message selectors whether or not they are supported by a connection. If they are not present in a message, they are treated like any other absent property.
JMSX properties defined in the specification as "set by provider on send" are available to both the producer and the consumers of the message. JMSX properties defined in the specification as "set by provider on receive" are available only to the consumers.
JMSXGroupID and JMSXGroupSeq are standard
properties that clients
should use if they want to group messages. All providers must support them.
Unless specifically noted, the values and semantics of the JMSX properties
are undefined.
The JMS API reserves the JMS_vendor_name property
name prefix for provider-specific properties. Each provider defines its own
value for vendor_name. This is the mechanism a JMS
provider uses to make its special per-message services available to a JMS
client.
The purpose of provider-specific properties is to provide special features needed to integrate JMS clients with provider-native clients in a single JMS application. They should not be used for messaging between JMS clients.
The JMS API provides a set of message interfaces that define the JMS message model. It does not provide implementations of these interfaces.
Each JMS provider supplies a set of message factories with its
Session object for creating instances of messages. This allows
a provider to use message implementations tailored to its specific needs.
A provider must be prepared to accept message implementations that are not its own. They may not be handled as efficiently as its own implementation; however, they must be handled.
Note the following exception case when a provider is handling a foreign
message implementation. If the foreign message implementation contains a
JMSReplyTo header field that is set to a foreign destination
implementation, the provider is not required to handle or preserve the
value of this header field.
| Field Summary | |
int
|
DEFAULT_DELIVERY_MODE
The message producer's default delivery mode is PERSISTENT.
|
int
|
DEFAULT_PRIORITY
The message producer's default priority is 4. |
int
|
DEFAULT_TIME_TO_LIVE
The message producer's default time to live is unlimited; the message never expires. |
| Constructor Summary | |
Message()
The Message interface is the root interface of all JMS
messages.
|
|
| Method Summary | |
void
|
acknowledge()
Acknowledges all consumed messages of the session of this consumed message. |
void
|
clearBody()
Clears out the message body. |
void
|
clearProperties()
Clears a message's properties. |
Boolean
|
getBooleanProperty(name)
Returns the value of the Boolean property with the
specified name.
|
Number
|
getByteProperty(name)
Returns Number representing byte value with the specified
name.
|
Number
|
getDoubleProperty(name)
Returns Number representing double value with the specified
name.
|
Number
|
getFloatProperty(name)
Returns the value of the float property with the specified
name.
|
Number
|
getIntProperty(name)
Returns Number representing int value with the specified
name.
|
String
|
getJMSCorrelationID()
Gets the correlation ID for the message. |
Number
|
getJMSDeliveryMode()
Gets the DeliveryMode value specified for this message.
|
Destination
|
getJMSDestination()
Gets the Destination object for this message.
|
Number
|
getJMSExpiration()
Gets the message's expiration value. |
String
|
getJMSMessageID()
Gets the message ID. |
Number
|
getJMSPriority()
Gets the message priority level. |
boolean
|
getJMSRedelivered()
Gets an indication of whether this message is being redelivered. |
Destination
|
getJMSReplyTo()
Gets the Destination object to which a reply to this
message should be sent.
|
Number
|
getJMSTimestamp()
Gets the message timestamp. |
String
|
getJMSType()
Gets the message type identifier supplied by the client when the message was sent. |
Number
|
getLongProperty(name)
Returns Number representing long value with the specified
name.
|
void
|
getObjectProperty(name)
Returns the value of the object property with the specified name. |
Enumeration
|
getPropertyNames()
Returns an Enumeration of all the property names.
|
Number
|
getShortProperty(name)
Returns Number representing short value with the specified
name.
|
String
|
getStringProperty(name)
Returns the value of the String property with the specified
name.
|
boolean
|
propertyExists(name)
Indicates whether a property value exists. |
void
|
setBooleanProperty(name, value)
Sets a Boolean property value with the specified name into
the message.
|
void
|
setByteProperty(name, value)
Sets a Number representing byte value with the specified name into
the message.
|
void
|
setDoubleProperty(name, value)
Sets a Number representing double value with the specified name into
the message.
|
void
|
setFloatProperty(name, value)
Sets a Number representing float value with the specified name into
the message.
|
void
|
setIntProperty(name, value)
Sets a Number representing int value with the specified name into
the message.
|
void
|
setJMSCorrelationID(correlationID)
Sets the correlation ID for the message. |
void
|
setJMSDeliveryMode(deliveryMode)
Sets the DeliveryMode value for this message.
|
void
|
setJMSDestination(destination)
Sets the Destination object for this message.
|
void
|
setJMSExpiration(expiration)
Sets the message's expiration value. |
void
|
setJMSMessageID(id)
Sets the message ID. |
void
|
setJMSPriority(priority)
Sets the priority level for this message. |
void
|
setJMSRedelivered(redelivered)
Specifies whether this message is being redelivered. |
void
|
setJMSReplyTo(replyTo)
Sets the Destination object to which a reply to this
message should be sent.
|
void
|
setJMSTimestamp(timestamp)
Sets the message timestamp. |
void
|
setJMSType(type)
Sets the message type. |
void
|
setLongProperty(name, value)
Sets a Number representing long value for a property.
|
void
|
setObjectProperty(name, value)
Sets a object property value with the specified name into the message. |
void
|
setShortProperty(name, value)
Sets a Number representing short value with the specified name into
the message.
|
void
|
setStringProperty(name, value)
Sets a String property value with the specified name into
the message.
|
| Field Detail |
int DEFAULT_DELIVERY_MODE
PERSISTENT.
int DEFAULT_PRIORITY
int DEFAULT_TIME_TO_LIVE
| Constructor Detail |
Message()
Message interface is the root interface of all JMS
messages. It defines the message header and the acknowledge
method used for all messages.
Most message-oriented middleware (MOM) products treat messages as lightweight entities that consist of a header and a payload. The header contains fields used for message routing and identification; the payload contains the application data being sent.
Within this general form, the definition of a message varies significantly across products. It would be quite difficult for the JMS API to support all of these message models.
With this in mind, the JMS message model has the following goals:
JMS messages are composed of the following parts:
The JMS API defines Text and Bytes as message body:
TextMessage object's message body contains a
java.lang.String object. This message type can be used
to transport plain-text messages, and XML messages.
BytesMessage object's message body contains a
stream of uninterpreted bytes. This message type is for
literally encoding a body to match an existing message format. In
many cases, it is possible to use one of the other body types,
which are easier to use. Although the JMS API allows the use of
message properties with byte messages, they are typically not used,
since the inclusion of properties may affect the format.
The JMSCorrelationID header field is used for linking one
message with
another. It typically links a reply message with its requesting message.
JMSCorrelationID can hold a provider-specific message ID,
an application-specific String object, or a provider-native
byte[] value.
A Message object contains a built-in facility for supporting
application-defined property values. In effect, this provides a mechanism
for adding application-specific header fields to a message.
Properties allow an application, via message selectors, to have a JMS provider select, or filter, messages on its behalf using application-specific criteria.
Property names must obey the rules for a message selector identifier.
Property names must not be null, and must not be empty strings. If a property
name is set and it is either null or an empty string, an
IllegalArgumentException must be thrown.
Property values are set prior to sending a message. When a client
receives a message, its properties are in read-only mode. If a
client attempts to set properties at this point, a
MessageNotWriteableException is thrown. If
clearProperties is called, the properties can now be both
read from and written to. Note that header fields are distinct from
properties. Header fields are never in read-only mode.
A property value may duplicate a value in a message's body, or it may not. Although JMS does not define a policy for what should or should not be made a property, application developers should note that JMS providers will likely handle data in a message's body more efficiently than data in a message's properties. For best performance, applications should use message properties only when they need to customize a message's header. The primary reason for doing this is to support customized message selection.
Message properties support the following conversion table. The marked
cases must be supported. The unmarked cases must throw a
JMSException. The String-to-primitive conversions
may throw a runtime exception if the
primitive's valueOf method does not accept the
String as a valid representation of the primitive.
The order of property values is not defined. To iterate through a
message's property values, use getPropertyNames to retrieve
a property name enumeration and then use the various property get methods
to retrieve their values.
A message's properties are deleted by the clearProperties
method. This leaves the message with an empty set of properties.
Getting a property value for a name which has not been set returns a
null value. Only the getStringProperty and
getObjectProperty methods can return a null value.
Attempting to read a null value as a primitive type must be treated as
calling the primitive's corresponding valueOf(String)
conversion method with a null value.
The JMS API reserves the JMSX property name prefix for JMS
defined properties.
The full set of these properties is defined in the Java Message Service
specification. New JMS defined properties may be added in later versions
of the JMS API. Support for these properties is optional. The
String[] ConnectionMetaData.getJMSXPropertyNames method
returns the names of the JMSX properties supported by a connection.
JMSX properties may be referenced in message selectors whether or not they are supported by a connection. If they are not present in a message, they are treated like any other absent property.
JMSX properties defined in the specification as "set by provider on send" are available to both the producer and the consumers of the message. JMSX properties defined in the specification as "set by provider on receive" are available only to the consumers.
JMSXGroupID and JMSXGroupSeq are standard
properties that clients
should use if they want to group messages. All providers must support them.
Unless specifically noted, the values and semantics of the JMSX properties
are undefined.
The JMS API reserves the JMS_vendor_name property
name prefix for provider-specific properties. Each provider defines its own
value for vendor_name. This is the mechanism a JMS
provider uses to make its special per-message services available to a JMS
client.
The purpose of provider-specific properties is to provide special features needed to integrate JMS clients with provider-native clients in a single JMS application. They should not be used for messaging between JMS clients.
The JMS API provides a set of message interfaces that define the JMS message model. It does not provide implementations of these interfaces.
Each JMS provider supplies a set of message factories with its
Session object for creating instances of messages. This allows
a provider to use message implementations tailored to its specific needs.
A provider must be prepared to accept message implementations that are not its own. They may not be handled as efficiently as its own implementation; however, they must be handled.
Note the following exception case when a provider is handling a foreign
message implementation. If the foreign message implementation contains a
JMSReplyTo header field that is set to a foreign destination
implementation, the provider is not required to handle or preserve the
value of this header field.
| Method Detail |
void acknowledge()
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.
void
JMSException if the JMS provider fails to acknowledge the
messages due to some internal error.
IllegalStateException if this method is called on a closed
session.
void clearBody()
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.
void
JMSException if the JMS provider fails to clear the message
body due to some internal error.
void clearProperties()
The message's header fields and body are not cleared.
void
JMSException if the JMS provider fails to clear the message
properties due to some internal error.
Boolean getBooleanProperty(name)
Boolean property with the
specified name.
name - the name of the Boolean property
Boolean the Boolean property value for the specified name
JMSException if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException if this type conversion is invalid.
Number getByteProperty(name)
Number representing byte value with the specified
name.
name - the name of the byte property
Number the Number representing byte value for the specified name
JMSException if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException if this type conversion is invalid.
Number getDoubleProperty(name)
Number representing double value with the specified
name.
string name - the name of the double property
Number Number representing double value with the specified
name.
JMSException if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException if this type conversion is invalid.
Number getFloatProperty(name)
float property with the specified
name.
name - the name of the float property
Number Number representing float value with the specified
name.
JMSException if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException if this type conversion is invalid.
Number getIntProperty(name)
Number representing int value with the specified
name.
name - the name of the int property
Number the Number representing int value with the specified
name
JMSException if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException if this type conversion is invalid.
String getJMSCorrelationID()
This method is used to return correlation ID values that are
either provider-specific message IDs or application-specific
String values.
String the correlation ID of a message as a String
JMSException if the JMS provider fails to get the correlation
ID due to some internal error.
Number getJMSDeliveryMode()
DeliveryMode value specified for this message.
Number the delivery mode for this message
JMSException if the JMS provider fails to get the
delivery mode due to some internal error.
Destination getJMSDestination()
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.
Destination the destination of this message
JMSException if the JMS provider fails to get the destination
due to some internal error.
Number getJMSExpiration()
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.
Number the time the message expires, which is the sum of the
time-to-live value specified by the client and the GMT in milliseconds
since midnight January 1, 1970 at the time of the send
JMSException if the JMS provider fails to get the message
expiration due to some internal error.
String getJMSMessageID()
The JMSMessageID header field contains a value that
uniquely identifies each message sent by a provider.
When a message is sent, JMSMessageID can be ignored.
When the send or publish method returns, it
contains a provider-assigned value.
A JMSMessageID is a String value that
should function as a
unique key for identifying messages in a historical repository.
The exact scope of uniqueness is provider-defined. It should at
least cover all messages for a specific installation of a
provider, where an installation is some connected set of message
routers.
All JMSMessageID values must start with the prefix
'ID:'.
Uniqueness of message ID values across different providers is
not required.
Since message IDs take some effort to create and increase a
message's size, some JMS providers may be able to optimize message
overhead if they are given a hint that the message ID is not used by
an application. By calling the
MessageProducer.setDisableMessageID method, a JMS client
enables this potential optimization for all messages sent by that
message producer. If the JMS provider accepts this
hint, these messages must have the message ID set to null; if the
provider ignores the hint, the message ID must be set to its normal
unique value.
String
Number getJMSPriority()
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.
Number the default message priority
JMSException if the JMS provider fails to get the message
priority due to some internal error.
boolean getJMSRedelivered()
If a client receives a message with the JMSRedelivered
field set,
it is likely, but not guaranteed, that this message was delivered
earlier but that its receipt was not acknowledged
at that time.
boolean true if this message is being redelivered
JMSException if the JMS provider fails to get the redelivered
state due to some internal error.
Destination getJMSReplyTo()
Destination object to which a reply to this
message should be sent.
Destination Destination to which to send a response to this
message
JMSException if the JMS provider fails to get the
JMSReplyTo destination due to some
internal error.
Number getJMSTimestamp()
The JMSTimestamp header field contains the time a
message was
handed off to a provider to be sent. It is not the time the
message was actually transmitted, because the actual send may occur
later due to transactions or other client-side queueing of messages.
When a message is sent, JMSTimestamp is ignored. When
the send or publish
method returns, it contains a time value somewhere in the interval
between the call and the return. The value is in the format of a normal
millis time value.
Since timestamps take some effort to create and increase a
message's size, some JMS providers may be able to optimize message
overhead if they are given a hint that the timestamp is not used by an
application. By calling the
MessageProducer.setDisableMessageTimestamp method, a JMS
client enables this potential optimization for all messages sent by
that message producer. If the JMS provider accepts this
hint, these messages must have the timestamp set to zero; if the
provider ignores the hint, the timestamp must be set to its normal
value.
Number the message timestamp
JMSException if the JMS provider fails to get the timestamp
due to some internal error.
String getJMSType()
String the message type
JMSException if the JMS provider fails to get the message
type due to some internal error.
Number getLongProperty(name)
Number representing long value with the specified
name.
NOTE: JavaScript does not support 64 bit long integer natively. The maximum integer value supported by the Number type ranges from -9,007,199,254,740,992 (-2^53) to 9,007,199,254,740,992 (2^53). If the value received from the wire is out of range, exception is thrown when trying to retrieve using getLongProperty.
name - the name of the long property
Number Number representing long value for the specified name
JMSException if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException if this type conversion is invalid.
void getObjectProperty(name)
name - the name of the Java object property
void
Number, String,
Boolean objects.if there is no property by this name, a null value
is returned
JMSException if the JMS provider fails to get the property
value due to some internal error.
Enumeration getPropertyNames()
Enumeration of all the property names.
Note that JMS standard header fields are not considered properties and are not returned in this enumeration.
Enumeration an enumeration of all the names of property values as String.
JMSException if the JMS provider fails to get the property
names due to some internal error.
Number getShortProperty(name)
Number representing short value with the specified
name.
name - the name of the short property
Number Number representing short value with the specified
name
JMSException if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException if this type conversion is invalid.
String getStringProperty(name)
String property with the specified
name.
String name - the name of the String property
String the String property value for the specified name;
if there is no property by this name, a null value is returned
JMSException if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException if this type conversion is invalid.
boolean propertyExists(name)
String name - the name of the property to test
boolean true if the property exists
JMSException if the JMS provider fails to determine if the
property exists due to some internal error.
void setBooleanProperty(name, value)
Boolean property value with the specified name into
the message.
name - the name of the Boolean property
value - the Boolean property value to set
void
JMSException if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException if the name is null or if the name is
an empty string.
MessageNotWriteableException if properties are read-only
void setByteProperty(name, value)
Number representing byte value with the specified name into
the message.
name - the name of the byte property
value - the byte property value to set
void
JMSException if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException if the name is null or if the name is
an empty string.
MessageNotWriteableException if properties are read-only
void setDoubleProperty(name, value)
Number representing double value with the specified name into
the message.
name - the name of the double property
value - the double property value to set
void
JMSException if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException if the name is null or if the name is
an empty string.
MessageNotWriteableException if properties are read-only
void setFloatProperty(name, value)
Number representing float value with the specified name into
the message.
name - the name of the float property
value - the float property value to set
void
JMSException if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException if the name is null or if the name is
an empty string.
MessageNotWriteableException if properties are read-only
void setIntProperty(name, value)
Number representing int value with the specified name into
the message.
name - the name of the int property
value - the int property value to set
void
JMSException if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException if the name is null or if the name is
an empty string.
MessageNotWriteableException if properties are read-only
void setJMSCorrelationID(correlationID)
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:
String
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.
String correlationID - the message ID of a message being referred to
void
JMSException if the JMS provider fails to set the correlation
ID due to some internal error.
void setJMSDeliveryMode(deliveryMode)
DeliveryMode value for this message.
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.
Number deliveryMode - the delivery mode for this message
void
JMSException if the JMS provider fails to set the
delivery mode due to some internal error.
void setJMSDestination(destination)
Destination object for this message.
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.
Destination destination - the destination for this message
void
JMSException if the JMS provider fails to set the destination
due to some internal error.
void setJMSExpiration(expiration)
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.
Number expiration - the message's expiration time
void
JMSException if the JMS provider fails to set the message
expiration due to some internal error.
void setJMSMessageID(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.
String id - the ID of the message
void
JMSException if the JMS provider fails to set the message ID
due to some internal error.
void setJMSPriority(priority)
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.
Number priority - the priority of this message
void
JMSException if the JMS provider fails to set the message
priority due to some internal error.
void setJMSRedelivered(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.
boolean redelivered - an indication of whether this message is being redelivered.
void
JMSException if the JMS provider fails to set the redelivered
state due to some internal error.
void setJMSReplyTo(replyTo)
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.
Destination replyTo - Destination to which to send a response to
this message
void
JMSException if the JMS provider fails to set the
JMSReplyTo destination due to some
internal error.
void setJMSTimestamp(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.
Number timestamp - the timestamp for this message
void
JMSException if the JMS provider fails to set the timestamp
due to some internal error.
void setJMSType(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.
String type - the message type
void
JMSException if the JMS provider fails to set the message
type due to some internal error.
void setLongProperty(name, value)
Number representing long value for a property.
NOTE: Javascript does not support 64 bit long integer natively. The maximum integer value supported by the Number type ranges from -9,007,199,254,740,992 (-2^53) to 9,007,199,254,740,992 (2^53).
name - the name of the long property
value - the long property value to set
void
JMSException if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException if the name is null or if the name is
an empty string.
MessageNotWriteableException if properties are read-only
void setObjectProperty(name, value)
Note that this method works only for the objectified primitive
object types supported in JavaScript Number, String,
Boolean objects. If Number is specified in setObjectProperty as value,
it will be internally marked as double type while sending in the wire.
JavaScript represents number as using IEEE-754 double-precision (64 bit) format.
It is recommended to use the type specific message property setter.
name - the name of the object property
value - the object property value to set
void
JMSException if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException if the name is null or if the name is
an empty string.
MessageFormatException if the object is invalid
MessageNotWriteableException if properties are read-only
void setShortProperty(name, value)
Number representing short value with the specified name into
the message.
name - the name of the short property
value - the short property value to set
void
JMSException if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException if the name is null or if the name is
an empty string.
MessageNotWriteableException if properties are read-only
void setStringProperty(name, value)
String property value with the specified name into
the message.
String name - the name of the String property
String value - the String property value to set
void
JMSException if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException if the name is null or if the name is
an empty string.
MessageNotWriteableException if properties are read-only