Spring/spring-kafka
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GH-2916: Docs for EmbedKafkaKraftBrokerkafka ports

Browse Source 
Fixes: https://github.com/spring-projects/spring-kafka/issues/2916

It is not possible to propagate provided kafka ports to KafkaClusterTestKit at the moment.
We are documenting this via javadocs.
This commit is contained in:
Soby Chacko
2023-11-29 15:15:00 -05:00
parent ff0c8539ca
commit 37cbbd2a0c
2 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
spring-kafka-test/src/main/java/org/springframework/kafka/test/EmbeddedKafkaKraftBroker.java
View File

@@ -146,6 +146,9 @@ public class EmbeddedKafkaKraftBroker implements EmbeddedKafkaBroker {
}
/**
* IMPORTANT: It is not possible to configure custom ports when using KRaft based EmbeddedKafka.
* The {@link 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.
* @param ports the ports.

10
spring-kafka-test/src/main/java/org/springframework/kafka/test/context/EmbeddedKafka.java
View File

@@ -97,13 +97,15 @@ public @interface EmbeddedKafka {
* Set explicit ports on which the kafka brokers will listen. Useful when running an
* embedded broker that you want to access from other processes.
* A port must be provided for each instance, which means the number of ports must match the value of the count attribute.
* This property is not valid when using KRaft mode.
* @return ports for brokers.
* @since 2.2.4
*/
int[] ports() default { 0 };
/**
* Set the port on which the embedded Zookeeper should listen;
* Set the port on which the embedded Zookeeper should listen.
* This property is not valid when using KRaft mode.
* @return the port.
* @since 2.3
*/
@@ -165,14 +167,16 @@ public @interface EmbeddedKafka {
/**
* Timeout for internal ZK client connection.
* @return default {@link EmbeddedKafkaBroker#DEFAULT_ZK_CONNECTION_TIMEOUT}.
* This property is not valid when using KRaft mode.
* @return default {@link EmbeddedKafkaZKBroker#DEFAULT_ZK_CONNECTION_TIMEOUT}.
* @since 2.4
*/
int zkConnectionTimeout() default EmbeddedKafkaZKBroker.DEFAULT_ZK_CONNECTION_TIMEOUT;
/**
* Timeout for internal ZK client session.
* @return default {@link EmbeddedKafkaBroker#DEFAULT_ZK_SESSION_TIMEOUT}.
* This property is not valid when using KRaft mode.
* @return default {@link EmbeddedKafkaZKBroker#DEFAULT_ZK_SESSION_TIMEOUT}.
* @since 2.4
*/
int zkSessionTimeout() default EmbeddedKafkaZKBroker.DEFAULT_ZK_SESSION_TIMEOUT;