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, MicronautServerDependent

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

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)
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	getFrameworkDocumentation(GeneratorContext generatorContext)
String	getName()	The name of the feature.
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

getOrder, getThirdPartyDocumentation, isCommunity, isPreview, isVisible, supports

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.

Returns:

the name of the feature

getTitle

public String getTitle()

Returns:

The title of the feature

getDescription

public String getDescription()

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.

Parameters:

generatorContext - THe generator context

addInterceptUrlMapConfiguration

protected void addInterceptUrlMapConfiguration(@NonNull
 @NonNull GeneratorContext generatorContext)

getFrameworkDocumentation

public String getFrameworkDocumentation(GeneratorContext generatorContext)

Parameters:

generatorContext - Generator Context

Returns:

Returns a link to Framework documentation about the feature. eg. https://micronaut-projects.github.io/micronaut-cache/latest/guide/index.html#hazelcast