Message Headers

This section lists the headers you can map for the Micro-Integration for JMS.

To map and transform Solace and JMS message headers and payloads, see Mapping Message Headers and Payloads.

Headers for JMS as a Source

This section lists the headers you can map when JMS is configured as a source.

JMS Source Headers

Name	Type	Description
`jms_correlationId`	`String`	The correlation ID of the message.
`jms_deliveryMode`	`Integer`	The delivery mode of the message.
`jms_expiration`	`Long`	The time at which the JMS message is set to expire.
`jms_messageId`	`String`	A value that uniquely identifies each message sent by a provider.
`jms_priority`	`Integer`	Specifies the message's priority set on the send.
`jms_redelivered`	`Boolean`	Indicates whether this message has been delivered before.
`jms_timestamp`	`Long`	The time a message was handed off to a provider to be sent.
`jms_type`	`String`	The message type identifier supplied by the client when the message was sent.

Solace Target Headers

Name	Type	Description
`scst_targetDestination`	`String`	A dynamic destination for the message.
`solace_applicationMessageId`	`String`	The message ID (a string for an application-specific message identifier).
`solace_applicationMessageType`	`String`	The application message type.
`solace_correlationId`	`String`	The correlation ID of the message.
`solace_dmqEligible`	`Boolean`	Indicates whether the message is eligible to be moved to a dead message queue (DMQ).
`solace_expiration`	`Long`	The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is supposed to expire.
`solace_httpContentEncoding`	`String`	The HTTP content encoding header value from interaction with an HTTP client.
`solace_isReply`	`Boolean`	Indicates whether the message is a reply to another message.
`solace_priority`	`Integer`	The message priority value in the range of 0-255, or -1 if it is not set.
`solace_senderId`	`String`	The sender ID for the message.
`solace_senderTimestamp`	`Long`	The send timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
`solace_sequenceNumber`	`Long`	The sequence number.
`solace_timeToLive`	`Long`	The number of milliseconds before the message is discarded or moved to a dead message queue (DMQ).

Headers for JMS as a Target

This section lists the headers you can map when JMS is configured as a target.

Solace Source Headers

Name	Type	Description
`solace_applicationMessageId`	`String`	The message ID (a string for an application-specific message identifier).
`solace_applicationMessageType`	`String`	The application message type.
`solace_correlationId`	`String`	The correlation ID of the message.
`solace_deliveryCount`	`Integer`	The number of times the message has been delivered to clients.
`solace_discardIndication`	`Boolean`	Indicates whether one or more messages have been discarded prior to the current message.
`solace_dmqEligible`	`Boolean`	Indicates whether the message is eligible to be moved to a dead message queue (DMQ).
`solace_expiration`	`Long`	The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is set to expire.
`solace_httpContentEncoding`	`String`	The HTTP content encoding header value from interaction with an HTTP client.
`solace_isReply`	`Boolean`	Indicates whether the message is a reply to another message.
`solace_priority`	`Integer`	The message priority value in the range of 0-255, or -1 if it is not set.
`solace_receiveTimestamp`	`Long`	The receive timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
`solace_redelivered`	`Boolean`	Indicates whether the event broker has delivered the message to the API before.
`solace_senderId`	`String`	The sender ID for the message.
`solace_senderTimestamp`	`Long`	The send timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
`solace_sequenceNumber`	`Long`	The sequence number.
`solace_timeToLive`	`Long`	The number of milliseconds before the message is discarded or moved to a dead message queue (DMQ).

JMS Target Headers

Name	Type	Description
`scst_targetDestination`	`String`	A dynamic destination for the message.
`jms_correlationId`	`String`	The correlation ID of the message.
`jms_priority`	`Integer`	Specifies the message's priority set on the send.
`jms_timeToLive`	`Long`	The message's time to live set on the send. When the header is absent, the JMS message is sent with a default timeToLive of 0 (meaning that the message never expires).
`jms_type`	`String`	The message type identifier supplied by the client when the message was sent.

JMS Binder Headers

For Micro-Integration versions 2.0.0 and later, you can use the following header to get and set JMS Binder metadata.

Header Name Type Access Description

Header Name	Type	Access	Description
`jms_scst_nullPayload`	`boolean`	Read	Specifies when the JMS message payload is null. Two cases exist: A `JMS TextMessage` with no message payload is received: The payload is converted to an empty String, and the `jms_scst_nullPayload` header is added. A JMS `Message` with no message payload is received: The payload is converted to an empty byte array, and the `jms_scst_nullPayload` header is added.

jms_scst_nullPayload

boolean

Read

Specifies when the JMS message payload is null.

Two cases exist:

A JMS TextMessage with no message payload is received: The payload is converted to an empty String, and the jms_scst_nullPayload header is added.
A JMS Message with no message payload is received: The payload is converted to an empty byte array, and the jms_scst_nullPayload header is added.

Reserved Message Headers

The following are reserved header spaces:

solace_
scst_
jms_ | JMS_ | JMSX
Any headers defined by the core Spring messaging framework. For more information, see Spring Integration: Message Headers.

Headers with these prefixes may not be backwards compatible in future versions of this Micro-Integration, even if they are not currently defined by the Micro-Integration or any technology used by the Micro-Integration.

Provide feedback