Package org.apache.kafka.streams.test

Class ConsumerRecordFactory<K,V>

java.lang.Object

org.apache.kafka.streams.test.ConsumerRecordFactory<K,V>

Type Parameters:

K - the type of the key

V - the type of the value

@Evolving
public class ConsumerRecordFactory<K,V>
extends java.lang.Object

Factory to create consumer records for a single single-partitioned topic with given key and value serializers.

See Also:

TopologyTestDriver

Constructor Summary

Constructors

Constructor	Description
ConsumerRecordFactory(java.lang.String defaultTopicName, Serializer<K> keySerializer, Serializer<V> valueSerializer)	Create a new factory for the given topic.
ConsumerRecordFactory(java.lang.String defaultTopicName, Serializer<K> keySerializer, Serializer<V> valueSerializer, long startTimestampMs)	Create a new factory for the given topic.
ConsumerRecordFactory(java.lang.String defaultTopicName, Serializer<K> keySerializer, Serializer<V> valueSerializer, long startTimestampMs, long autoAdvanceMs)	Create a new factory for the given topic.
ConsumerRecordFactory(Serializer<K> keySerializer, Serializer<V> valueSerializer)	Create a new factory for the given topic.
ConsumerRecordFactory(Serializer<K> keySerializer, Serializer<V> valueSerializer, long startTimestampMs)	Create a new factory for the given topic.
ConsumerRecordFactory(Serializer<K> keySerializer, Serializer<V> valueSerializer, long startTimestampMs, long autoAdvanceMs)	Create a new factory for the given topic.

Method Summary

Modifier and Type	Method	Description
void	advanceTimeMs(long advanceMs)	Advances the internally tracked time.
java.util.List<ConsumerRecord<byte[],byte[]>>	create(java.lang.String topicName, java.util.List<KeyValue<K,V>> keyValues)	Creates consumer records with the given topic name, keys, and values.
java.util.List<ConsumerRecord<byte[],byte[]>>	create(java.lang.String topicName, java.util.List<KeyValue<K,V>> keyValues, long startTimestamp)	Creates consumer records with the given topic name, keys and values.
java.util.List<ConsumerRecord<byte[],byte[]>>	create(java.lang.String topicName, java.util.List<KeyValue<K,V>> keyValues, long startTimestamp, long advanceMs)	Creates consumer records with the given topic name, keys, and values.
ConsumerRecord<byte[],byte[]>	create(java.lang.String topicName, K key, V value)	Create a ConsumerRecord with the given topic name, key, and value.
ConsumerRecord<byte[],byte[]>	create(java.lang.String topicName, K key, V value, long timestampMs)	Create a ConsumerRecord with the given topic name and given topic, key, value, and timestamp.
ConsumerRecord<byte[],byte[]>	create(java.lang.String topicName, K key, V value, Headers headers)	Create a ConsumerRecord with the given topic name, key, value, and headers.
ConsumerRecord<byte[],byte[]>	create(java.lang.String topicName, K key, V value, Headers headers, long timestampMs)	Create a ConsumerRecord with the given topic name, key, value, headers, and timestamp.
ConsumerRecord<byte[],byte[]>	create(java.lang.String topicName, V value)	Create a ConsumerRecord with null-key and the given topic name and value.
ConsumerRecord<byte[],byte[]>	create(java.lang.String topicName, V value, long timestampMs)	Create a ConsumerRecord with null-key and the given topic name, value, and timestamp.
ConsumerRecord<byte[],byte[]>	create(java.lang.String topicName, V value, Headers headers)	Create a ConsumerRecord with null-key and the given topic name, value, and headers.
ConsumerRecord<byte[],byte[]>	create(java.lang.String topicName, V value, Headers headers, long timestampMs)	Create a ConsumerRecord with null-key and the given topic name, value, headers, and timestamp.
java.util.List<ConsumerRecord<byte[],byte[]>>	create(java.util.List<KeyValue<K,V>> keyValues)	Creates consumer records with default topic name as well as given keys and values.
java.util.List<ConsumerRecord<byte[],byte[]>>	create(java.util.List<KeyValue<K,V>> keyValues, long startTimestamp)	Creates consumer records with the given keys and values.
java.util.List<ConsumerRecord<byte[],byte[]>>	create(java.util.List<KeyValue<K,V>> keyValues, long startTimestamp, long advanceMs)	Creates consumer records with default topic name as well as given keys and values.
ConsumerRecord<byte[],byte[]>	create(K key, V value)	Create a ConsumerRecord with default topic name and given key and value.
ConsumerRecord<byte[],byte[]>	create(K key, V value, long timestampMs)	Create a ConsumerRecord with default topic name and given key, value, and timestamp.
ConsumerRecord<byte[],byte[]>	create(K key, V value, Headers headers)	Create a ConsumerRecord with default topic name and given key, value, and headers.
ConsumerRecord<byte[],byte[]>	create(K key, V value, Headers headers, long timestampMs)	Create a ConsumerRecord with default topic name and given key, value, headers, and timestamp.
ConsumerRecord<byte[],byte[]>	create(V value)	Create a ConsumerRecord with default topic name and null-key was well as given value.
ConsumerRecord<byte[],byte[]>	create(V value, long timestampMs)	Create a ConsumerRecord with default topic name and null-key as well as given value and timestamp.
ConsumerRecord<byte[],byte[]>	create(V value, Headers headers)	Create a ConsumerRecord with default topic name and null-key was well as given value and headers.
ConsumerRecord<byte[],byte[]>	create(V value, Headers headers, long timestampMs)	Create a ConsumerRecord with default topic name and null-key as well as given value, headers, and timestamp.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumerRecordFactory

public ConsumerRecordFactory(Serializer<K> keySerializer,
                             Serializer<V> valueSerializer)

Create a new factory for the given topic. Uses current system time as start timestamp. Auto-advance is disabled.

Parameters:

keySerializer - the key serializer

valueSerializer - the value serializer

ConsumerRecordFactory

public ConsumerRecordFactory(java.lang.String defaultTopicName,
                             Serializer<K> keySerializer,
                             Serializer<V> valueSerializer)

Create a new factory for the given topic. Uses current system time as start timestamp. Auto-advance is disabled.

Parameters:

defaultTopicName - the default topic name used for all generated consumer records

keySerializer - the key serializer

valueSerializer - the value serializer

ConsumerRecordFactory

public ConsumerRecordFactory(Serializer<K> keySerializer,
                             Serializer<V> valueSerializer,
                             long startTimestampMs)

Create a new factory for the given topic. Auto-advance is disabled.

Parameters:

keySerializer - the key serializer

valueSerializer - the value serializer

startTimestampMs - the initial timestamp for generated records

ConsumerRecordFactory

public ConsumerRecordFactory(java.lang.String defaultTopicName,
                             Serializer<K> keySerializer,
                             Serializer<V> valueSerializer,
                             long startTimestampMs)

Create a new factory for the given topic. Auto-advance is disabled.

Parameters:

defaultTopicName - the topic name used for all generated consumer records

keySerializer - the key serializer

valueSerializer - the value serializer

startTimestampMs - the initial timestamp for generated records

ConsumerRecordFactory

public ConsumerRecordFactory(Serializer<K> keySerializer,
                             Serializer<V> valueSerializer,
                             long startTimestampMs,
                             long autoAdvanceMs)

Create a new factory for the given topic.

Parameters:

keySerializer - the key serializer

valueSerializer - the value serializer

startTimestampMs - the initial timestamp for generated records

autoAdvanceMs - the time increment pre generated record

ConsumerRecordFactory

public ConsumerRecordFactory(java.lang.String defaultTopicName,
                             Serializer<K> keySerializer,
                             Serializer<V> valueSerializer,
                             long startTimestampMs,
                             long autoAdvanceMs)

Create a new factory for the given topic.

Parameters:

defaultTopicName - the topic name used for all generated consumer records

keySerializer - the key serializer

valueSerializer - the value serializer

startTimestampMs - the initial timestamp for generated records

autoAdvanceMs - the time increment pre generated record

Method Detail

advanceTimeMs

public void advanceTimeMs(long advanceMs)

Advances the internally tracked time.

Parameters:

advanceMs - the amount of time to advance

create

public ConsumerRecord<byte[],byte[]> create(java.lang.String topicName,
                                            K key,
                                            V value,
                                            Headers headers,
                                            long timestampMs)

Create a ConsumerRecord with the given topic name, key, value, headers, and timestamp. Does not auto advance internally tracked time.

Parameters:

topicName - the topic name

key - the record key

value - the record value

headers - the record headers

timestampMs - the record timestamp

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(java.lang.String topicName,
                                            K key,
                                            V value,
                                            long timestampMs)

Create a ConsumerRecord with the given topic name and given topic, key, value, and timestamp. Does not auto advance internally tracked time.

Parameters:

topicName - the topic name

key - the record key

value - the record value

timestampMs - the record timestamp

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(K key,
                                            V value,
                                            long timestampMs)

Create a ConsumerRecord with default topic name and given key, value, and timestamp. Does not auto advance internally tracked time.

Parameters:

key - the record key

value - the record value

timestampMs - the record timestamp

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(K key,
                                            V value,
                                            Headers headers,
                                            long timestampMs)

Create a ConsumerRecord with default topic name and given key, value, headers, and timestamp. Does not auto advance internally tracked time.

Parameters:

key - the record key

value - the record value

headers - the record headers

timestampMs - the record timestamp

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(java.lang.String topicName,
                                            K key,
                                            V value)

Create a ConsumerRecord with the given topic name, key, and value. The timestamp will be generated based on the constructor provided start time and time will auto advance.

Parameters:

topicName - the topic name

key - the record key

value - the record value

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(java.lang.String topicName,
                                            K key,
                                            V value,
                                            Headers headers)

Create a ConsumerRecord with the given topic name, key, value, and headers. The timestamp will be generated based on the constructor provided start time and time will auto advance.

Parameters:

topicName - the topic name

key - the record key

value - the record value

headers - the record headers

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(K key,
                                            V value)

Create a ConsumerRecord with default topic name and given key and value. The timestamp will be generated based on the constructor provided start time and time will auto advance.

Parameters:

key - the record key

value - the record value

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(K key,
                                            V value,
                                            Headers headers)

Create a ConsumerRecord with default topic name and given key, value, and headers. The timestamp will be generated based on the constructor provided start time and time will auto advance.

Parameters:

key - the record key

value - the record value

headers - the record headers

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(java.lang.String topicName,
                                            V value,
                                            long timestampMs)

Create a ConsumerRecord with null-key and the given topic name, value, and timestamp. Does not auto advance internally tracked time.

Parameters:

topicName - the topic name

value - the record value

timestampMs - the record timestamp

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(java.lang.String topicName,
                                            V value,
                                            Headers headers,
                                            long timestampMs)

Create a ConsumerRecord with null-key and the given topic name, value, headers, and timestamp. Does not auto advance internally tracked time.

Parameters:

topicName - the topic name

value - the record value

headers - the record headers

timestampMs - the record timestamp

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(V value,
                                            long timestampMs)

Create a ConsumerRecord with default topic name and null-key as well as given value and timestamp. Does not auto advance internally tracked time.

Parameters:

value - the record value

timestampMs - the record timestamp

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(V value,
                                            Headers headers,
                                            long timestampMs)

Create a ConsumerRecord with default topic name and null-key as well as given value, headers, and timestamp. Does not auto advance internally tracked time.

Parameters:

value - the record value

headers - the record headers

timestampMs - the record timestamp

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(java.lang.String topicName,
                                            V value,
                                            Headers headers)

Create a ConsumerRecord with null-key and the given topic name, value, and headers. The timestamp will be generated based on the constructor provided start time and time will auto advance.

Parameters:

topicName - the topic name

value - the record value

headers - the record headers

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(java.lang.String topicName,
                                            V value)

Create a ConsumerRecord with null-key and the given topic name and value. The timestamp will be generated based on the constructor provided start time and time will auto advance.

Parameters:

topicName - the topic name

value - the record value

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(V value)

Create a ConsumerRecord with default topic name and null-key was well as given value. The timestamp will be generated based on the constructor provided start time and time will auto advance.

Parameters:

value - the record value

Returns:

the generated ConsumerRecord

create

public ConsumerRecord<byte[],byte[]> create(V value,
                                            Headers headers)

Create a ConsumerRecord with default topic name and null-key was well as given value and headers. The timestamp will be generated based on the constructor provided start time and time will auto advance.

Parameters:

value - the record value

headers - the record headers

Returns:

the generated ConsumerRecord

create

public java.util.List<ConsumerRecord<byte[],byte[]>> create(java.lang.String topicName,
                                                            java.util.List<KeyValue<K,V>> keyValues)

Creates consumer records with the given topic name, keys, and values. The timestamp will be generated based on the constructor provided start time and time will auto advance.

Parameters:

topicName - the topic name

keyValues - the record keys and values

Returns:

the generated consumer records

create

public java.util.List<ConsumerRecord<byte[],byte[]>> create(java.util.List<KeyValue<K,V>> keyValues)

Creates consumer records with default topic name as well as given keys and values. The timestamp will be generated based on the constructor provided start time and time will auto advance.

Parameters:

keyValues - the record keys and values

Returns:

the generated consumer records

create

public java.util.List<ConsumerRecord<byte[],byte[]>> create(java.lang.String topicName,
                                                            java.util.List<KeyValue<K,V>> keyValues,
                                                            long startTimestamp,
                                                            long advanceMs)

Creates consumer records with the given topic name, keys, and values. Does not auto advance internally tracked time.

Parameters:

topicName - the topic name

keyValues - the record keys and values

startTimestamp - the timestamp for the first generated record

advanceMs - the time difference between two consecutive generated records

Returns:

the generated consumer records

create

public java.util.List<ConsumerRecord<byte[],byte[]>> create(java.util.List<KeyValue<K,V>> keyValues,
                                                            long startTimestamp,
                                                            long advanceMs)

Creates consumer records with default topic name as well as given keys and values. Does not auto advance internally tracked time.

Parameters:

keyValues - the record keys and values

startTimestamp - the timestamp for the first generated record

advanceMs - the time difference between two consecutive generated records

Returns:

the generated consumer records

create

public java.util.List<ConsumerRecord<byte[],byte[]>> create(java.lang.String topicName,
                                                            java.util.List<KeyValue<K,V>> keyValues,
                                                            long startTimestamp)

Creates consumer records with the given topic name, keys and values. For each generated record, the time is advanced by 1. Does not auto advance internally tracked time.

Parameters:

topicName - the topic name

keyValues - the record keys and values

startTimestamp - the timestamp for the first generated record

Returns:

the generated consumer records

create

public java.util.List<ConsumerRecord<byte[],byte[]>> create(java.util.List<KeyValue<K,V>> keyValues,
                                                            long startTimestamp)

Creates consumer records with the given keys and values. For each generated record, the time is advanced by 1. Does not auto advance internally tracked time.

Parameters:

keyValues - the record keys and values

startTimestamp - the timestamp for the first generated record

Returns:

the generated consumer records