Message Headers

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

Solace Headers

Solace headers exposed to the connector are documented in the Spring Cloud Stream Binder for Solace PubSub+ documentation.

SFTP Source Headers

The following file-related headers are injected into each Solace message. The example values in the following table are for the sub1/sub2/employee.csv file from the SFTP source located at sftp://host:port/rootDirectory/ .

Header Name Type Description

scst_file_name

String

The name of the file (with no leading path), for example:

employee.csv

scst_file_absolute_path

String

The local absolute path to the file. In the example, the file is downloaded to the local working directory /tmp/.solace/input-0/, so the absolute path is:

/tmp/.solace/input-0/sub1/sub2/employee.csv

scst_file_relative_path

String

The path of the file relative to the root directory of the SFTP source, for example:

sub1/sub2/employee.csv

scst_file_parent

String

The parent directory of the file, for example:

sub1/sub2/

scst_file_length

String

A long (converted to String) value containing the file size, for example, 2538657.

scst_file_last_modified

String

A long (converted to String) value, representing the last modified time in milliseconds, for example, 1728345600000 (that is, 2024-10-08, 12:00 AM).

scst_event_offset

String

The offset of the event in the file, for example, 5 (for the 5th event in the file).

For a file with headers, the offset starts at 1 for the first data line.

Reserved Message Headers

The following are reserved header spaces:

Any headers with these prefixes (that are not defined by the connector or any technology used by the connector) may not be backwards compatible in future versions of this connector.