org.springframework.kafka.test.rule

Class KafkaEmbedded

java.lang.Object

org.junit.rules.ExternalResource

org.springframework.kafka.test.rule.KafkaEmbedded

All Implemented Interfaces:

org.junit.rules.TestRule, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, KafkaRule

public class KafkaEmbedded
extends org.junit.rules.ExternalResource
implements KafkaRule, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

The KafkaRule implementation for the embedded Kafka Broker and Zookeeper.

Author:

Marius Bogoevici, Artem Bilan, Gary Russell, Kamill Sokol, Elliot Kennedy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BEAN_NAME
static long	METADATA_PROPAGATION_TIMEOUT
static java.lang.String	SPRING_EMBEDDED_KAFKA_BROKERS
static java.lang.String	SPRING_EMBEDDED_ZOOKEEPER_CONNECT

Constructor Summary

Constructors

Constructor and Description
KafkaEmbedded(int count)
KafkaEmbedded(int count, boolean controlledShutdown, int partitions, java.lang.String... topics) Create embedded Kafka brokers listening on random ports.
KafkaEmbedded(int count, boolean controlledShutdown, java.lang.String... topics) Create embedded Kafka brokers.

Method Summary

Modifier and Type	Method and Description
void	after()
void	afterPropertiesSet()
void	before()
void	bounce(BrokerAddress brokerAddress)
void	bounce(int index) Deprecated.
void	bounce(int index, boolean waitForPropagation) Deprecated.
KafkaEmbedded	brokerProperties(java.util.Map<java.lang.String,java.lang.String> brokerProperties) Specify the properties to configure Kafka Broker before start, e.g.
KafkaEmbedded	brokerProperty(java.lang.String property, java.lang.Object value) Specify a broker property.
void	consumeFromAllEmbeddedTopics(org.apache.kafka.clients.consumer.Consumer<?,?> consumer) Subscribe a consumer to all the embedded topics.
void	consumeFromAnEmbeddedTopic(org.apache.kafka.clients.consumer.Consumer<?,?> consumer, java.lang.String topic) Subscribe a consumer to one of the embedded topics.
void	consumeFromEmbeddedTopics(org.apache.kafka.clients.consumer.Consumer<?,?> consumer, java.lang.String... topics) Subscribe a consumer to one or more of the embedded topics.
void	destroy()
BrokerAddress	getBrokerAddress(int i)
BrokerAddress[]	getBrokerAddresses()
java.lang.String	getBrokersAsString()
kafka.server.KafkaServer	getKafkaServer(int id)
java.util.List<kafka.server.KafkaServer>	getKafkaServers()
int	getPartitionsPerTopic()
org.I0Itec.zkclient.ZkClient	getZkClient()
kafka.zk.EmbeddedZookeeper	getZookeeper()
java.lang.String	getZookeeperConnectionString()
boolean	isEmbedded()
void	restart(int index)
void	setKafkaPorts(int... kafkaPorts) Set explicit ports on which the kafka brokers will listen.
void	startZookeeper()
void	waitUntilSynced(java.lang.String topic, int brokerId) Deprecated.

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.junit.rules.TestRule

apply

Field Detail

BEAN_NAME

public static final java.lang.String BEAN_NAME

See Also:

Constant Field Values

SPRING_EMBEDDED_KAFKA_BROKERS

public static final java.lang.String SPRING_EMBEDDED_KAFKA_BROKERS

See Also:

Constant Field Values

SPRING_EMBEDDED_ZOOKEEPER_CONNECT

public static final java.lang.String SPRING_EMBEDDED_ZOOKEEPER_CONNECT

See Also:

Constant Field Values

METADATA_PROPAGATION_TIMEOUT

public static final long METADATA_PROPAGATION_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

KafkaEmbedded

public KafkaEmbedded(int count)

KafkaEmbedded

public KafkaEmbedded(int count,
                     boolean controlledShutdown,
                     java.lang.String... topics)

Create embedded Kafka brokers.

Parameters:

count - the number of brokers.

controlledShutdown - passed into TestUtils.createBrokerConfig.

topics - the topics to create (2 partitions per).

KafkaEmbedded

public KafkaEmbedded(int count,
                     boolean controlledShutdown,
                     int partitions,
                     java.lang.String... topics)

Create embedded Kafka brokers listening on random ports.

Parameters:

count - the number of brokers.

controlledShutdown - passed into TestUtils.createBrokerConfig.

partitions - partitions per topic.

topics - the topics to create.

Method Detail

brokerProperties

public KafkaEmbedded brokerProperties(java.util.Map<java.lang.String,java.lang.String> brokerProperties)

Specify the properties to configure Kafka Broker before start, e.g. auto.create.topics.enable, transaction.state.log.replication.factor etc.

Parameters:

brokerProperties - the properties to use for configuring Kafka Broker(s).

Returns:

this for chaining configuration

See Also:

KafkaConfig

brokerProperty

public KafkaEmbedded brokerProperty(java.lang.String property,
                                    java.lang.Object value)

Specify a broker property.

Parameters:

property - the property name.

value - the value.

Returns:

the KafkaEmbedded.

Since:

2.1.4

setKafkaPorts

public void setKafkaPorts(int... kafkaPorts)

Set explicit ports on which the kafka brokers will listen. Useful when running an embedded broker that you want to access from other processes.

Parameters:

kafkaPorts - the ports.

Since:

1.3

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

before

public void before()
            throws java.lang.Exception

Overrides:

before in class org.junit.rules.ExternalResource

Throws:

java.lang.Exception

destroy

public void destroy()
             throws java.lang.Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

java.lang.Exception

after

public void after()

Overrides:

after in class org.junit.rules.ExternalResource

getKafkaServers

public java.util.List<kafka.server.KafkaServer> getKafkaServers()

Specified by:

getKafkaServers in interface KafkaRule

getKafkaServer

public kafka.server.KafkaServer getKafkaServer(int id)

getZookeeper

public kafka.zk.EmbeddedZookeeper getZookeeper()

getZkClient

public org.I0Itec.zkclient.ZkClient getZkClient()

Specified by:

getZkClient in interface KafkaRule

getZookeeperConnectionString

public java.lang.String getZookeeperConnectionString()

Specified by:

getZookeeperConnectionString in interface KafkaRule

getBrokerAddress

public BrokerAddress getBrokerAddress(int i)

getBrokerAddresses

public BrokerAddress[] getBrokerAddresses()

Specified by:

getBrokerAddresses in interface KafkaRule

getPartitionsPerTopic

public int getPartitionsPerTopic()

Specified by:

getPartitionsPerTopic in interface KafkaRule

bounce

public void bounce(BrokerAddress brokerAddress)

startZookeeper

public void startZookeeper()

bounce

@Deprecated
public void bounce(int index,
                               boolean waitForPropagation)

Deprecated.

bounce

@Deprecated
public void bounce(int index)

Deprecated.

restart

public void restart(int index)
             throws java.lang.Exception

Throws:

java.lang.Exception

waitUntilSynced

@Deprecated
public void waitUntilSynced(java.lang.String topic,
                                        int brokerId)

Deprecated.

getBrokersAsString

public java.lang.String getBrokersAsString()

Specified by:

getBrokersAsString in interface KafkaRule

isEmbedded

public boolean isEmbedded()

Specified by:

isEmbedded in interface KafkaRule

consumeFromAllEmbeddedTopics

public void consumeFromAllEmbeddedTopics(org.apache.kafka.clients.consumer.Consumer<?,?> consumer)
                                  throws java.lang.Exception

Subscribe a consumer to all the embedded topics.

Parameters:

consumer - the consumer.

Throws:

java.lang.Exception - an exception.

consumeFromAnEmbeddedTopic

public void consumeFromAnEmbeddedTopic(org.apache.kafka.clients.consumer.Consumer<?,?> consumer,
                                       java.lang.String topic)
                                throws java.lang.Exception

Subscribe a consumer to one of the embedded topics.

Parameters:

consumer - the consumer.

topic - the topic.

Throws:

java.lang.Exception - an exception.

consumeFromEmbeddedTopics

public void consumeFromEmbeddedTopics(org.apache.kafka.clients.consumer.Consumer<?,?> consumer,
                                      java.lang.String... topics)
                               throws java.lang.Exception

Subscribe a consumer to one or more of the embedded topics.

Parameters:

consumer - the consumer.

topics - the topics.

Throws:

java.lang.Exception - an exception.