Package io.micronaut.starter.feature.opensearch

Class OpenSearchFeature

java.lang.Object

io.micronaut.starter.feature.testresources.EaseTestingFeature

io.micronaut.starter.feature.opensearch.OpenSearchFeature

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, OpenSearchContributingTestContainerDependency, ContributingTestContainerDependency, TestResourcesAdditionalModulesProvider

Direct Known Subclasses:

OpenSearchAmazon, OpenSearchHttpClient5, OpenSearchRestClient

public abstract class OpenSearchFeature
extends EaseTestingFeature
implements OpenSearchContributingTestContainerDependency, TestResourcesAdditionalModulesProvider

Field Summary

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

Modifier	Constructor	Description
protected	OpenSearchFeature(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	getCategory()
String	getMicronautDocumentation()
List<String>	getTestResourcesAdditionalModules(GeneratorContext generatorContext)
List<MavenCoordinate>	getTestResourcesDependencies(GeneratorContext generatorContext)
String	getThirdPartyDocumentation()
boolean	supports(ApplicationType applicationType)	This method must be implemented to ensure it is only selectable for the desired application types.

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.core.naming.Described

getDescription

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

getDescription, getName, getOrder, getTitle, isCommunity, isPreview, isVisible

Methods inherited from interface io.micronaut.starter.feature.opensearch.OpenSearchContributingTestContainerDependency

testContainersDependencies

Constructor Details

OpenSearchFeature

protected OpenSearchFeature(TestContainers testContainers,
 TestResources testResources)

Method Details

supports

public boolean supports(ApplicationType applicationType)

Description copied from interface: Feature

This method must be implemented to ensure it is only selectable for the desired application types. This method is not used for determining if a default feature should be applied.

Specified by:

supports in interface Feature

Parameters:

applicationType - The application type

Returns:

True if the feature can be selected by the user

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

getThirdPartyDocumentation

public String getThirdPartyDocumentation()

Specified by:

getThirdPartyDocumentation in interface Feature

Returns:

Returns a link to third party. E.g. https://hazelcast.org

getCategory

public String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.

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

getTestResourcesAdditionalModules

public List<String> getTestResourcesAdditionalModules(GeneratorContext generatorContext)

Specified by:

getTestResourcesAdditionalModules in interface TestResourcesAdditionalModulesProvider

getTestResourcesDependencies

public List<MavenCoordinate> getTestResourcesDependencies(GeneratorContext generatorContext)

Specified by:

getTestResourcesDependencies in interface TestResourcesAdditionalModulesProvider