Class KafkaHeaders
java.lang.Object
org.springframework.kafka.support.KafkaHeaders
The Kafka specific message headers constants.
- Author:
- Artem Bilan, Marius Bogoevici, Gary Russell, Biju Kunjummen
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The header for theAcknowledgment
.static final String
The header for a list of Maps of converted native Kafka headers.static final String
The header for theConsumer
object.static final String
The header containing a list of conversion failures (for batch listeners only).static final String
The header containing information to correlate requests/replies.static final String
For inbound messages, when container retries are enabled the delivery attempt.static final String
Exception cause class name for a record published sent to a dead-letter topic.static final String
Exception class name for a record published sent to a dead-letter topic.static final String
Exception message for a record published to a dead-letter topic.static final String
Exception stack trace for a record published to a dead-letter topic.static final String
Exception class name for a record published sent to a dead-letter topic with a key deserialization exception.static final String
Exception message for a record published to a dead-letter topic with a key deserialization exception.static final String
Exception stack trace for a record published to a dead-letter topic with a key deserialization exception.static final String
Consumer group that failed to consumer a record published to a dead-letter topic.static final String
Original offset for a record published to a dead-letter topic.static final String
Original partition for a record published to a dead-letter topic.static final String
Original timestamp for a record published to a dead-letter topic.static final String
Original timestamp type for a record published to a dead-letter topic.static final String
Original topic for a record published to a dead-letter topic.static final String
Exception class name for a record published sent to another topic.static final String
Exception class name for a record published sent to another topic.static final String
Exception message for a record published to another topic.static final String
Exception stack trace for a record published to another topic.static final String
For inbound messages, the container'sgroup.id
consumer property.static final String
The header containing the record key when sending data to Kafka.static final String
Exception class name for a record published sent to another topic with a key deserialization exception.static final String
Exception message for a record published to another topic with a key deserialization exception.static final String
Exception stack trace for a record published to another topic with a key deserialization exception.static final String
Arbitrary static information about the listener receiving this record.static final String
The header for holding the native headers of the consumer record; only provided if no header mapper is present.static final String
The header for the partition offset.static final String
Consumer group that failed to consumer a record published to another topic.static final String
Original offset for a record published to another topic.static final String
Original partition for a record published to another topic.static final String
Original timestamp for a record published to another topic.static final String
Original timestamp type for a record published to another topic.static final String
Original topic for a record published to another topic.static final String
The header containing the topic partition when sending data to Kafka.static final String
The prefix for Kafka headers.static final String
The header containing the raw data received from Kafka (ConsumerRecord
orConsumerRecords
).static final String
The prefix for Kafka headers containing 'received' values.static final String
The header containing the record key from the received message.static final String
The header containing the topic partition from the received message.static final String
The header for holding the timestamp of the consumer record.static final String
The header containing the topic from which the message was received.static final String
The header containing theRecordMetadata
object after successful send to the topic.static final String
The header containing a partition number on which to send the reply.static final String
The header containing the default reply topic.static final String
The header for holding the timestamp of the producer record.static final String
The header for holding thetype
of timestamp.static final String
The header containing the topic when sending data to Kafka. -
Constructor Summary
-
Method Summary
-
Field Details
-
PREFIX
The prefix for Kafka headers.- See Also:
-
RECEIVED
The prefix for Kafka headers containing 'received' values.- See Also:
-
TOPIC
The header containing the topic when sending data to Kafka.- See Also:
-
KEY
The header containing the record key when sending data to Kafka.- Since:
- 2.9
- See Also:
-
PARTITION
The header containing the topic partition when sending data to Kafka.- Since:
- 2.0
- See Also:
-
OFFSET
The header for the partition offset.- See Also:
-
RAW_DATA
The header containing the raw data received from Kafka (ConsumerRecord
orConsumerRecords
). Usually used to enhance error messages.- See Also:
-
RECORD_METADATA
The header containing theRecordMetadata
object after successful send to the topic.- See Also:
-
ACKNOWLEDGMENT
The header for theAcknowledgment
.- See Also:
-
CONSUMER
The header for theConsumer
object.- See Also:
-
RECEIVED_TOPIC
The header containing the topic from which the message was received.- See Also:
-
RECEIVED_KEY
The header containing the record key from the received message.- Since:
- 2.9
- See Also:
-
RECEIVED_PARTITION
The header containing the topic partition from the received message.- Since:
- 2.9
- See Also:
-
TIMESTAMP_TYPE
The header for holding thetype
of timestamp.- See Also:
-
TIMESTAMP
The header for holding the timestamp of the producer record.- See Also:
-
RECEIVED_TIMESTAMP
The header for holding the timestamp of the consumer record.- See Also:
-
NATIVE_HEADERS
The header for holding the native headers of the consumer record; only provided if no header mapper is present.- See Also:
-
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:
-
CORRELATION_ID
The header containing information to correlate requests/replies. Type: byte[].- Since:
- 2.1.3
- See Also:
-
REPLY_TOPIC
The header containing the default reply topic. Type: byte[].- Since:
- 2.1.3
- See Also:
-
REPLY_PARTITION
The header containing a partition number on which to send the reply. Type: binary (int) in byte[].- Since:
- 2.1.3
- See Also:
-
DLT_EXCEPTION_FQCN
Exception class name for a record published sent to a dead-letter topic.- Since:
- 2.2
- See Also:
-
DLT_EXCEPTION_CAUSE_FQCN
Exception cause class name for a record published sent to a dead-letter topic.- Since:
- 2.8
- See Also:
-
DLT_EXCEPTION_STACKTRACE
Exception stack trace for a record published to a dead-letter topic.- Since:
- 2.2
- See Also:
-
DLT_EXCEPTION_MESSAGE
Exception message for a record published to a dead-letter topic.- Since:
- 2.2
- See Also:
-
DLT_KEY_EXCEPTION_STACKTRACE
Exception stack trace for a record published to a dead-letter topic with a key deserialization exception.- Since:
- 2.7
- See Also:
-
DLT_KEY_EXCEPTION_MESSAGE
Exception message for a record published to a dead-letter topic with a key deserialization exception.- Since:
- 2.7
- See Also:
-
DLT_KEY_EXCEPTION_FQCN
Exception class name for a record published sent to a dead-letter topic with a key deserialization exception.- Since:
- 2.7
- See Also:
-
DLT_ORIGINAL_TOPIC
Original topic for a record published to a dead-letter topic.- Since:
- 2.2
- See Also:
-
DLT_ORIGINAL_PARTITION
Original partition for a record published to a dead-letter topic.- Since:
- 2.2
- See Also:
-
DLT_ORIGINAL_OFFSET
Original offset for a record published to a dead-letter topic.- Since:
- 2.2
- See Also:
-
DLT_ORIGINAL_CONSUMER_GROUP
Consumer group that failed to consumer a record published to a dead-letter topic.- Since:
- 2.8
- See Also:
-
DLT_ORIGINAL_TIMESTAMP
Original timestamp for a record published to a dead-letter topic.- Since:
- 2.2
- See Also:
-
DLT_ORIGINAL_TIMESTAMP_TYPE
Original timestamp type for a record published to a dead-letter topic.- Since:
- 2.2
- See Also:
-
GROUP_ID
For inbound messages, the container'sgroup.id
consumer property.- Since:
- 2.3
- See Also:
-
DELIVERY_ATTEMPT
For inbound messages, when container retries are enabled the delivery attempt.- Since:
- 2.5
- See Also:
-
EXCEPTION_FQCN
Exception class name for a record published sent to another topic.- Since:
- 2.2
- See Also:
-
EXCEPTION_CAUSE_FQCN
Exception class name for a record published sent to another topic.- Since:
- 2.8
- See Also:
-
EXCEPTION_STACKTRACE
Exception stack trace for a record published to another topic.- Since:
- 2.2
- See Also:
-
EXCEPTION_MESSAGE
Exception message for a record published to another topic.- Since:
- 2.2
- See Also:
-
KEY_EXCEPTION_STACKTRACE
Exception stack trace for a record published to another topic with a key deserialization exception.- Since:
- 2.7
- See Also:
-
KEY_EXCEPTION_MESSAGE
Exception message for a record published to another topic with a key deserialization exception.- Since:
- 2.7
- See Also:
-
KEY_EXCEPTION_FQCN
Exception class name for a record published sent to another topic with a key deserialization exception.- Since:
- 2.7
- See Also:
-
ORIGINAL_TOPIC
Original topic for a record published to another topic.- Since:
- 2.2
- See Also:
-
ORIGINAL_PARTITION
Original partition for a record published to another topic.- Since:
- 2.2
- See Also:
-
ORIGINAL_OFFSET
Original offset for a record published to another topic.- Since:
- 2.2
- See Also:
-
ORIGINAL_CONSUMER_GROUP
Consumer group that failed to consumer a record published to another topic.- Since:
- 2.8
- See Also:
-
ORIGINAL_TIMESTAMP
Original timestamp for a record published to another topic.- Since:
- 2.2
- See Also:
-
ORIGINAL_TIMESTAMP_TYPE
Original timestamp type for a record published to another topic.- Since:
- 2.2
- See Also:
-
CONVERSION_FAILURES
The header containing a list of conversion failures (for batch listeners only). Type: List<ConversionException>.- Since:
- 2.8
- See Also:
-
LISTENER_INFO
Arbitrary static information about the listener receiving this record.- Since:
- 2.8.4
- See Also:
-
-
Constructor Details
-
KafkaHeaders
public KafkaHeaders()
-