org.springframework.kafka.support

Class KafkaHeaders

java.lang.Object

org.springframework.kafka.support.KafkaHeaders

public abstract class KafkaHeaders
extends java.lang.Object

The Kafka specific message headers constants.

Author:

Artem Bilan, Marius Bogoevici, Gary Russell, Biju Kunjummen

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACKNOWLEDGMENT The header for the Acknowledgment.
static java.lang.String	BATCH_CONVERTED_HEADERS The header for a list of Maps of converted native Kafka headers.
static java.lang.String	CONSUMER The header for the Consumer object.
static java.lang.String	MESSAGE_KEY The header containing the message key when sending data to Kafka.
static java.lang.String	NATIVE_HEADERS The header for holding the native headers of the consumer record; only provided if no header mapper is present.
static java.lang.String	OFFSET The header for the partition offset.
static java.lang.String	PARTITION_ID The header containing the topic partition when sending data to Kafka.
static java.lang.String	RAW_DATA The header containing the raw data received from Kafka (ConsumerRecord or ConsumerRecords).
static java.lang.String	RECEIVED_MESSAGE_KEY The header containing the message key for the received message.
static java.lang.String	RECEIVED_PARTITION_ID The header containing the topic partition for the received message.
static java.lang.String	RECEIVED_TIMESTAMP The header for holding the timestamp of the consumer record.
static java.lang.String	RECEIVED_TOPIC The header containing the topic from which the message was received.
static java.lang.String	RECORD_METADATA The header containing the RecordMetadata object after successful send to the topic.
static java.lang.String	TIMESTAMP The header for holding the timestamp of the producer record.
static java.lang.String	TIMESTAMP_TYPE The header for holding the type of timestamp.
static java.lang.String	TOPIC The header containing the topic when sending data to Kafka.

Constructor Summary

Constructors

Constructor and Description
KafkaHeaders()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

TOPIC

public static final java.lang.String TOPIC

The header containing the topic when sending data to Kafka.

See Also:

Constant Field Values

MESSAGE_KEY

public static final java.lang.String MESSAGE_KEY

The header containing the message key when sending data to Kafka.

See Also:

Constant Field Values

PARTITION_ID

public static final java.lang.String PARTITION_ID

The header containing the topic partition when sending data to Kafka.

See Also:

Constant Field Values

OFFSET

public static final java.lang.String OFFSET

The header for the partition offset.

See Also:

Constant Field Values

RAW_DATA

public static final java.lang.String RAW_DATA

The header containing the raw data received from Kafka (ConsumerRecord or ConsumerRecords). Usually used to enhance error messages.

See Also:

Constant Field Values

RECORD_METADATA

public static final java.lang.String RECORD_METADATA

The header containing the RecordMetadata object after successful send to the topic.

See Also:

Constant Field Values

ACKNOWLEDGMENT

public static final java.lang.String ACKNOWLEDGMENT

The header for the Acknowledgment.

See Also:

Constant Field Values

CONSUMER

public static final java.lang.String CONSUMER

The header for the Consumer object.

See Also:

Constant Field Values

RECEIVED_TOPIC

public static final java.lang.String RECEIVED_TOPIC

The header containing the topic from which the message was received.

See Also:

Constant Field Values

RECEIVED_MESSAGE_KEY

public static final java.lang.String RECEIVED_MESSAGE_KEY

The header containing the message key for the received message.

See Also:

Constant Field Values

RECEIVED_PARTITION_ID

public static final java.lang.String RECEIVED_PARTITION_ID

The header containing the topic partition for the received message.

See Also:

Constant Field Values

TIMESTAMP_TYPE

public static final java.lang.String TIMESTAMP_TYPE

The header for holding the type of timestamp.

See Also:

Constant Field Values

TIMESTAMP

public static final java.lang.String TIMESTAMP

The header for holding the timestamp of the producer record.

See Also:

Constant Field Values

RECEIVED_TIMESTAMP

public static final java.lang.String RECEIVED_TIMESTAMP

The header for holding the timestamp of the consumer record.

See Also:

Constant Field Values

NATIVE_HEADERS

public static final java.lang.String NATIVE_HEADERS

The header for holding the native headers of the consumer record; only provided if no header mapper is present.

See Also:

Constant Field Values

BATCH_CONVERTED_HEADERS

public static final java.lang.String BATCH_CONVERTED_HEADERS

The header for a list of Maps of converted native Kafka headers. Used for batch listeners; the map at a particular list position corresponds to the data in the payload list position.

See Also:

Constant Field Values

Constructor Detail

KafkaHeaders

public KafkaHeaders()