Package io.micronaut.starter.feature.security

Class SecurityJWT

java.lang.Object

io.micronaut.starter.feature.security.SecurityFeature

io.micronaut.starter.feature.security.SecurityJWT

All Implemented Interfaces:

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

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

Security feature for JWT (JSON Web Token) based authentication. Implements SecurityAuthenticationModeProvider to specify the authentication mode.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final int	ORDER

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Fields inherited from interface io.micronaut.starter.feature.security.SecurityAuthenticationModeProvider

PROPERTY_MICRONAUT_SECURITY_AUTHENTICATION

Constructor Summary

Constructors

Constructor	Description
SecurityJWT(SecurityAnnotations securityAnnotations)

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getName()	The name of the feature.
int	getOrder()	The order of a feature controls the order in which it applies.
List<String>	getRecipes(GeneratorContext generatorContext)
@NonNull SecurityAuthenticationMode	getSecurityAuthenticationMode()
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, isCommunity, isPreview, isVisible, processSelectedFeatures, supports

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

apply, getFrameworkDocumentation, getThirdPartyDocumentation, processRecipes

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

ORDER

public static final int ORDER

See Also:

• Constant Field Values

Constructor Details

SecurityJWT

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

getRecipes

public List<String> getRecipes(GeneratorContext generatorContext)

Specified by:

getRecipes in interface OpenRewriteFeature

getOrder

public int getOrder()

Description copied from interface: Feature

The order of a feature controls the order in which it applies. The order of a feature is important to ensure that any previous work done by other features that may be required is done. See FeaturePhase for a list of phases to choose from.

Specified by:

getOrder in interface Feature

Specified by:

getOrder in interface io.micronaut.core.order.Ordered

Returns:

The order of the feature

getSecurityAuthenticationMode

@NonNull
public @NonNull SecurityAuthenticationMode getSecurityAuthenticationMode()

Specified by:

getSecurityAuthenticationMode in interface SecurityAuthenticationModeProvider