Package org.springframework.kafka.test

Class EmbeddedKafkaKraftBroker

java.lang.Object
org.springframework.kafka.test.EmbeddedKafkaKraftBroker
All Implemented Interfaces:
DisposableBean, InitializingBean, EmbeddedKafkaBroker
public class EmbeddedKafkaKraftBroker extends Object implements EmbeddedKafkaBroker
An embedded Kafka Broker(s) using KRaft. This class is intended to be used in the unit tests.
Since:
3.1
Author:
Marius Bogoevici, Artem Bilan, Gary Russell, Kamill Sokol, Elliot Kennedy, Nakul Mishra, Pawel Lozinski, Adrian Chlebosz, Soby Chacko, Sanghyeok An

  • Field Details

  • Constructor Details

    • EmbeddedKafkaKraftBroker

      public EmbeddedKafkaKraftBroker(int count, int partitions, String... topics)
      Create embedded Kafka brokers listening on random ports.
      Parameters:
      count - the number of brokers.
      partitions - partitions per topic.
      topics - the topics to create.

  • Method Details

    • brokerProperties

      public EmbeddedKafkaBroker brokerProperties(Map<String,String> properties)
      Specify the properties to configure Kafka Broker before start, e.g. auto.create.topics.enable, transaction.state.log.replication.factor etc.
      Specified by:
      brokerProperties in interface EmbeddedKafkaBroker
      Parameters:
      properties - the properties to use for configuring Kafka Broker(s).
      Returns:
      this for chaining configuration.
      See Also:
      • KafkaConfig

    • brokerProperty

      public EmbeddedKafkaBroker brokerProperty(String property, Object value)
      Specify a broker property.
      Parameters:
      property - the property name.
      value - the value.
      Returns:
      the EmbeddedKafkaKraftBroker.

    • kafkaPorts

      public EmbeddedKafkaKraftBroker kafkaPorts(int... ports)
      IMPORTANT: It is not possible to configure custom ports when using KRaft based EmbeddedKafka. The KafkaClusterTestKit does not support setting custom ports at the moment. Therefore, this property is out of use. Set explicit ports on which the kafka brokers will listen. Useful when running an embedded broker that you want to access from other processes.
      Specified by:
      kafkaPorts in interface EmbeddedKafkaBroker
      Parameters:
      ports - the ports.
      Returns:
      the EmbeddedKafkaKraftBroker.

    • brokerListProperty

      public EmbeddedKafkaBroker brokerListProperty(String brokerListProperty)
      Set the system property with this name to the list of broker addresses.
      Specified by:
      brokerListProperty in interface EmbeddedKafkaBroker
      Parameters:
      brokerListProperty - the brokerListProperty to set
      Returns:
      this broker.
      Since:
      2.3

    • adminTimeout

      public EmbeddedKafkaBroker adminTimeout(int adminTimeout)
      Set the timeout in seconds for admin operations (e.g. topic creation, close).
      Parameters:
      adminTimeout - the timeout.
      Returns:
      the EmbeddedKafkaKraftBroker
      Since:
      2.8.5

    • setAdminTimeout

      public void setAdminTimeout(int adminTimeout)
      Set the timeout in seconds for admin operations (e.g. topic creation, close). Default 10 seconds.
      Parameters:
      adminTimeout - the timeout.
      Since:
      2.2

    • afterPropertiesSet

      public void afterPropertiesSet()
      Specified by:
      afterPropertiesSet in interface EmbeddedKafkaBroker
      Specified by:
      afterPropertiesSet in interface InitializingBean

    • destroy

      public void destroy()
      Specified by:
      destroy in interface DisposableBean
      Specified by:
      destroy in interface EmbeddedKafkaBroker

    • addTopics

      public void addTopics(String... topicsToAdd)
      Add topics to the existing broker(s) using the configured number of partitions. The broker(s) must be running.
      Specified by:
      addTopics in interface EmbeddedKafkaBroker
      Parameters:
      topicsToAdd - the topics.

    • addTopics

      public void addTopics(org.apache.kafka.clients.admin.NewTopic... topicsToAdd)
      Add topics to the existing broker(s). The broker(s) must be running.
      Specified by:
      addTopics in interface EmbeddedKafkaBroker
      Parameters:
      topicsToAdd - the topics.
      Since:
      2.2

    • addTopicsWithResults

      public Map<String,Exception> addTopicsWithResults(String... topicsToAdd)
      Add topics to the existing broker(s) using the configured number of partitions. The broker(s) must be running.
      Specified by:
      addTopicsWithResults in interface EmbeddedKafkaBroker
      Parameters:
      topicsToAdd - the topics.
      Returns:
      the results; null values indicate success.
      Since:
      2.5.4

    • addTopicsWithResults

      public Map<String,Exception> addTopicsWithResults(org.apache.kafka.clients.admin.NewTopic... topicsToAdd)
      Add topics to the existing broker(s) and returning a map of results. The broker(s) must be running.
      Specified by:
      addTopicsWithResults in interface EmbeddedKafkaBroker
      Parameters:
      topicsToAdd - the topics.
      Returns:
      the results; null values indicate success.
      Since:
      2.5.4

    • doWithAdmin

      public void doWithAdmin(Consumer<org.apache.kafka.clients.admin.AdminClient> callback)
      Create an AdminClient; invoke the callback and reliably close the admin.
      Parameters:
      callback - the callback.

    • doWithAdminFunction

      public <T> T doWithAdminFunction(Function<org.apache.kafka.clients.admin.AdminClient,T> callback)
      Create an AdminClient; invoke the callback and reliably close the admin.
      Type Parameters:
      T - the function return type.
      Parameters:
      callback - the callback.
      Returns:
      a map of results.
      Since:
      2.5.4

    • getTopics

      public Set<String> getTopics()
      Description copied from interface: EmbeddedKafkaBroker
      Get the topics.
      Specified by:
      getTopics in interface EmbeddedKafkaBroker
      Returns:
      the topics.

    • getPartitionsPerTopic

      public int getPartitionsPerTopic()
      Description copied from interface: EmbeddedKafkaBroker
      Get the configured number of partitions per topic.
      Specified by:
      getPartitionsPerTopic in interface EmbeddedKafkaBroker
      Returns:
      the partition count.

    • getBrokersAsString

      public String getBrokersAsString()
      Description copied from interface: EmbeddedKafkaBroker
      Get the bootstrap server addresses as a String.
      Specified by:
      getBrokersAsString in interface EmbeddedKafkaBroker
      Returns:
      the bootstrap servers.

    • getCluster

      public kafka.testkit.KafkaClusterTestKit getCluster()

    • consumeFromAllEmbeddedTopics

      public void consumeFromAllEmbeddedTopics(org.apache.kafka.clients.consumer.Consumer<?,?> consumer)
      Subscribe a consumer to all the embedded topics.
      Specified by:
      consumeFromAllEmbeddedTopics in interface EmbeddedKafkaBroker
      Parameters:
      consumer - the consumer.

    • consumeFromAllEmbeddedTopics

      public void consumeFromAllEmbeddedTopics(org.apache.kafka.clients.consumer.Consumer<?,?> consumer, boolean seekToEnd)
      Subscribe a consumer to all the embedded topics.
      Specified by:
      consumeFromAllEmbeddedTopics in interface EmbeddedKafkaBroker
      Parameters:
      seekToEnd - true to seek to the end instead of the beginning.
      consumer - the consumer.
      Since:
      2.8.2

    • consumeFromAnEmbeddedTopic

      public void consumeFromAnEmbeddedTopic(org.apache.kafka.clients.consumer.Consumer<?,?> consumer, String topic)
      Subscribe a consumer to one of the embedded topics.
      Specified by:
      consumeFromAnEmbeddedTopic in interface EmbeddedKafkaBroker
      Parameters:
      consumer - the consumer.
      topic - the topic.

    • consumeFromAnEmbeddedTopic

      public void consumeFromAnEmbeddedTopic(org.apache.kafka.clients.consumer.Consumer<?,?> consumer, boolean seekToEnd, String topic)
      Subscribe a consumer to one of the embedded topics.
      Specified by:
      consumeFromAnEmbeddedTopic in interface EmbeddedKafkaBroker
      Parameters:
      consumer - the consumer.
      seekToEnd - true to seek to the end instead of the beginning.
      topic - the topic.
      Since:
      2.8.2

    • consumeFromEmbeddedTopics

      public void consumeFromEmbeddedTopics(org.apache.kafka.clients.consumer.Consumer<?,?> consumer, String... topicsToConsume)
      Subscribe a consumer to one or more of the embedded topics.
      Specified by:
      consumeFromEmbeddedTopics in interface EmbeddedKafkaBroker
      Parameters:
      consumer - the consumer.
      topicsToConsume - the topics.
      Throws:
      IllegalStateException - if you attempt to consume from a topic that is not in the list of embedded topics (since 2.3.4).

    • consumeFromEmbeddedTopics

      public void consumeFromEmbeddedTopics(org.apache.kafka.clients.consumer.Consumer<?,?> consumer, boolean seekToEnd, String... topicsToConsume)
      Subscribe a consumer to one or more of the embedded topics.
      Specified by:
      consumeFromEmbeddedTopics in interface EmbeddedKafkaBroker
      Parameters:
      consumer - the consumer.
      topicsToConsume - the topics.
      seekToEnd - true to seek to the end instead of the beginning.
      Throws:
      IllegalStateException - if you attempt to consume from a topic that is not in the list of embedded topics.
      Since:
      2.8.2