Package io.micronaut.starter.feature.opensearch

Class OpenSearchRestClient

java.lang.Object

io.micronaut.starter.feature.testresources.EaseTestingFeature

io.micronaut.starter.feature.opensearch.OpenSearchFeature

io.micronaut.starter.feature.opensearch.OpenSearchRestClient

All Implemented Interfaces:

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

@Requires(property="micronaut.starter.feature.opensearch.restclient.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class OpenSearchRestClient
extends OpenSearchFeature

Field Summary

Fields

Modifier and Type	Field	Description
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
OpenSearchRestClient(TestContainers testContainers, TestResources testResources, JacksonDatabindFeature jacksonDatabindFeature)

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	getName()	The name of the feature.
String	getTitle()
void	processSelectedFeatures(FeatureContext featureContext)	If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set).

Methods inherited from class io.micronaut.starter.feature.opensearch.OpenSearchFeature

getCategory, getMicronautDocumentation, getTestResourcesAdditionalModules, getTestResourcesDependencies, getThirdPartyDocumentation, supports

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

getOrder, isCommunity, isPreview, isVisible

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

testContainersDependencies

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

OpenSearchRestClient

public OpenSearchRestClient(TestContainers testContainers,
 TestResources testResources,
 JacksonDatabindFeature jacksonDatabindFeature)

Method Details

getName

public String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Returns:

the name of the feature

getTitle

public String getTitle()

Returns:

The title of the 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

Overrides:

apply in class OpenSearchFeature

Parameters:

generatorContext - THe generator context

processSelectedFeatures

public void processSelectedFeatures(FeatureContext featureContext)

Description copied from interface: Feature

If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set). This method can be implemented to allow features to modify the list of features that will apply to the project. The methods FeatureContext.addFeature(Feature) and FeatureContext.exclude(FeaturePredicate) are the primary ways to add and remove features from the context. FeatureContext.isPresent(Class) can be used to determine the existence of other features in order to make decisions.

Specified by:

processSelectedFeatures in interface Feature

Overrides:

processSelectedFeatures in class EaseTestingFeature

Parameters:

featureContext - The feature context

getDescription

public String getDescription()