org.springframework.cloud.stream.binder

Class BinderHeaders

java.lang.Object

org.springframework.cloud.stream.binder.BinderHeaders

public final class BinderHeaders
extends Object

Spring Integration message headers for Spring Cloud Stream.

Author:

Gary Russell, David Turanski, Soby Chacko

Field Summary

Fields

Modifier and Type	Field and Description
static String	NATIVE_HEADERS_PRESENT Indicates that an incoming message has native headers.
static String	PARTITION_HEADER Indicates the target partition of an outbound message.
static String	PARTITION_OVERRIDE Indicates the target partition of an outbound message.
static String	SCST_VERSION Indicates the Spring Cloud Stream version.
static String[]	STANDARD_HEADERS The headers that will be propagated, by default, by binder implementations that have no inherent header support (by embedding the headers in the payload).
static String	TARGET_DESTINATION Indicates the name of the target destination the binder should use if they choose (or have capabilities) to optimize sending output messages to dynamic destinations.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STANDARD_HEADERS

public static final String[] STANDARD_HEADERS

The headers that will be propagated, by default, by binder implementations that have no inherent header support (by embedding the headers in the payload).

TARGET_DESTINATION

public static final String TARGET_DESTINATION

Indicates the name of the target destination the binder should use if they choose (or have capabilities) to optimize sending output messages to dynamic destinations.

NOTE: The core framework only defines this header, but does nothing else. So it is up to binders to choose to support it or not. One can always rely on StreamBridge for general cases of sending output messages to dynamic destinations.

See Also:

Constant Field Values

PARTITION_HEADER

public static final String PARTITION_HEADER

Indicates the target partition of an outbound message. Binders must observe this value when sending data on the transport. This header is internally set by the framework when partitioning is configured. It may be overridden by PARTITION_OVERRIDE if set by the user.

See Also:

Constant Field Values

PARTITION_OVERRIDE

public static final String PARTITION_OVERRIDE

Indicates the target partition of an outbound message. Overrides any partition selected by the binder. This header takes precedence over PARTITION_HEADER.

See Also:

Constant Field Values

NATIVE_HEADERS_PRESENT

public static final String NATIVE_HEADERS_PRESENT

Indicates that an incoming message has native headers.

Since:

2.0

See Also:

Constant Field Values

SCST_VERSION

public static final String SCST_VERSION

Indicates the Spring Cloud Stream version. Used for determining if legacy content type check supported or not.

Since:

2.0

See Also:

Constant Field Values