org.apache.kafka.clients.producer

Interface Producer<K,V>

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

KafkaProducer, MockProducer

public interface Producer<K,V>
extends java.io.Closeable

The interface for the KafkaProducer

See Also:

KafkaProducer, MockProducer

Method Summary

Methods

Modifier and Type	Method and Description
void	abortTransaction() See KafkaProducer.abortTransaction()
void	beginTransaction() See KafkaProducer.beginTransaction()
void	close() Close this producer
void	close(long timeout, java.util.concurrent.TimeUnit unit) Tries to close the producer cleanly within the specified timeout.
void	commitTransaction() See KafkaProducer.commitTransaction()
void	flush() Flush any accumulated records from the producer.
void	initTransactions() See KafkaProducer.initTransactions()
java.util.Map<MetricName,? extends Metric>	metrics() Return a map of metrics maintained by the producer
java.util.List<PartitionInfo>	partitionsFor(java.lang.String topic) Get a list of partitions for the given topic for custom partition assignment.
java.util.concurrent.Future<RecordMetadata>	send(ProducerRecord<K,V> record) Send the given record asynchronously and return a future which will eventually contain the response information.
java.util.concurrent.Future<RecordMetadata>	send(ProducerRecord<K,V> record, Callback callback) Send a record and invoke the given callback when the record has been acknowledged by the server
void	sendOffsetsToTransaction(java.util.Map<TopicPartition,OffsetAndMetadata> offsets, java.lang.String consumerGroupId) See KafkaProducer.sendOffsetsToTransaction(Map, String)

Method Detail

initTransactions

void initTransactions()

See KafkaProducer.initTransactions()

beginTransaction

void beginTransaction()
                      throws ProducerFencedException

See KafkaProducer.beginTransaction()

Throws:

ProducerFencedException

sendOffsetsToTransaction

void sendOffsetsToTransaction(java.util.Map<TopicPartition,OffsetAndMetadata> offsets,
                            java.lang.String consumerGroupId)
                              throws ProducerFencedException

See KafkaProducer.sendOffsetsToTransaction(Map, String)

Throws:

ProducerFencedException

commitTransaction

void commitTransaction()
                       throws ProducerFencedException

See KafkaProducer.commitTransaction()

Throws:

ProducerFencedException

abortTransaction

void abortTransaction()
                      throws ProducerFencedException

See KafkaProducer.abortTransaction()

Throws:

ProducerFencedException

send

java.util.concurrent.Future<RecordMetadata> send(ProducerRecord<K,V> record)

Send the given record asynchronously and return a future which will eventually contain the response information.

Parameters:

record - The record to send

Returns:

A future which will eventually contain the response information

send

java.util.concurrent.Future<RecordMetadata> send(ProducerRecord<K,V> record,
                                               Callback callback)

Send a record and invoke the given callback when the record has been acknowledged by the server

flush

void flush()

Flush any accumulated records from the producer. Blocks until all sends are complete.

partitionsFor

java.util.List<PartitionInfo> partitionsFor(java.lang.String topic)

Get a list of partitions for the given topic for custom partition assignment. The partition metadata will change over time so this list should not be cached.

metrics

java.util.Map<MetricName,? extends Metric> metrics()

Return a map of metrics maintained by the producer

close

void close()

Close this producer

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

close

void close(long timeout,
         java.util.concurrent.TimeUnit unit)

Tries to close the producer cleanly within the specified timeout. If the close does not complete within the timeout, fail any pending send requests and force close the producer.