Package org.springframework.kafka.core
Interface KafkaOperations<K,V>
- Type Parameters:
K
- the key type.V
- the value type. If the Kafka topic is set withCreateTime
all send operations will use the user provided time if provided, elseKafkaProducer
will generate one If the topic is set withLogAppendTime
then the user provided timestamp will be ignored and instead will be the Kafka broker local time when the message is appended
- All Known Implementing Classes:
AggregatingReplyingKafkaTemplate
,KafkaTemplate
,ReplyingKafkaTemplate
,RoutingKafkaTemplate
public interface KafkaOperations<K,V>
The basic Kafka operations contract returning
CompletableFuture
s.- Author:
- Marius Bogoevici, Gary Russell, Biju Kunjummen
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
A callback for executing arbitrary operations on theKafkaOperations
.static interface
A callback for executing arbitrary operations on theProducer
. -
Field Summary
Modifier and TypeFieldDescriptionstatic final Duration
Default timeout forreceive(String, int, long)
. -
Method Summary
Modifier and TypeMethodDescription<T> T
execute
(KafkaOperations.ProducerCallback<K, V, T> callback) Execute some arbitrary operation(s) on the producer and return the result.<T> T
executeInTransaction
(KafkaOperations.OperationsCallback<K, V, T> callback) Execute some arbitrary operation(s) on the operations and return the result.void
flush()
Flush the producer.default ProducerFactory<K,
V> Return the producer factory used by this template.default boolean
Return true if the template is currently running in a transaction on the calling thread.default boolean
Return true if this template, when transactional, allows non-transactional operations.boolean
Return true if the implementation supports transactions (has a transaction-capable producer factory).Map<org.apache.kafka.common.MetricName,
? extends org.apache.kafka.common.Metric> metrics()
SeeProducer.metrics()
.List<org.apache.kafka.common.PartitionInfo>
partitionsFor
(String topic) SeeProducer.partitionsFor(String)
.Receive a single record with the default poll timeout (5 seconds).Receive a single record.receive
(Collection<TopicPartitionOffset> requested) Receive a multiple records with the default poll timeout (5 seconds).receive
(Collection<TopicPartitionOffset> requested, Duration pollTimeout) Receive multiple records.Send the data to the provided topic with the provided key and partition.Send the data to the provided topic with the provided key and partition.Send the data to the provided topic with the provided key and no partition.Send the data to the provided topic with no key or partition.Send the providedProducerRecord
.Send a message with routing information in message headers.sendDefault
(Integer partition, Long timestamp, K key, V data) Send the data to the default topic with the provided key and partition.sendDefault
(Integer partition, K key, V data) Send the data to the default topic with the provided key and partition.sendDefault
(K key, V data) Send the data to the default topic with the provided key and no partition.sendDefault
(V data) Send the data to the default topic with no key or partition.default void
sendOffsetsToTransaction
(Map<org.apache.kafka.common.TopicPartition, org.apache.kafka.clients.consumer.OffsetAndMetadata> offsets, org.apache.kafka.clients.consumer.ConsumerGroupMetadata groupMetadata) When running in a transaction, send the consumer offset(s) to the transaction.
-
Field Details
-
DEFAULT_POLL_TIMEOUT
Default timeout forreceive(String, int, long)
.
-
-
Method Details
-
sendDefault
Send the data to the default topic with no key or partition.- Parameters:
data
- The data.- Returns:
- a Future for the
SendResult
.
-
sendDefault
Send the data to the default topic with the provided key and no partition.- Parameters:
key
- the key.data
- The data.- Returns:
- a Future for the
SendResult
.
-
sendDefault
Send the data to the default topic with the provided key and partition.- Parameters:
partition
- the partition.key
- the key.data
- the data.- Returns:
- a Future for the
SendResult
.
-
sendDefault
Send the data to the default topic with the provided key and partition.- Parameters:
partition
- the partition.timestamp
- the timestamp of the record.key
- the key.data
- the data.- Returns:
- a Future for the
SendResult
. - Since:
- 1.3
-
send
Send the data to the provided topic with no key or partition.- Parameters:
topic
- the topic.data
- The data.- Returns:
- a Future for the
SendResult
.
-
send
Send the data to the provided topic with the provided key and no partition.- Parameters:
topic
- the topic.key
- the key.data
- The data.- Returns:
- a Future for the
SendResult
.
-
send
Send the data to the provided topic with the provided key and partition.- Parameters:
topic
- the topic.partition
- the partition.key
- the key.data
- the data.- Returns:
- a Future for the
SendResult
.
-
send
CompletableFuture<SendResult<K,V>> send(String topic, Integer partition, Long timestamp, K key, V data) Send the data to the provided topic with the provided key and partition.- Parameters:
topic
- the topic.partition
- the partition.timestamp
- the timestamp of the record.key
- the key.data
- the data.- Returns:
- a Future for the
SendResult
. - Since:
- 1.3
-
send
CompletableFuture<SendResult<K,V>> send(org.apache.kafka.clients.producer.ProducerRecord<K, V> record) Send the providedProducerRecord
.- Parameters:
record
- the record.- Returns:
- a Future for the
SendResult
. - Since:
- 1.3
-
send
Send a message with routing information in message headers. The message payload may be converted before sending.- Parameters:
message
- the message to send.- Returns:
- a Future for the
SendResult
. - See Also:
-
partitionsFor
SeeProducer.partitionsFor(String)
.- Parameters:
topic
- the topic.- Returns:
- the partition info.
- Since:
- 1.1
-
metrics
Map<org.apache.kafka.common.MetricName,? extends org.apache.kafka.common.Metric> metrics()SeeProducer.metrics()
.- Returns:
- the metrics.
- Since:
- 1.1
-
execute
Execute some arbitrary operation(s) on the producer and return the result.- Type Parameters:
T
- the result type.- Parameters:
callback
- the callback.- Returns:
- the result.
- Since:
- 1.1
-
executeInTransaction
Execute some arbitrary operation(s) on the operations and return the result. The operations are invoked within a local transaction and do not participate in a global transaction (if present).- Type Parameters:
T
- the result type.- Parameters:
callback
- the callback.- Returns:
- the result.
- Since:
- 1.1
-
flush
void flush()Flush the producer. -
sendOffsetsToTransaction
default void sendOffsetsToTransaction(Map<org.apache.kafka.common.TopicPartition, org.apache.kafka.clients.consumer.OffsetAndMetadata> offsets, org.apache.kafka.clients.consumer.ConsumerGroupMetadata groupMetadata) When running in a transaction, send the consumer offset(s) to the transaction. It is not necessary to call this method if the operations are invoked on a listener container thread (and the listener container is configured with aKafkaAwareTransactionManager
) since the container will take care of sending the offsets to the transaction. Use with 2.5 brokers or later.- Parameters:
offsets
- The offsets.groupMetadata
- the consumer group metadata.- Since:
- 2.5
- See Also:
-
Producer.sendOffsetsToTransaction(Map, ConsumerGroupMetadata)
-
isTransactional
boolean isTransactional()Return true if the implementation supports transactions (has a transaction-capable producer factory).- Returns:
- true or false.
- Since:
- 2.3
-
isAllowNonTransactional
default boolean isAllowNonTransactional()Return true if this template, when transactional, allows non-transactional operations.- Returns:
- true to allow.
- Since:
- 2.4.3
-
inTransaction
default boolean inTransaction()Return true if the template is currently running in a transaction on the calling thread.- Returns:
- true if a transaction is running.
- Since:
- 2.5
-
getProducerFactory
Return the producer factory used by this template.- Returns:
- the factory.
- Since:
- 2.5
-
receive
@Nullable default org.apache.kafka.clients.consumer.ConsumerRecord<K,V> receive(String topic, int partition, long offset) Receive a single record with the default poll timeout (5 seconds).- Parameters:
topic
- the topic.partition
- the partition.offset
- the offset.- Returns:
- the record or null.
- Since:
- 2.8
- See Also:
-
receive
@Nullable org.apache.kafka.clients.consumer.ConsumerRecord<K,V> receive(String topic, int partition, long offset, Duration pollTimeout) Receive a single record.- Parameters:
topic
- the topic.partition
- the partition.offset
- the offset.pollTimeout
- the timeout.- Returns:
- the record or null.
- Since:
- 2.8
-
receive
default org.apache.kafka.clients.consumer.ConsumerRecords<K,V> receive(Collection<TopicPartitionOffset> requested) Receive a multiple records with the default poll timeout (5 seconds). Only absolute, positive offsets are supported.- Parameters:
requested
- a collection of record requests (topic/partition/offset).- Returns:
- the records
- Since:
- 2.8
- See Also:
-
receive
org.apache.kafka.clients.consumer.ConsumerRecords<K,V> receive(Collection<TopicPartitionOffset> requested, Duration pollTimeout) Receive multiple records. Only absolute, positive offsets are supported.- Parameters:
requested
- a collection of record requests (topic/partition/offset).pollTimeout
- the timeout.- Returns:
- the record or null.
- Since:
- 2.8
-