org.springframework.kafka.test.context

Annotation Type EmbeddedKafka

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
public @interface EmbeddedKafka

Annotation that can be specified on a test class that runs Spring Kafka based tests. Provides the following features over and above the regular Spring TestContext Framework:

• Registers a KafkaEmbedded bean with the KafkaEmbedded.BEAN_NAME bean name.

The typical usage of this annotation is like:

 @RunWith(SpringRunner.class)
 @EmbeddedKafka
 public class MyKafkaTests {

    @Autowired
    private KafkaEmbedded kafkaEmbedded;

    @Value("${spring.embedded.kafka.brokers}")
    private String brokerAddresses;
 }
 

Since:

1.3

Author:

Artem Bilan

See Also:

KafkaEmbedded

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	brokerProperties Properties in form key=value that should be added to the broker config before runs.
boolean	controlledShutdown
int	count
int	partitions
java.lang.String[]	topics
int	value

Element Detail

value

@AliasFor(value="count")
public abstract int value

Returns:

the number of brokers

Default:

1

count

@AliasFor(value="value")
public abstract int count

Returns:

the number of brokers

Default:

1

controlledShutdown

public abstract boolean controlledShutdown

Returns:

passed into kafka.utils.TestUtils.createBrokerConfig().

Default:

false

partitions

public abstract int partitions

Returns:

partitions per topic

Default:

2

topics

public abstract java.lang.String[] topics

Returns:

the topics to create

Default:

{}

brokerProperties

public abstract java.lang.String[] brokerProperties

Properties in form key=value that should be added to the broker config before runs.

Returns:

the properties to add

See Also:

KafkaEmbedded.brokerProperties(Map)

Default:

{}