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.

Constructor Summary

Constructors

Constructor and Description
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(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(Cluster cluster, boolean autoComplete, Partitioner partitioner, Serializer<K> keySerializer, Serializer<V> valueSerializer) Create a mock producer

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear the stored history of sent records
void	close() Close this producer
void	close(long timeout, TimeUnit timeUnit) Tries to close the producer cleanly within the specified timeout.
boolean	completeNext() Complete the earliest uncompleted call successfully.
boolean	errorNext(RuntimeException e) Complete the earliest uncompleted call with the given error.
void	flush() Flush any accumulated records from the producer.
List<ProducerRecord<K,V>>	history() Get the list of sent records since the last call to clear()
Map<MetricName,Metric>	metrics() Return a map of metrics maintained by the producer
List<PartitionInfo>	partitionsFor(String topic) Get a list of partitions for the given topic for custom partition assignment.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

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 @{link java.util.concurrent.Future 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(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)}

Method Detail

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>

Parameters:

record - The record to send

Returns:

A future which will eventually contain the response information

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

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

Specified by:

flush in interface Producer<K,V>

partitionsFor

public List<PartitionInfo> partitionsFor(String topic)

Description copied from interface: Producer

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.

Specified by:

partitionsFor in interface Producer<K,V>

metrics

public Map<MetricName,Metric> metrics()

Description copied from interface: Producer

Return a map of metrics maintained by the producer

Specified by:

metrics in interface Producer<K,V>

close

public void close()

Description copied from interface: Producer

Close this producer

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Producer<K,V>

close

public void close(long timeout,
         TimeUnit timeUnit)

Description copied from interface: Producer

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.

Specified by:

close in interface Producer<K,V>

history

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

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

clear

public void clear()

Clear the stored history of sent records

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