Class DistributedConfigConsul

java.lang.Object

io.micronaut.starter.feature.distributedconfig.DistributedConfigConsul

All Implemented Interfaces:

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

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

A DistributedConfigFeature implementation that enables distributed configuration using Consul.

This feature adds the necessary configuration for integrating Micronaut applications with Consul as a distributed configuration source.

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
DistributedConfigConsul(MicronautDistributedConfigurationFeature micronautDistributedConfigurationFeature, Consul consul)

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

getCategory

Methods inherited from interface Feature

getOrder, isCommunity, isPreview, isVisible, supports

Methods inherited from interface OpenRewriteFeature

apply, getFrameworkDocumentation, getThirdPartyDocumentation, processRecipes

Constructor Details

DistributedConfigConsul

public DistributedConfigConsul(MicronautDistributedConfigurationFeature micronautDistributedConfigurationFeature,
 Consul consul)

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