io.quarkus.test.services.KafkaContainer Maven / Gradle / Ivy

Go to download
package io.quarkus.test.services;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import io.quarkus.test.bootstrap.ManagedResourceBuilder;
import io.quarkus.test.services.containers.KafkaContainerManagedResourceBuilder;
import io.quarkus.test.services.containers.model.KafkaProtocol;
import io.quarkus.test.services.containers.model.KafkaVendor;

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface KafkaContainer {

    KafkaVendor vendor() default KafkaVendor.STRIMZI;

    String image() default "";

    String version() default "";

    boolean withRegistry() default false;

    String registryImage() default "";

    String registryPath() default "";

    KafkaProtocol protocol() default KafkaProtocol.PLAIN_TEXT;

    String kafkaConfigPath() default "/opt/kafka/config/";

    // Kafka properties to add in `kafkaConfigPath()` as `server.properties`
    String serverProperties() default "";

    // Kafka config resources to put on `kafkaConfigPath()` file path
    String[] kafkaConfigResources() default {};

    Class builder() default KafkaContainerManagedResourceBuilder.class;

    /**
     * @return name of the TLS configuration in the TLS Registry extension; Kafka only supports named TLS configs here
     */
    String tlsConfigName() default "";

    /**
     * @return whether Quarkus configuration properties prepared for SSL and SASL_SSL should use Quarkus TLS registry.
     */
    boolean tlsRegistryEnabled() default false;
}