Package io.micronaut.starter.feature.build

Class MicronautBuildPlugin

java.lang.Object

io.micronaut.starter.feature.build.MicronautBuildPlugin

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, BuildPluginFeature, DefaultFeature, Feature

@Requires(property="micronaut.starter.feature.micronaut.build.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class MicronautBuildPlugin
extends Object
implements BuildPluginFeature, DefaultFeature

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AOT_KEY_SECURITY_JWKS
static final String	AOT_KEY_SECURITY_OPENID
protected final CoordinateResolver	coordinateResolver
static final String	GRAALVM_GRADLE_DOCS_URL
static final String	MICRONAUT_GRADLE_DOCS_URL

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
MicronautBuildPlugin(CoordinateResolver coordinateResolver)

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).
@NonNull String	getName()	The name of the feature.
protected @NonNull GradlePlugin	gradlePlugin(@NonNull GeneratorContext generatorContext)
boolean	isVisible()	Some features should not be visible to the user because they are a common parent of other selectable features, or they should always be applied, or any other reason.
protected MicronautApplicationGradlePlugin.Builder	micronautGradleApplicationPluginBuilder(GeneratorContext generatorContext)
protected MicronautApplicationGradlePlugin.Builder	micronautGradleApplicationPluginBuilder(GeneratorContext generatorContext, String id)
protected GradlePlugin.Builder	micronautLibraryGradlePluginBuilder(GeneratorContext generatorContext)
boolean	shouldAddRepositoriesForSnapshots(GradlePlugin.Builder builder)
boolean	shouldApply(ApplicationType applicationType, Options options, Set<Feature> selectedFeatures)	Determines if the feature should be applied to the project.
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.build.BuildPluginFeature

getOrder

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

getTargetFramework

Methods inherited from interface io.micronaut.core.naming.Described

getDescription

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

getCategory, getDescription, getMicronautDocumentation, getThirdPartyDocumentation, getTitle, isCommunity, isPreview, processSelectedFeatures

Field Details

MICRONAUT_GRADLE_DOCS_URL

public static final String MICRONAUT_GRADLE_DOCS_URL

See Also:

• Constant Field Values

GRAALVM_GRADLE_DOCS_URL

public static final String GRAALVM_GRADLE_DOCS_URL

See Also:

• Constant Field Values

AOT_KEY_SECURITY_JWKS

public static final String AOT_KEY_SECURITY_JWKS

See Also:

• Constant Field Values

AOT_KEY_SECURITY_OPENID

public static final String AOT_KEY_SECURITY_OPENID

See Also:

• Constant Field Values

coordinateResolver

protected final CoordinateResolver coordinateResolver

Constructor Details

MicronautBuildPlugin

public MicronautBuildPlugin(CoordinateResolver coordinateResolver)

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

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

gradlePlugin

@NonNull
protected @NonNull GradlePlugin gradlePlugin(@NonNull
 @NonNull GeneratorContext generatorContext)

shouldAddRepositoriesForSnapshots

public boolean shouldAddRepositoriesForSnapshots(GradlePlugin.Builder builder)

micronautGradleApplicationPluginBuilder

protected MicronautApplicationGradlePlugin.Builder micronautGradleApplicationPluginBuilder(GeneratorContext generatorContext,
 String id)

micronautGradleApplicationPluginBuilder

protected MicronautApplicationGradlePlugin.Builder micronautGradleApplicationPluginBuilder(GeneratorContext generatorContext)

micronautLibraryGradlePluginBuilder

protected GradlePlugin.Builder micronautLibraryGradlePluginBuilder(GeneratorContext generatorContext)

isVisible

public boolean isVisible()

Description copied from interface: Feature

Some features should not be visible to the user because they are a common parent of other selectable features, or they should always be applied, or any other reason.

Specified by:

isVisible in interface Feature

Returns:

True if the feature should able to be selected by the user

shouldApply

public boolean shouldApply(ApplicationType applicationType,
 Options options,
 Set<Feature> selectedFeatures)

Description copied from interface: DefaultFeature

Determines if the feature should be applied to the project. Default features do not need to be concerned if the feature was already selected and therefore is already in the list of selected features. The addition to the set is based on the identity of the feature instance and all features are singletons.

Specified by:

shouldApply in interface DefaultFeature

Parameters:

applicationType - The application type

options - The options

selectedFeatures - The features manually selected by the user

Returns:

True if the feature should apply

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