Package io.micronaut.starter.feature.objectstorage

Interface ObjectStorageFeature

All Superinterfaces:

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

All Known Subinterfaces:

CloudObjectStorageFeature

All Known Implementing Classes:

ObjectStorageAws, ObjectStorageAzure, ObjectStorageGcp, ObjectStorageLocal, ObjectStorageOracleCloud

public interface ObjectStorageFeature
extends Feature

Base class for Object Storage features.

Since:

3.7.0

Author:

Álvaro Sánchez-Mariscal

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREAMBLE

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
default 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	getCloudProvider()
default @NonNull String	getDescription()
default String	getMicronautDocumentation()
default @NonNull String	getName()	The name of the feature.
default String	getTitle()
default boolean	supports(ApplicationType applicationType)	This method must be implemented to ensure it is only selectable for the desired application types.

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

getDescription

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

getCategory, getOrder, getThirdPartyDocumentation, isCommunity, isPreview, isVisible, processSelectedFeatures

Field Details

PREAMBLE

static final String PREAMBLE

See Also:

• Constant Field Values

Method Details

supports

default 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

getMicronautDocumentation

default 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

getName

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

default String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

@NonNull
default @NonNull String getDescription()

Specified by:

getDescription in interface io.micronaut.core.naming.Described

Specified by:

getDescription in interface Feature

apply

default 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

getCloudProvider

@NonNull
@NonNull String getCloudProvider()

Returns:

the concrete cloud provider in its natural name (eg: "Oracle Cloud").