Package com.salesforce.kafka.test

Class KafkaTestServer

java.lang.Object

com.salesforce.kafka.test.KafkaTestServer

All Implemented Interfaces:

KafkaCluster, KafkaProvider, AutoCloseable

public class KafkaTestServer
extends Object
implements KafkaCluster, KafkaProvider, AutoCloseable

This will spin up a ZooKeeper and Kafka server for use in integration tests. Simply create an instance of KafkaTestServer and call start() and you can publish to Kafka topics in an integration test. Be sure to call shutdown() when the test is complete or use the AutoCloseable interface.

Constructor Summary

Constructors

Constructor	Description
KafkaTestServer()	Default constructor, no overridden broker properties.
KafkaTestServer(Properties overrideBrokerProperties)	Alternative constructor allowing override of brokerProperties.
KafkaTestServer(Properties overrideBrokerProperties, Collection<BrokerListener> listeners)	Alternative constructor allowing override of brokerProperties.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the internal servers.
int	getBrokerId()	Returns the brokers Id.
KafkaBrokers	getKafkaBrokers()	Returns an immutable list of broker hosts for the kafka cluster.
String	getKafkaConnectString()	bootstrap.servers string to configure Kafka consumers or producers to access the Kafka cluster.
List<ListenerProperties>	getListenerProperties()	Connection details about each of the registered listeners on the kafka broker.
String	getZookeeperConnectString()	Returns properly formatted zookeeper connection string for zookeeper clients.
void	start()	Creates and starts ZooKeeper and Kafka server instances.
void	stop()	Closes the internal servers.

Methods inherited from class java.lang.Object

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

Constructor Details

KafkaTestServer

public KafkaTestServer()

Default constructor, no overridden broker properties.

KafkaTestServer

public KafkaTestServer(Properties overrideBrokerProperties) throws IllegalArgumentException

Alternative constructor allowing override of brokerProperties.

Parameters:

overrideBrokerProperties - Define Kafka broker properties.

Throws:

IllegalArgumentException - if overrideBrokerProperties argument is null.

KafkaTestServer

public KafkaTestServer(Properties overrideBrokerProperties, Collection<BrokerListener> listeners) throws IllegalArgumentException

Alternative constructor allowing override of brokerProperties.

Parameters:

overrideBrokerProperties - Define Kafka broker properties.

listeners - Listener definitions.

Throws:

IllegalArgumentException - if overrideBrokerProperties argument is null.

Method Details

getKafkaConnectString

public String getKafkaConnectString()

bootstrap.servers string to configure Kafka consumers or producers to access the Kafka cluster.

Specified by:

getKafkaConnectString in interface KafkaProvider

Returns:

Connect string to use for Kafka clients.

getListenerProperties

public List<ListenerProperties> getListenerProperties()

Description copied from interface: KafkaProvider

Connection details about each of the registered listeners on the kafka broker.

Specified by:

getListenerProperties in interface KafkaProvider

Returns:

details about each of the registered listeners on the kafka broker.

getKafkaBrokers

public KafkaBrokers getKafkaBrokers()

Returns an immutable list of broker hosts for the kafka cluster.

Specified by:

getKafkaBrokers in interface KafkaProvider

Returns:

immutable list of hosts for brokers within the cluster.

getBrokerId

public int getBrokerId()

Returns the brokers Id.

Returns:

This brokers Id.

getZookeeperConnectString

public String getZookeeperConnectString()

Returns properly formatted zookeeper connection string for zookeeper clients.

Specified by:

getZookeeperConnectString in interface KafkaProvider

Returns:

Connect string to use for Zookeeper clients.

start

public void start() throws Exception

Creates and starts ZooKeeper and Kafka server instances.

Specified by:

start in interface KafkaCluster

Throws:

Exception - on startup errors.

stop

public void stop() throws Exception

Closes the internal servers. Failing to call this at the end of your tests will likely result in leaking instances. Provided alongside close() to stay consistent with start().

Throws:

Exception - on shutdown errors.

close

public void close() throws Exception

Closes the internal servers. Failing to call this at the end of your tests will likely result in leaking instances.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface KafkaCluster

Throws:

Exception - on shutdown errors.