Package io.micronaut.starter.feature.agorapulse.console

Class Console

java.lang.Object

io.micronaut.starter.feature.agorapulse.console.Console

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, AgoraPulseFeature, CommunityFeature, MicronautCommunityFeature

@Requires(property="micronaut.starter.feature.agorapulse.micronaut.console.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class Console
extends Object
implements AgoraPulseFeature

Micronaut Console community feature provided by Agorapulse. Adds support for executing arbitrary code within Micronaut applications and functions. Configures necessary dependencies, example files, and default security settings.

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
Console()

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(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
String	getCategory()
@NonNull String	getCommunityFeatureName()
@NonNull String	getCommunityFeatureTitle()
String	getDescription()
String	getThirdPartyDocumentation(GeneratorContext generatorContext)
boolean	supports(Options options)	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.agorapulse.AgoraPulseFeature

builtWithMicronautVersion, getCommunityContributor

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

getName, getTitle, isCommunity

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

getDescription

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

getFrameworkDocumentation, getOrder, isPreview, processSelectedFeatures

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

isVisible, supportsCurrentMicronautVersion

Constructor Details

Console

public Console()

Method Details

getCommunityFeatureName

@NonNull
public @NonNull String getCommunityFeatureName()

Specified by:

getCommunityFeatureName in interface CommunityFeature

getCommunityFeatureTitle

@NonNull
public @NonNull String getCommunityFeatureTitle()

Specified by:

getCommunityFeatureTitle in interface CommunityFeature

getDescription

public String getDescription()

Specified by:

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

Specified by:

getDescription in interface Feature

getThirdPartyDocumentation

public String getThirdPartyDocumentation(GeneratorContext generatorContext)

Specified by:

getThirdPartyDocumentation in interface AgoraPulseFeature

Specified by:

getThirdPartyDocumentation in interface Feature

Parameters:

generatorContext - Generator Context

Returns:

Returns a link to third party. E.g. https://hazelcast.org

supports

public boolean supports(Options options)

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:

options - Options

Returns:

True if the feature can be selected by the user

getCategory

public String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.

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

Specified by:

apply in interface Feature

Parameters:

generatorContext - THe generator context