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, AgoraPulseFeature, CommunityFeature, Feature, MicronautCommunityFeature

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

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ARTIFACT_ID
protected static final String	SSRF_HEADER_NAME

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
protected void	addConfiguration(GeneratorContext generatorContext, String secret)
protected void	addDependency(GeneratorContext generatorContext)
protected void	addDslFile(GeneratorContext generatorContext)
protected void	addExampleCode(GeneratorContext generatorContext, String secret)
protected void	addGroovyDependency(GeneratorContext generatorContext)
protected void	addHttpFile(GeneratorContext generatorContext, String secret)
protected void	addKotlinScriptingDependency(GeneratorContext generatorContext)
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).
protected @NonNull Optional<com.fizzed.rocker.RockerModel>	dslFile(GeneratorContext generatorContext)
String	getCategory()
@NonNull String	getCommunityFeatureName()
@NonNull String	getCommunityFeatureTitle()
String	getDescription()
String	getThirdPartyDocumentation()
protected @NonNull Optional<com.fizzed.rocker.RockerModel>	httpFile(GeneratorContext generatorContext, String secret)
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.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.starter.feature.Feature

getMicronautDocumentation, getOrder, isPreview, processSelectedFeatures

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

isVisible, supportsCurrentMicronautVersion

Field Details

ARTIFACT_ID

protected static final String ARTIFACT_ID

See Also:

• Constant Field Values

SSRF_HEADER_NAME

protected static final String SSRF_HEADER_NAME

See Also:

• Constant Field Values

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

Specified by:

getThirdPartyDocumentation in interface AgoraPulseFeature

Specified by:

getThirdPartyDocumentation in interface Feature

Returns:

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

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

addDependency

protected void addDependency(GeneratorContext generatorContext)

addGroovyDependency

protected void addGroovyDependency(GeneratorContext generatorContext)

addKotlinScriptingDependency

protected void addKotlinScriptingDependency(GeneratorContext generatorContext)

addExampleCode

protected void addExampleCode(GeneratorContext generatorContext,
 String secret)

addDslFile

protected void addDslFile(GeneratorContext generatorContext)

addHttpFile

protected void addHttpFile(GeneratorContext generatorContext,
 String secret)

dslFile

@NonNull
protected @NonNull Optional<com.fizzed.rocker.RockerModel> dslFile(GeneratorContext generatorContext)

httpFile

@NonNull
protected @NonNull Optional<com.fizzed.rocker.RockerModel> httpFile(GeneratorContext generatorContext,
 String secret)

addConfiguration

protected void addConfiguration(GeneratorContext generatorContext,
 String secret)