Package io.micronaut.starter.feature.messaging.kafka

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, MessagingFeature, SharedTestResourceFeature, ContributingTestContainerArtifactId, ContributingTestContainerDependency

@Singleton
public class Kafka
extends EaseTestingFeature
implements DefaultFeature, MessagingFeature, SharedTestResourceFeature, ContributingTestContainerArtifactId

Field Summary

Fields

Modifier and Type	Field	Description
static final Dependency	MICRONAUT_KAFKA
static final String	NAME

Fields inherited from interface io.micronaut.starter.feature.testcontainers.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
void	apply(GeneratorContext generatorContext)	If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
String	getDescription()
String	getMicronautDocumentation()
String	getName()	The name of the feature.
String	getTitle()
boolean	shouldApply(ApplicationType applicationType, Options options, Set<Feature> selectedFeatures)	Determines if the feature should be applied to the project.
String	testContainersArtifactId()

Methods inherited from class io.micronaut.starter.feature.testresources.EaseTestingFeature

processSelectedFeatures

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.starter.feature.testcontainers.ContributingTestContainerArtifactId

testContainersDependencies

Methods inherited from interface io.micronaut.starter.feature.DefaultFeature

getTargetFramework

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

getDescription

Methods inherited from interface io.micronaut.starter.feature.Feature

getOrder, getThirdPartyDocumentation, isCommunity, isPreview, isVisible, processSelectedFeatures

Methods inherited from interface io.micronaut.starter.feature.messaging.MessagingFeature

getCategory, supports

Field Details

MICRONAUT_KAFKA

public static final Dependency MICRONAUT_KAFKA

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

apply

public void apply(GeneratorContext generatorContext)

Description copied from interface: Feature

If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature). At this point the feature list is set and cannot change. This method can be implemented to modify the generated project. The feature can add templates by executing GeneratorContext.addTemplate(String, io.micronaut.starter.template.Template), modify configuration by modifying GeneratorContext.getConfiguration() or GeneratorContext.getBootstrapConfiguration(), or modify build properties through GeneratorContext.getBuildProperties().

Specified by:

apply in interface Feature

Parameters:

generatorContext - THe generator context

shouldApply

public boolean shouldApply(ApplicationType applicationType,
 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:

applicationType - The application type

options - The options

selectedFeatures - The features manually selected by the user

Returns:

True if the feature should apply

getMicronautDocumentation

public String getMicronautDocumentation()

Specified by:

getMicronautDocumentation in interface Feature

Returns:

Returns a link to Micronaut documentation about the feature. eg. https://micronaut-projects.github.io/micronaut-cache/latest/guide/index.html#hazelcast

testContainersArtifactId

public String testContainersArtifactId()

Specified by:

testContainersArtifactId in interface ContributingTestContainerArtifactId