Package io.micronaut.starter.feature.security

Class Security

java.lang.Object

io.micronaut.starter.feature.security.SecurityFeature

io.micronaut.starter.feature.security.Security

All Implemented Interfaces:

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

@Requires(property="micronaut.starter.feature.security.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class Security
extends SecurityFeature
implements OpenRewriteFeature

Core Micronaut Security feature.

Adds a full featured and customizable security solution to the application, including configuration of security intercept URL maps contributed by other features.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
Security(SecurityAnnotations securityAnnotations)

Method Summary

Modifier and Type	Method	Description
protected void	addInterceptUrlMapConfiguration(@NonNull GeneratorContext generatorContext)	Adds the security intercept URL map configuration to the root module based on all contributing features.
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	getDescription()
String	getName()	The name of the feature.
List<String>	getRecipes(GeneratorContext generatorContext)
String	getTitle()

Methods inherited from class io.micronaut.starter.feature.security.SecurityFeature

getCategory, processSelectedFeatures

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getDescription

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

getCategory, getOrder, isCommunity, isPreview, isVisible, processSelectedFeatures, supports

Methods inherited from interface io.micronaut.projectgen.core.openrewrite.OpenRewriteFeature

getFrameworkDocumentation, getThirdPartyDocumentation, processRecipes

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

Security

public Security(SecurityAnnotations securityAnnotations)

Method Details

getName

public 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

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

public String getDescription()

Specified by:

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

Specified by:

getDescription in interface 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(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

Specified by:

apply in interface OpenRewriteFeature

Parameters:

generatorContext - THe generator context

addInterceptUrlMapConfiguration

protected void addInterceptUrlMapConfiguration(@NonNull
 @NonNull GeneratorContext generatorContext)

Adds the security intercept URL map configuration to the root module based on all contributing features.

Parameters:

generatorContext - The context of the code generator.

getRecipes

public List<String> getRecipes(GeneratorContext generatorContext)

Specified by:

getRecipes in interface OpenRewriteFeature