Adding Data Payloads

You can add the following types of payloads to a message:

  • XML content—XML data can be added to the XML content part of a message.
  • Binary content—Binary data can be added to a message as a binary attachment. A message can only contain a single attachment.

    When this attachment is sent through the event broker, it is not processed, transformed, or considered in subscription matching or filtering operations. This provides an efficient means for sending data that does not require processing by the platform before it reaches receiving applications.

  • User property map—Structured data can be added to user-defined message header fields.
  • User data—Up to 36 bytes of application‑specific binary data, known as user data, can be added to the user data message header field.

The maximum total size permitted for a published Direct message is 64 MiB (67,108,864 bytes). This is an event broker-imposed limit, and it takes into consideration the message header field data, XML metadata, XML payload, and any attachments.

To add data payloads to a message
Data Type To Add Set Through

XML Data

Not applicable

Binary Data

MessageHandle.setBinaryAttachment(...)

User Data

MessageHandle.setUserData(...)

Related Samples

  • For an example of how to add a binary data payload to a message, refer to DirectPubSub for the Solace Java RTO API API.
  • For an example of how to add SDT payloads to a message, refer to the SDTPubSubMsgIndep or SDTPubSubMsgDep samples for the Solace Java RTO API API.