io.micronaut.starter.feature.database.jdbc

Class JdbcFeature

java.lang.Object

io.micronaut.starter.feature.database.jdbc.JdbcFeature

All Implemented Interfaces:

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

Direct Known Subclasses:

Dbcp, Hikari, Tomcat, Ucp

public abstract class JdbcFeature
extends java.lang.Object
implements OneOfFeature, DatabaseDriverConfigurationFeature

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
JdbcFeature(DatabaseDriverFeature defaultDbFeature)

Method Summary

Modifier and Type	Method and 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).
java.lang.String	getCategory()
java.lang.String	getDriverKey()
java.lang.Class<?>	getFeatureClass()
java.lang.String	getMicronautDocumentation()
int	getOrder() The order of a feature controls the order in which it applies.
java.lang.String	getPasswordKey()
java.lang.String	getUrlKey()
java.lang.String	getUsernameKey()
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).
boolean	supports(ApplicationType applicationType) This method must be implemented to ensure it is only selectable for the desired application types.

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.Feature

getDescription, getName, getThirdPartyDocumentation, getTitle, isPreview, isVisible

Constructor Detail

JdbcFeature

public JdbcFeature(DatabaseDriverFeature defaultDbFeature)

Method Detail

getOrder

public int getOrder()

Description copied from interface: Feature

The order of a feature controls the order in which it applies. The order of a feature is important to ensure that any previous work done by other features that may be required is done. See FeaturePhase for a list of phases to choose from.

Specified by:

getOrder in interface io.micronaut.core.order.Ordered

Specified by:

getOrder in interface Feature

Returns:

The order of the feature

getFeatureClass

public java.lang.Class<?> getFeatureClass()

Specified by:

getFeatureClass in interface OneOfFeature

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

Parameters:

featureContext - The feature context

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

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

getCategory

public java.lang.String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.

getMicronautDocumentation

public java.lang.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

getUrlKey

public java.lang.String getUrlKey()

Specified by:

getUrlKey in interface DatabaseDriverConfigurationFeature

getDriverKey

public java.lang.String getDriverKey()

Specified by:

getDriverKey in interface DatabaseDriverConfigurationFeature

getUsernameKey

public java.lang.String getUsernameKey()

Specified by:

getUsernameKey in interface DatabaseDriverConfigurationFeature

getPasswordKey

public java.lang.String getPasswordKey()

Specified by:

getPasswordKey in interface DatabaseDriverConfigurationFeature