org.apache.flink.tests.util.kafka

Interface KafkaResource

All Superinterfaces:

ExternalResource, org.junit.rules.TestRule

All Known Implementing Classes:

LocalStandaloneKafkaResource

public interface KafkaResource
extends ExternalResource

Generic interface for interacting with Kafka.

Method Summary

Modifier and Type	Method and Description
void	createTopic(int replicationFactor, int numPartitions, String topic) Creates a topic with the given name, replication factor and number of partitions.
static KafkaResource	get(String version) Returns the configured KafkaResource implementation, or a LocalStandaloneKafkaResource if none is configured.
Collection<InetSocketAddress>	getBootstrapServerAddresses() Returns the kafka bootstrap server addresses.
int	getNumPartitions(String topic) Returns the current number of partitions for the given topic.
long	getPartitionOffset(String topic, int partition) Returns the current partition offset for the given partition of the given topic.
InetSocketAddress	getZookeeperAddress() Returns the address of Zookeeper.
List<String>	readMessage(int maxNumMessages, String groupId, String topic) Reads up to maxNumMessages from the given topic.
void	sendMessages(String topic, String... messages) Sends the given messages to the given topic.
void	setNumPartitions(int numPartitions, String topic) Modifies the number of partitions for the given topic.

Methods inherited from interface org.apache.flink.util.ExternalResource

afterTestFailure, afterTestSuccess, apply, before

Method Detail

createTopic

void createTopic(int replicationFactor,
                 int numPartitions,
                 String topic)
          throws IOException

Creates a topic with the given name, replication factor and number of partitions.

Parameters:

replicationFactor - replication factor

numPartitions - number of partitions

topic - desired topic name

Throws:

IOException

sendMessages

void sendMessages(String topic,
                  String... messages)
           throws IOException

Sends the given messages to the given topic.

Parameters:

topic - topic name

messages - messages to send

Throws:

IOException

getBootstrapServerAddresses

Collection<InetSocketAddress> getBootstrapServerAddresses()

Returns the kafka bootstrap server addresses.

Returns:

kafka bootstrap server addresses

getZookeeperAddress

InetSocketAddress getZookeeperAddress()

Returns the address of Zookeeper.

Returns:

zookeeper address

readMessage

List<String> readMessage(int maxNumMessages,
                         String groupId,
                         String topic)
                  throws IOException

Reads up to maxNumMessages from the given topic.

Parameters:

maxNumMessages - maximum number of messages that should be read

groupId - group id to identify consumer

topic - topic name

Returns:

read messages

Throws:

IOException

setNumPartitions

void setNumPartitions(int numPartitions,
                      String topic)
               throws IOException

Modifies the number of partitions for the given topic.

Parameters:

numPartitions - desired number of partitions

topic - topic to modify

Throws:

IOException

getNumPartitions

int getNumPartitions(String topic)
              throws IOException

Returns the current number of partitions for the given topic.

Parameters:

topic - topic name

Returns:

number of partitions for the given topic

Throws:

IOException

getPartitionOffset

long getPartitionOffset(String topic,
                        int partition)
                 throws IOException

Returns the current partition offset for the given partition of the given topic.

Parameters:

topic - topic name

partition - topic partition

Returns:

partition offset for the given partition

Throws:

IOException

get

static KafkaResource get(String version)

Returns the configured KafkaResource implementation, or a LocalStandaloneKafkaResource if none is configured.

Returns:

configured KafkaResource, or LocalStandaloneKafkaResource is none is configured