Package io.smallrye.reactive.messaging.kafka.companion.test

Class EmbeddedKafkaBroker

java.lang.Object

io.smallrye.reactive.messaging.kafka.companion.test.EmbeddedKafkaBroker

All Implemented Interfaces:

Closeable, AutoCloseable

public class EmbeddedKafkaBroker
extends Object
implements Closeable

Embedded KRaft Broker, by default listens on localhost with random broker and controller ports.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmbeddedKafkaBroker.LoggingOutputStream

Constructor Summary

Constructors

Constructor	Description
EmbeddedKafkaBroker()

Method Summary

Modifier and Type	Method	Description
void	close()
static Properties	createDefaultBrokerConfig(int nodeId, org.apache.kafka.common.Endpoint controller, org.apache.kafka.common.Endpoint internalEndpoint, List<org.apache.kafka.common.Endpoint> advertisedListeners)
static kafka.server.KafkaRaftServer	createServer(kafka.server.KafkaConfig config)
static org.apache.kafka.common.Endpoint	endpoint(String listener, org.apache.kafka.common.security.auth.SecurityProtocol protocol, int port)
static org.apache.kafka.common.Endpoint	endpoint(String listener, org.apache.kafka.common.security.auth.SecurityProtocol protocol, String host, int port)
static org.apache.kafka.common.Endpoint	endpoint(org.apache.kafka.common.security.auth.SecurityProtocol protocol, int port)
static org.apache.kafka.common.Endpoint	endpoint(org.apache.kafka.common.security.auth.SecurityProtocol protocol, String host, int port)
static void	formatStorage(List<String> directories, String clusterId, int nodeId, boolean ignoreFormatted)
static kafka.server.KafkaConfig	formatStorageFromConfig(Properties properties, String clusterId, boolean ignoreFormatted)
String	getAdvertisedListeners()
String	getClusterId()
kafka.server.KafkaConfig	getKafkaConfig()
List<String>	getLogDirs()
int	getNodeId()
boolean	isRunning()
static org.apache.kafka.common.Endpoint	parseEndpoint(String listenerStr)
static org.apache.kafka.common.Endpoint	parseEndpoint(org.apache.kafka.common.security.auth.SecurityProtocol protocol, String listenerStr)
EmbeddedKafkaBroker	start()	Create and start the broker.
static String	toListenerString(org.apache.kafka.common.Endpoint endpoint)
EmbeddedKafkaBroker	withAdditionalProperties(Consumer<Properties> function)	Configure properties for the broker.
EmbeddedKafkaBroker	withAdvertisedListeners(String advertisedListeners)	Configure custom listeners for the broker.
EmbeddedKafkaBroker	withAdvertisedListeners(org.apache.kafka.common.Endpoint... endpoints)	Configure custom listeners for the broker.
EmbeddedKafkaBroker	withClusterId(String clusterId)	Configure the cluster id for the broker storage dirs.
EmbeddedKafkaBroker	withControllerPort(int port)	Configure the controller port for the broker.
EmbeddedKafkaBroker	withDeleteLogDirsOnClose(boolean deleteDirsOnClose)	Configure whether log directories will be deleted on broker shutdown.
EmbeddedKafkaBroker	withKafkaHost(String host)	Configure the hostname on which the broker will listen.
EmbeddedKafkaBroker	withKafkaPort(int port)	Configure the port on which the broker will listen.
EmbeddedKafkaBroker	withNodeId(int nodeId)	Configure node id for the broker.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedKafkaBroker

public EmbeddedKafkaBroker()

Method Detail

withNodeId

public EmbeddedKafkaBroker withNodeId(int nodeId)

Configure node id for the broker.

Parameters:

nodeId - the node id.

Returns:

this EmbeddedKafkaBroker

withAdditionalProperties

public EmbeddedKafkaBroker withAdditionalProperties(Consumer<Properties> function)

Configure properties for the broker.

Parameters:

function - the config modifier function.

Returns:

this EmbeddedKafkaBroker

withKafkaPort

public EmbeddedKafkaBroker withKafkaPort(int port)

Configure the port on which the broker will listen.

Parameters:

port - the port.

Returns:

this EmbeddedKafkaBroker

withControllerPort

public EmbeddedKafkaBroker withControllerPort(int port)

Configure the controller port for the broker.

Parameters:

port - the port.

Returns:

this EmbeddedKafkaBroker

withKafkaHost

public EmbeddedKafkaBroker withKafkaHost(String host)

Configure the hostname on which the broker will listen.

Parameters:

host - the host.

Returns:

this EmbeddedKafkaBroker

withClusterId

public EmbeddedKafkaBroker withClusterId(String clusterId)

Configure the cluster id for the broker storage dirs.

Parameters:

clusterId - the cluster id.

Returns:

this EmbeddedKafkaBroker

withDeleteLogDirsOnClose

public EmbeddedKafkaBroker withDeleteLogDirsOnClose(boolean deleteDirsOnClose)

Configure whether log directories will be deleted on broker shutdown.

Parameters:

deleteDirsOnClose - true

Returns:

this EmbeddedKafkaBroker

withAdvertisedListeners

public EmbeddedKafkaBroker withAdvertisedListeners(org.apache.kafka.common.Endpoint... endpoints)

Configure custom listeners for the broker.

Note that this will override the default PLAINTEXT listener. A CONTROLLER listener will be added automatically.

Returns:

this EmbeddedKafkaBroker

withAdvertisedListeners

public EmbeddedKafkaBroker withAdvertisedListeners(String advertisedListeners)

Configure custom listeners for the broker.

Note that this will override the default PLAINTEXT listener. A CONTROLLER listener will be added automatically.

Returns:

this EmbeddedKafkaBroker

start

public EmbeddedKafkaBroker start()

Create and start the broker.

Returns:

this EmbeddedKafkaBroker

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

isRunning

public boolean isRunning()

getKafkaConfig

public kafka.server.KafkaConfig getKafkaConfig()

getAdvertisedListeners

public String getAdvertisedListeners()

getLogDirs

public List<String> getLogDirs()

getNodeId

public int getNodeId()

getClusterId

public String getClusterId()

endpoint

public static org.apache.kafka.common.Endpoint endpoint(org.apache.kafka.common.security.auth.SecurityProtocol protocol,
                                                        int port)

endpoint

public static org.apache.kafka.common.Endpoint endpoint(org.apache.kafka.common.security.auth.SecurityProtocol protocol,
                                                        String host,
                                                        int port)

endpoint

public static org.apache.kafka.common.Endpoint endpoint(String listener,
                                                        org.apache.kafka.common.security.auth.SecurityProtocol protocol,
                                                        int port)

endpoint

public static org.apache.kafka.common.Endpoint endpoint(String listener,
                                                        org.apache.kafka.common.security.auth.SecurityProtocol protocol,
                                                        String host,
                                                        int port)

parseEndpoint

public static org.apache.kafka.common.Endpoint parseEndpoint(org.apache.kafka.common.security.auth.SecurityProtocol protocol,
                                                             String listenerStr)

parseEndpoint

public static org.apache.kafka.common.Endpoint parseEndpoint(String listenerStr)

createDefaultBrokerConfig

public static Properties createDefaultBrokerConfig(int nodeId,
                                                   org.apache.kafka.common.Endpoint controller,
                                                   org.apache.kafka.common.Endpoint internalEndpoint,
                                                   List<org.apache.kafka.common.Endpoint> advertisedListeners)

formatStorageFromConfig

public static kafka.server.KafkaConfig formatStorageFromConfig(Properties properties,
                                                               String clusterId,
                                                               boolean ignoreFormatted)

formatStorage

public static void formatStorage(List<String> directories,
                                 String clusterId,
                                 int nodeId,
                                 boolean ignoreFormatted)

createServer

public static kafka.server.KafkaRaftServer createServer(kafka.server.KafkaConfig config)

toListenerString

public static String toListenerString(org.apache.kafka.common.Endpoint endpoint)