Package io.micronaut.starter.feature.discovery

Class DiscoveryConsul

java.lang.Object

io.micronaut.starter.feature.discovery.DiscoveryConsul

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, OneOfFeature, OpenRewriteFeature, DiscoveryFeature

@Requires(property="micronaut.starter.feature.discovery.consul.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class DiscoveryConsul
extends Object
implements DiscoveryFeature, OpenRewriteFeature

Feature that adds support for service discovery using Consul.

This class registers both the Consul configuration and the DiscoveryClient feature if they are not already present. It integrates the Micronaut Discovery Client with Consul, enabling service registration and discovery within a Consul environment.

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
DiscoveryConsul(Consul consul, DiscoveryClient discoveryClient)

Method Summary

Modifier and Type	Method	Description
String	getDescription()
@NonNull String	getName()	The name of the feature.
List<String>	getRecipes(GeneratorContext generatorContext)
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(io.micronaut.starter.options.Options, java.util.Set).

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.discovery.DiscoveryFeature

getCategory, getFeatureClass, supports

Methods inherited from interface io.micronaut.projectgen.core.feature.Feature

getOrder, isCommunity, isPreview, isVisible

Methods inherited from interface io.micronaut.projectgen.core.openrewrite.OpenRewriteFeature

apply, getFrameworkDocumentation, getThirdPartyDocumentation, processRecipes

Constructor Details

DiscoveryConsul

public DiscoveryConsul(Consul consul,
 DiscoveryClient discoveryClient)

Method Details

getName

@NonNull
public @NonNull 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

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(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

Parameters:

featureContext - The feature context

getRecipes

public List<String> getRecipes(GeneratorContext generatorContext)

Specified by:

getRecipes in interface OpenRewriteFeature