Class Kafka

java.lang.Object

io.micronaut.starter.feature.testresources.EaseTestingFeature

io.micronaut.starter.feature.messaging.kafka.Kafka

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, DefaultFeature, Feature, OpenRewriteFeature, MessagingFeature, SharedTestResourceFeature, ContributingTestContainerArtifactId, ContributingTestContainerDependency

@Requires(property="micronaut.starter.feature.kafka.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class Kafka
extends EaseTestingFeature
implements DefaultFeature, MessagingFeature, SharedTestResourceFeature, ContributingTestContainerArtifactId, OpenRewriteFeature

Kafka messaging feature.

Adds support for Kafka messaging, including test container integration and shared test resources.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface ContributingTestContainerDependency

TESTCONTAINERS_GROUP_ID

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
Kafka(TestContainers testContainers, TestResources testResources)

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getName()	The name of the feature.
List<String>	getRecipes(GeneratorContext generatorContext)
String	getTitle()
boolean	shouldApply(Options options, Set<Feature> selectedFeatures)	Determines if the feature should be applied to the project.
String	testContainersArtifactId()

Methods inherited from class EaseTestingFeature

processSelectedFeatures

Methods inherited from class Object

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

Methods inherited from interface ContributingTestContainerArtifactId

testContainersDependencies

Methods inherited from interface io.micronaut.core.naming.Described

getDescription

Methods inherited from interface Feature

getOrder, isCommunity, isPreview, isVisible, processSelectedFeatures, supports

Methods inherited from interface MessagingFeature

getCategory

Methods inherited from interface OpenRewriteFeature

apply, getFrameworkDocumentation, getThirdPartyDocumentation, processRecipes

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

Kafka

public Kafka(TestContainers testContainers,
 TestResources testResources)

Method Details

getName

public String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

getName in interface Feature

Specified by:

getName in interface io.micronaut.core.naming.Named

Returns:

the name of the feature

getTitle

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

public String getDescription()

Specified by:

getDescription in interface io.micronaut.core.naming.Described

Specified by:

getDescription in interface Feature

getRecipes

public List<String> getRecipes(GeneratorContext generatorContext)

Specified by:

getRecipes in interface OpenRewriteFeature

shouldApply

public boolean shouldApply(Options options,
 Set<Feature> selectedFeatures)

Description copied from interface: DefaultFeature

Determines if the feature should be applied to the project. Default features do not need to be concerned if the feature was already selected and therefore is already in the list of selected features. The addition to the set is based on the identity of the feature instance and all features are singletons.

Specified by:

shouldApply in interface DefaultFeature

Parameters:

options - The options

selectedFeatures - The features manually selected by the user

Returns:

True if the feature should apply

testContainersArtifactId

public String testContainersArtifactId()

Specified by:

testContainersArtifactId in interface ContributingTestContainerArtifactId