Message Headers

This feature is deprecated and will be removed in a future release. Use the configuration described in Mapping Message Headers and Payloads instead.

Solace and JMS message headers can be created or manipulated using the User-Configured Header Transforms feature.

Solace Headers

Solace headers exposed to the Micro-Integration are documented in the Spring Cloud Stream Binder for Solace documentation.

JMS Message Headers

The JMS headers exposed to the Micro-Integration are as follows:

Header Name	Type	Access	Description
`jms_correlationId`	`String`	Read/Write	The correlation ID for the message.
`jms_deliveryMode`	`int`	Read	The delivery mode value specified for this message.
`jms_destination`	For version 2.0.0 and later: `jakarta.jms.Destination` For versions earlier than 2.0.0: `javax.jms.Destination`	Read	The destination to which the message is being sent. For versions 2.4.4 to 2.4.10, consumer bindings did not map `jms_destination`, making it unavailable for use in transform-header expressions. For those specific Micro-Integration versions only, if your configuration includes default workflow transform-header expressions that nullify this message header, you can remove those expressions.
`jms_expiration`	`long`	Read	The time at which the JMS message is set to expire.
`jms_messageId`	`String`	Read	A value that uniquely identifies each message sent by a provider.
`jms_priority`	`int`	Read/Write	Specifies the message’s priority set on the send. When header is absent, JMS message is sent with default priority of 4.
`jms_redelivered`	`boolean`	Read	An indication of whether this message is being redelivered.
`jms_replyTo`	For versions 2.0.0 and later: `jakarta.jms.Destination` For versions earlier than 2.0.0: `javax.jms.Destination`	Read (Available only for versions 2.4.3 and earlier) Write (Available only for Outbound messages)	The Destination object to which a reply to this message should be sent. For versions 2.4.4 and later, consumer bindings no longer map `jms_replyTo`, making it unavailable for use in transform-header expressions. For Micro-Integration versions 2.4.4 and later, if your configuration includes default workflow transform-header expressions that nullify this message header, you can remove those expressions.
`jms_timestamp`	`long`	Read	The time a message was handed off to a provider to be sent.
`jms_timeToLive`	`long`	Write	Specifies the message’s time to live set on the send. When header is absent, JMS message is sent with default timeToLive of 0 (zero means that a message never expires).
`jms_type`	`String`	Read/Write	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