Package org.apache.kafka.clients.producer

Class MockProducer<K,V>

java.lang.Object

org.apache.kafka.clients.producer.MockProducer<K,V>

All Implemented Interfaces:

Closeable, AutoCloseable, Producer<K,V>

public class MockProducer<K,V>
extends Object
implements Producer<K,V>

A mock of the producer interface you can use for testing code that uses Kafka.

By default this mock will synchronously complete each send call successfully. However it can be configured to allow the user to control the completion of the call and supply an optional error for the producer to throw.

Field Summary

Fields

Modifier and Type	Field	Description
RuntimeException	abortTransactionException
RuntimeException	beginTransactionException
RuntimeException	closeException
RuntimeException	commitTransactionException
RuntimeException	flushException
RuntimeException	initTransactionException
RuntimeException	partitionsForException
RuntimeException	sendException
RuntimeException	sendOffsetsToTransactionException

Constructor Summary

Constructors

Constructor	Description
MockProducer()	Create a new mock producer with invented metadata.
MockProducer(boolean autoComplete, Partitioner partitioner, Serializer<K> keySerializer, Serializer<V> valueSerializer)	Create a new mock producer with invented metadata the given autoComplete setting, partitioner and key\value serializers.
MockProducer(boolean autoComplete, Serializer<K> keySerializer, Serializer<V> valueSerializer)	Create a new mock producer with invented metadata the given autoComplete setting and key\value serializers.
MockProducer(Cluster cluster, boolean autoComplete, Partitioner partitioner, Serializer<K> keySerializer, Serializer<V> valueSerializer)	Create a mock producer
MockProducer(Cluster cluster, boolean autoComplete, Serializer<K> keySerializer, Serializer<V> valueSerializer)	Create a new mock producer with invented metadata the given autoComplete setting and key\value serializers.

Method Summary

Modifier and Type	Method	Description
void	abortTransaction()	See KafkaProducer.abortTransaction()
void	beginTransaction()	See KafkaProducer.beginTransaction()
void	clear()	Clear the stored history of sent records, consumer group offsets
Uuid	clientInstanceId(Duration timeout)	See KafkaProducer.clientInstanceId(Duration)}
void	close()	See KafkaProducer.close()
void	close(Duration timeout)	See KafkaProducer.close(Duration)
boolean	closed()
long	commitCount()
void	commitTransaction()	See KafkaProducer.commitTransaction()
boolean	completeNext()	Complete the earliest uncompleted call successfully.
List<Map<String,Map<TopicPartition,OffsetAndMetadata>>>	consumerGroupOffsetsHistory()	Get the list of committed consumer group offsets since the last call to clear()
void	disableTelemetry()
boolean	errorNext(RuntimeException e)	Complete the earliest uncompleted call with the given error.
void	fenceProducer()
void	flush()	See KafkaProducer.flush()
boolean	flushed()
List<ProducerRecord<K,V>>	history()	Get the list of sent records since the last call to clear()
void	initTransactions()	See KafkaProducer.initTransactions()
void	injectTimeoutException(int injectTimeoutExceptionCounter)
Map<MetricName,Metric>	metrics()	See KafkaProducer.metrics()
List<PartitionInfo>	partitionsFor(String topic)	See KafkaProducer.partitionsFor(String)
Future<RecordMetadata>	send(ProducerRecord<K,V> record)	Adds the record to the list of sent records.
Future<RecordMetadata>	send(ProducerRecord<K,V> record, Callback callback)	Adds the record to the list of sent records.
void	sendOffsetsToTransaction(Map<TopicPartition,OffsetAndMetadata> offsets, String consumerGroupId)	Deprecated.
void	sendOffsetsToTransaction(Map<TopicPartition,OffsetAndMetadata> offsets, ConsumerGroupMetadata groupMetadata)	See KafkaProducer.sendOffsetsToTransaction(Map, ConsumerGroupMetadata)
boolean	sentOffsets()
void	setClientInstanceId(Uuid instanceId)
void	setMockMetrics(MetricName name, Metric metric)	Set a mock metric for testing purpose
boolean	transactionAborted()
boolean	transactionCommitted()
boolean	transactionInFlight()
boolean	transactionInitialized()
Map<String,Map<TopicPartition,OffsetAndMetadata>>	uncommittedOffsets()
List<ProducerRecord<K,V>>	uncommittedRecords()

Methods inherited from class java.lang.Object

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

Field Details

initTransactionException

public RuntimeException initTransactionException

beginTransactionException

public RuntimeException beginTransactionException

sendOffsetsToTransactionException

public RuntimeException sendOffsetsToTransactionException

commitTransactionException

public RuntimeException commitTransactionException

abortTransactionException

public RuntimeException abortTransactionException

sendException

public RuntimeException sendException

flushException

public RuntimeException flushException

partitionsForException

public RuntimeException partitionsForException

closeException

public RuntimeException closeException

Constructor Details

MockProducer

public MockProducer(Cluster cluster,
 boolean autoComplete,
 Partitioner partitioner,
 Serializer<K> keySerializer,
 Serializer<V> valueSerializer)

Create a mock producer

Parameters:

cluster - The cluster holding metadata for this producer

autoComplete - If true automatically complete all requests successfully and execute the callback. Otherwise the user must call completeNext() or errorNext(RuntimeException) after send() to complete the call and unblock the Future<RecordMetadata> that is returned.

partitioner - The partition strategy

keySerializer - The serializer for key that implements Serializer.

valueSerializer - The serializer for value that implements Serializer.

MockProducer

public MockProducer(boolean autoComplete,
 Serializer<K> keySerializer,
 Serializer<V> valueSerializer)

Create a new mock producer with invented metadata the given autoComplete setting and key\value serializers. Equivalent to MockProducer(Cluster, boolean, Partitioner, Serializer, Serializer) new MockProducer(Cluster.empty(), autoComplete, new DefaultPartitioner(), keySerializer, valueSerializer)}

MockProducer

public MockProducer(Cluster cluster,
 boolean autoComplete,
 Serializer<K> keySerializer,
 Serializer<V> valueSerializer)

Create a new mock producer with invented metadata the given autoComplete setting and key\value serializers. Equivalent to MockProducer(Cluster, boolean, Partitioner, Serializer, Serializer) new MockProducer(cluster, autoComplete, new DefaultPartitioner(), keySerializer, valueSerializer)}

MockProducer

public MockProducer(boolean autoComplete,
 Partitioner partitioner,
 Serializer<K> keySerializer,
 Serializer<V> valueSerializer)

Create a new mock producer with invented metadata the given autoComplete setting, partitioner and key\value serializers. Equivalent to MockProducer(Cluster, boolean, Partitioner, Serializer, Serializer) new MockProducer(Cluster.empty(), autoComplete, partitioner, keySerializer, valueSerializer)}

MockProducer

public MockProducer()

Create a new mock producer with invented metadata. Equivalent to MockProducer(Cluster, boolean, Partitioner, Serializer, Serializer) new MockProducer(Cluster.empty(), false, null, null, null)}

Method Details

initTransactions

public void initTransactions()

Description copied from interface: Producer

See KafkaProducer.initTransactions()

Specified by:

initTransactions in interface Producer<K,V>

beginTransaction

public void beginTransaction()
                      throws ProducerFencedException

Description copied from interface: Producer

See KafkaProducer.beginTransaction()

Specified by:

beginTransaction in interface Producer<K,V>

Throws:

ProducerFencedException

sendOffsetsToTransaction

@Deprecated
public void sendOffsetsToTransaction(Map<TopicPartition,OffsetAndMetadata> offsets,
 String consumerGroupId)
                              throws ProducerFencedException

Deprecated.

Description copied from interface: Producer

See KafkaProducer.sendOffsetsToTransaction(Map, String)

Specified by:

sendOffsetsToTransaction in interface Producer<K,V>

Throws:

ProducerFencedException

sendOffsetsToTransaction

public void sendOffsetsToTransaction(Map<TopicPartition,OffsetAndMetadata> offsets,
 ConsumerGroupMetadata groupMetadata)
                              throws ProducerFencedException

Description copied from interface: Producer

See KafkaProducer.sendOffsetsToTransaction(Map, ConsumerGroupMetadata)

Specified by:

sendOffsetsToTransaction in interface Producer<K,V>

Throws:

ProducerFencedException

commitTransaction

public void commitTransaction()
                       throws ProducerFencedException

Description copied from interface: Producer

See KafkaProducer.commitTransaction()

Specified by:

commitTransaction in interface Producer<K,V>

Throws:

ProducerFencedException

abortTransaction

public void abortTransaction()
                      throws ProducerFencedException

Description copied from interface: Producer

See KafkaProducer.abortTransaction()

Specified by:

abortTransaction in interface Producer<K,V>

Throws:

ProducerFencedException

send

public Future<RecordMetadata> send(ProducerRecord<K,V> record)

Adds the record to the list of sent records. The RecordMetadata returned will be immediately satisfied.

Specified by:

send in interface Producer<K,V>

See Also:

• history()

send

public Future<RecordMetadata> send(ProducerRecord<K,V> record,
 Callback callback)

Adds the record to the list of sent records.

Specified by:

send in interface Producer<K,V>

See Also:

• history()

flush

public void flush()

Description copied from interface: Producer

See KafkaProducer.flush()

Specified by:

flush in interface Producer<K,V>

partitionsFor

public List<PartitionInfo> partitionsFor(String topic)

Description copied from interface: Producer

See KafkaProducer.partitionsFor(String)

Specified by:

partitionsFor in interface Producer<K,V>

disableTelemetry

public void disableTelemetry()

injectTimeoutException

public void injectTimeoutException(int injectTimeoutExceptionCounter)

Parameters:

injectTimeoutExceptionCounter - use -1 for infinite

setClientInstanceId

public void setClientInstanceId(Uuid instanceId)

clientInstanceId

public Uuid clientInstanceId(Duration timeout)

Description copied from interface: Producer

See KafkaProducer.clientInstanceId(Duration)}

Specified by:

clientInstanceId in interface Producer<K,V>

metrics

public Map<MetricName,Metric> metrics()

Description copied from interface: Producer

See KafkaProducer.metrics()

Specified by:

metrics in interface Producer<K,V>

setMockMetrics

public void setMockMetrics(MetricName name,
 Metric metric)

Set a mock metric for testing purpose

close

public void close()

Description copied from interface: Producer

See KafkaProducer.close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Producer<K,V>

close

public void close(Duration timeout)

Description copied from interface: Producer

See KafkaProducer.close(Duration)

Specified by:

close in interface Producer<K,V>

closed

public boolean closed()

fenceProducer

public void fenceProducer()

transactionInitialized

public boolean transactionInitialized()

transactionInFlight

public boolean transactionInFlight()

transactionCommitted

public boolean transactionCommitted()

transactionAborted

public boolean transactionAborted()

flushed

public boolean flushed()

sentOffsets

public boolean sentOffsets()

commitCount

public long commitCount()

history

public List<ProducerRecord<K,V>> history()

Get the list of sent records since the last call to clear()

uncommittedRecords

public List<ProducerRecord<K,V>> uncommittedRecords()

consumerGroupOffsetsHistory

public List<Map<String,Map<TopicPartition,OffsetAndMetadata>>> consumerGroupOffsetsHistory()

Get the list of committed consumer group offsets since the last call to clear()

uncommittedOffsets

public Map<String,Map<TopicPartition,OffsetAndMetadata>> uncommittedOffsets()

clear

public void clear()

Clear the stored history of sent records, consumer group offsets

completeNext

public boolean completeNext()

Complete the earliest uncompleted call successfully.

Returns:

true if there was an uncompleted call to complete

errorNext

public boolean errorNext(RuntimeException e)

Complete the earliest uncompleted call with the given error.

Returns:

true if there was an uncompleted call to complete