MockConsumer (clients 7.4.7-ce API)

java.lang.Object
- org.apache.kafka.clients.consumer.MockConsumer<K,V>

All Implemented Interfaces:

Closeable, AutoCloseable, Consumer<K,V>
```
public class MockConsumer<K,V>
extends Object
implements Consumer<K,V>
```
A mock of the Consumer interface you can use for testing code that uses Kafka. This class is not threadsafe . However, you can use the schedulePollTask(Runnable) method to write multithreaded tests where a driver thread waits for poll(Duration) to be called by a background thread and then can safely perform operations during a callback.

Constructor Summary

Constructors
Constructor and Description

MockConsumer(OffsetResetStrategy offsetResetStrategy)

Constructors
Constructor and Description
`MockConsumer(OffsetResetStrategy offsetResetStrategy)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addRecord(ConsumerRecord<K,V> record)`
`void`	`assign(Collection<TopicPartition> partitions)`
`Set<TopicPartition>`	`assignment()`
`Map<TopicPartition,Long>`	`beginningOffsets(Collection<TopicPartition> partitions)`
`Map<TopicPartition,Long>`	`beginningOffsets(Collection<TopicPartition> partitions, Duration timeout)`
`void`	`close()`
`void`	`close(Duration timeout)`
`boolean`	`closed()`
`void`	`commitAsync()`
`void`	`commitAsync(Map<TopicPartition,OffsetAndMetadata> offsets, OffsetCommitCallback callback)`
`void`	`commitAsync(OffsetCommitCallback callback)`
`void`	`commitSync()`
`void`	`commitSync(Duration timeout)`
`void`	`commitSync(Map<TopicPartition,OffsetAndMetadata> offsets)`
`void`	`commitSync(Map<TopicPartition,OffsetAndMetadata> offsets, Duration timeout)`
`Map<TopicPartition,OffsetAndMetadata>`	`committed(Set<TopicPartition> partitions)`
`Map<TopicPartition,OffsetAndMetadata>`	`committed(Set<TopicPartition> partitions, Duration timeout)`
`OffsetAndMetadata`	`committed(TopicPartition partition)` Deprecated.
`OffsetAndMetadata`	`committed(TopicPartition partition, Duration timeout)` Deprecated.
`OptionalLong`	`currentLag(TopicPartition topicPartition)`
`Map<TopicPartition,Long>`	`endOffsets(Collection<TopicPartition> partitions)`
`Map<TopicPartition,Long>`	`endOffsets(Collection<TopicPartition> partitions, Duration timeout)`
`void`	`enforceRebalance()`
`void`	`enforceRebalance(String reason)`
`ConsumerGroupMetadata`	`groupMetadata()`
`Duration`	`lastPollTimeout()`
`Map<String,List<PartitionInfo>>`	`listTopics()`
`Map<String,List<PartitionInfo>>`	`listTopics(Duration timeout)`
`Map<MetricName,? extends Metric>`	`metrics()`
`Map<TopicPartition,OffsetAndTimestamp>`	`offsetsForTimes(Map<TopicPartition,Long> timestampsToSearch)`
`Map<TopicPartition,OffsetAndTimestamp>`	`offsetsForTimes(Map<TopicPartition,Long> timestampsToSearch, Duration timeout)`
`List<PartitionInfo>`	`partitionsFor(String topic)`
`List<PartitionInfo>`	`partitionsFor(String topic, Duration timeout)`
`void`	`pause(Collection<TopicPartition> partitions)`
`Set<TopicPartition>`	`paused()`
`ConsumerRecords<K,V>`	`poll(Duration timeout)`
`ConsumerRecords<K,V>`	`poll(long timeout)` Deprecated.
`long`	`position(TopicPartition partition)`
`long`	`position(TopicPartition partition, Duration timeout)`
`void`	`rebalance(Collection<TopicPartition> newAssignment)` Simulate a rebalance event.
`void`	`resetShouldRebalance()`
`void`	`resume(Collection<TopicPartition> partitions)`
`void`	`scheduleNopPollTask()`
`void`	`schedulePollTask(Runnable task)` Schedule a task to be executed during a poll().
`void`	`seek(TopicPartition partition, long offset)`
`void`	`seek(TopicPartition partition, OffsetAndMetadata offsetAndMetadata)`
`void`	`seekToBeginning(Collection<TopicPartition> partitions)`
`void`	`seekToEnd(Collection<TopicPartition> partitions)`
`void`	`setException(KafkaException exception)` Deprecated. Use `setPollException(KafkaException)` instead
`void`	`setOffsetsException(KafkaException exception)`
`void`	`setPollException(KafkaException exception)`
`void`	`setPositionException(KafkaException exception)`
`boolean`	`shouldRebalance()`
`void`	`subscribe(Collection<String> topics)`
`void`	`subscribe(Collection<String> topics, ConsumerRebalanceListener listener)`
`void`	`subscribe(Pattern pattern)`
`void`	`subscribe(Pattern pattern, ConsumerRebalanceListener listener)`
`Set<String>`	`subscription()`
`void`	`unsubscribe()`
`void`	`updateBeginningOffsets(Map<TopicPartition,Long> newOffsets)`
`void`	`updateEndOffsets(Map<TopicPartition,Long> newOffsets)`
`void`	`updatePartitions(String topic, List<PartitionInfo> partitions)`
`void`	`wakeup()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MockConsumer
```
public MockConsumer(OffsetResetStrategy offsetResetStrategy)
```
- Method Detail
  - assignment
```
public Set<TopicPartition> assignment()
```
    Specified by:
    
    assignment in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.assignment()
  - rebalance
```
public void rebalance(Collection<TopicPartition> newAssignment)
```
    Simulate a rebalance event.
  - subscription
```
public Set<String> subscription()
```
    Specified by:
    
    subscription in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.subscription()
  - subscribe
```
public void subscribe(Collection<String> topics)
```
    Specified by:
    
    subscribe in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.subscribe(Collection)
  - subscribe
```
public void subscribe(Pattern pattern,
                      ConsumerRebalanceListener listener)
```
    Specified by:
    
    subscribe in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.subscribe(Pattern, ConsumerRebalanceListener)
  - subscribe
```
public void subscribe(Pattern pattern)
```
    Specified by:
    
    subscribe in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.subscribe(Pattern)
  - subscribe
```
public void subscribe(Collection<String> topics,
                      ConsumerRebalanceListener listener)
```
    Specified by:
    
    subscribe in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.subscribe(Collection, ConsumerRebalanceListener)
  - assign
```
public void assign(Collection<TopicPartition> partitions)
```
    Specified by:
    
    assign in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.assign(Collection)
  - unsubscribe
```
public void unsubscribe()
```
    Specified by:
    
    unsubscribe in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.unsubscribe()
  - poll
```
@Deprecated
public ConsumerRecords<K,V> poll(long timeout)
```
    Deprecated.
    
    Specified by:
    
    poll in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.poll(long)
  - poll
```
public ConsumerRecords<K,V> poll(Duration timeout)
```
    Specified by:
    
    poll in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.poll(Duration)
  - addRecord
```
public void addRecord(ConsumerRecord<K,V> record)
```
  - setException
```
@Deprecated
public void setException(KafkaException exception)
```
    Deprecated. Use setPollException(KafkaException) instead
  - setPollException
```
public void setPollException(KafkaException exception)
```
  - setOffsetsException
```
public void setOffsetsException(KafkaException exception)
```
  - setPositionException
```
public void setPositionException(KafkaException exception)
```
  - commitAsync
```
public void commitAsync(Map<TopicPartition,OffsetAndMetadata> offsets,
                        OffsetCommitCallback callback)
```
    Specified by:
    
    commitAsync in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.commitAsync(Map, OffsetCommitCallback)
  - commitSync
```
public void commitSync(Map<TopicPartition,OffsetAndMetadata> offsets)
```
    Specified by:
    
    commitSync in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.commitSync(Map)
  - commitAsync
```
public void commitAsync()
```
    Specified by:
    
    commitAsync in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.commitAsync()
  - commitAsync
```
public void commitAsync(OffsetCommitCallback callback)
```
    Specified by:
    
    commitAsync in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.commitAsync(OffsetCommitCallback)
  - commitSync
```
public void commitSync()
```
    Specified by:
    
    commitSync in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.commitSync()
  - commitSync
```
public void commitSync(Duration timeout)
```
    Specified by:
    
    commitSync in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.commitSync(Duration)
  - commitSync
```
public void commitSync(Map<TopicPartition,OffsetAndMetadata> offsets,
                       Duration timeout)
```
    Specified by:
    
    commitSync in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.commitSync(Map, Duration)
  - seek
```
public void seek(TopicPartition partition,
                 long offset)
```
    Specified by:
    
    seek in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.seek(TopicPartition, long)
  - seek
```
public void seek(TopicPartition partition,
                 OffsetAndMetadata offsetAndMetadata)
```
    Specified by:
    
    seek in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.seek(TopicPartition, OffsetAndMetadata)
  - committed
```
@Deprecated
public OffsetAndMetadata committed(TopicPartition partition)
```
    Deprecated.
    
    Specified by:
    
    committed in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.committed(TopicPartition)
  - committed
```
@Deprecated
public OffsetAndMetadata committed(TopicPartition partition,
                                               Duration timeout)
```
    Deprecated.
    
    Specified by:
    
    committed in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.committed(TopicPartition, Duration)
  - committed
```
public Map<TopicPartition,OffsetAndMetadata> committed(Set<TopicPartition> partitions)
```
    Specified by:
    
    committed in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.committed(Set)
  - committed
```
public Map<TopicPartition,OffsetAndMetadata> committed(Set<TopicPartition> partitions,
                                                       Duration timeout)
```
    Specified by:
    
    committed in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.committed(Set, Duration)
  - position
```
public long position(TopicPartition partition)
```
    Specified by:
    
    position in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.position(TopicPartition)
  - position
```
public long position(TopicPartition partition,
                     Duration timeout)
```
    Specified by:
    
    position in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.position(TopicPartition, Duration)
  - seekToBeginning
```
public void seekToBeginning(Collection<TopicPartition> partitions)
```
    Specified by:
    
    seekToBeginning in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.seekToBeginning(Collection)
  - updateBeginningOffsets
```
public void updateBeginningOffsets(Map<TopicPartition,Long> newOffsets)
```
  - seekToEnd
```
public void seekToEnd(Collection<TopicPartition> partitions)
```
    Specified by:
    
    seekToEnd in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.seekToEnd(Collection)
  - updateEndOffsets
```
public void updateEndOffsets(Map<TopicPartition,Long> newOffsets)
```
  - metrics
```
public Map<MetricName,? extends Metric> metrics()
```
    Specified by:
    
    metrics in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.metrics()
  - partitionsFor
```
public List<PartitionInfo> partitionsFor(String topic)
```
    Specified by:
    
    partitionsFor in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.partitionsFor(String)
  - listTopics
```
public Map<String,List<PartitionInfo>> listTopics()
```
    Specified by:
    
    listTopics in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.listTopics()
  - updatePartitions
```
public void updatePartitions(String topic,
                             List<PartitionInfo> partitions)
```
  - pause
```
public void pause(Collection<TopicPartition> partitions)
```
    Specified by:
    
    pause in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.pause(Collection)
  - resume
```
public void resume(Collection<TopicPartition> partitions)
```
    Specified by:
    
    resume in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.resume(Collection)
  - offsetsForTimes
```
public Map<TopicPartition,OffsetAndTimestamp> offsetsForTimes(Map<TopicPartition,Long> timestampsToSearch)
```
    Specified by:
    
    offsetsForTimes in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.offsetsForTimes(Map)
  - beginningOffsets
```
public Map<TopicPartition,Long> beginningOffsets(Collection<TopicPartition> partitions)
```
    Specified by:
    
    beginningOffsets in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.beginningOffsets(Collection)
  - endOffsets
```
public Map<TopicPartition,Long> endOffsets(Collection<TopicPartition> partitions)
```
    Specified by:
    
    endOffsets in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.endOffsets(Collection)
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.close()
  - close
```
public void close(Duration timeout)
```
    Specified by:
    
    close in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.close(Duration)
  - closed
```
public boolean closed()
```
  - wakeup
```
public void wakeup()
```
    Specified by:
    
    wakeup in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.wakeup()
  - schedulePollTask
```
public void schedulePollTask(Runnable task)
```
    Schedule a task to be executed during a poll(). One enqueued task will be executed per poll(Duration) invocation. You can use this repeatedly to mock out multiple responses to poll invocations.
    
    Parameters:
    
    task - the task to be executed
  - scheduleNopPollTask
```
public void scheduleNopPollTask()
```
  - paused
```
public Set<TopicPartition> paused()
```
    Specified by:
    
    paused in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.paused()
  - partitionsFor
```
public List<PartitionInfo> partitionsFor(String topic,
                                         Duration timeout)
```
    Specified by:
    
    partitionsFor in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.partitionsFor(String, Duration)
  - listTopics
```
public Map<String,List<PartitionInfo>> listTopics(Duration timeout)
```
    Specified by:
    
    listTopics in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.listTopics(Duration)
  - offsetsForTimes
```
public Map<TopicPartition,OffsetAndTimestamp> offsetsForTimes(Map<TopicPartition,Long> timestampsToSearch,
                                                              Duration timeout)
```
    Specified by:
    
    offsetsForTimes in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.offsetsForTimes(Map, Duration)
  - beginningOffsets
```
public Map<TopicPartition,Long> beginningOffsets(Collection<TopicPartition> partitions,
                                                 Duration timeout)
```
    Specified by:
    
    beginningOffsets in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.beginningOffsets(Collection, Duration)
  - endOffsets
```
public Map<TopicPartition,Long> endOffsets(Collection<TopicPartition> partitions,
                                           Duration timeout)
```
    Specified by:
    
    endOffsets in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.endOffsets(Collection, Duration)
  - currentLag
```
public OptionalLong currentLag(TopicPartition topicPartition)
```
    Specified by:
    
    currentLag in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.currentLag(TopicPartition)
  - groupMetadata
```
public ConsumerGroupMetadata groupMetadata()
```
    Specified by:
    
    groupMetadata in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.groupMetadata()
  - enforceRebalance
```
public void enforceRebalance()
```
    Specified by:
    
    enforceRebalance in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.enforceRebalance()
  - enforceRebalance
```
public void enforceRebalance(String reason)
```
    Specified by:
    
    enforceRebalance in interface Consumer<K,V>
    
    See Also:
    
    KafkaConsumer.enforceRebalance(String)
  - shouldRebalance
```
public boolean shouldRebalance()
```
  - resetShouldRebalance
```
public void resetShouldRebalance()
```
  - lastPollTimeout
```
public Duration lastPollTimeout()
```

Class MockConsumer<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MockConsumer

Method Detail

assignment

rebalance

subscription

subscribe

subscribe

subscribe

subscribe

assign

unsubscribe

poll

poll

addRecord

setException

setPollException

setOffsetsException

setPositionException

commitAsync

commitSync

commitAsync

commitAsync

commitSync

commitSync

commitSync

seek

seek

committed

committed

committed

committed

position

position

seekToBeginning

updateBeginningOffsets

seekToEnd

updateEndOffsets

metrics

partitionsFor

listTopics

updatePartitions

pause

resume

offsetsForTimes

beginningOffsets

endOffsets

close

close

closed

wakeup

schedulePollTask

scheduleNopPollTask

paused

partitionsFor

listTopics

offsetsForTimes

beginningOffsets

endOffsets

currentLag

groupMetadata

enforceRebalance

enforceRebalance

shouldRebalance

resetShouldRebalance

lastPollTimeout