Java CAPS JMS Reference

JMS Message Properties

You can set specific message properties in the JMS OTD using the property nodes that are exposed by expanding the appropriate nodes in the Collaboration Definition Editor.

JMS Message Header Properties

You can set the message header properties for both inbound or outbound JMS messages. These property nodes are shown in the following figure, as they appear in the user interface. These same properties are also available for the output node in the receiveWait operation. When you set these properties in a Java based Collaboration Definition, they are used only by the Collaboration that uses that specific Collaboration Definition.

Figure 1–13 JMS Message Property Nodes (receive operation)

Screen capture showing JMS message property nodes
in OTD tree.

The following table shows the allowed values for the properties and the JMS methods used when you set a property in a Collaboration Definition. The methods that are exposed for your use are cross-referenced to the appropriate description. The methods that are not cross-referenced are automatically assigned, and not exposed.

Property	Values	Equivalent JMS Methods
`CorrelationID`	Correlation ID	`getJMSCorrelationID()` `setJMSCorrelationID(string)`
`CorrelationIDAsBytes`	Correlation ID	`getCorrelationIDAsBytes` `setCorrelationIDAsBytes(byte[])`
`DeliveryMode`	Persistent, nonpersistent (default = persistent)	getDeliveryMode() setDeliveryMode(arg0)
`Destination`	Destination (default = message destination as configured in Connectivity Map)	getDestination() setDestination(arg0)
`Expiration`	Number in milliseconds (default = 0 ms = never expire)	getTimeToLive() setTimeToLive(arg0)
`MessageID`	Message ID	`getJMSMessageID()` `setJMSMessageID(string)`
`Priority`	0 - 9 where 9 is the highest priority (default = 4)	getPriority() setPriority(arg0)
`Redelivered`	True, false	`getJMSRedelivered()` `setJMSRedelivered(boolean)`
`ReplyTo`	Destination	`getJMSReplyTo()` `setJMSReplyTo(destination)`
`Timestamp`	Number in milliseconds	`getJMSTimestamp()` `setJMSTimestamp(long)`
`Type`	Text, Bytes, Map, Stream	getJMSMessageType() setJMSMessageType(arg0)

Additional JMS Message Properties

You can also set the message properties for outbound JMS messages. These property nodes are shown in the following figure, as they appear in the user interface. These properties determine only how the message is sent. When you set these properties in a Java based Collaboration Definition, they override the corresponding JMS client message properties, and are used only by the Collaboration that uses that specific Collaboration Definition. For information on setting these properties in the JMS clients, see Configuring JMS Clients.

Figure 1–14 JMS OTD Outbound Property Nodes

Screen capture showing JMS outbound property
nodes in OTD tree.

The following table shows the allowed values for the outbound JMS message properties and the JMS methods used when you set a property in a Collaboration.

Property	Allowed Values	Equivalent JMS Methods
`deliveryMode`	Persistent, nonpersistent	getDeliveryMode() setDeliveryMode(arg0)
`priority`	0 - 9 where 9 is the highest priority	getPriority() setPriority(arg0)
`timeToLive`	Number in milliseconds	getTimeToLive() setTimeToLive(arg0)
`destination`	Destination	getDestination() setDestination(arg0)
`MessageServerURL`	A valid URL	getMessageServerURL() setMessageServerURL(arg0)

For more information about these properties, refer to the equivalent JMS method description in the indicated locations.