io.micronaut.starter.feature.security

Class SecurityOAuth2

java.lang.Object

io.micronaut.starter.feature.security.SecurityFeature

io.micronaut.starter.feature.security.SecurityOAuth2

All Implemented Interfaces:

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

@Singleton
public class SecurityOAuth2
extends SecurityFeature
implements SecurityAuthenticationModeProvider

Field Summary

Fields

Modifier and Type	Field and Description
static int	ORDER

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

PROPERTY_MICRONAUT_SECURITY_AUTHENTICATION

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
SecurityOAuth2(SecurityAnnotations securityAnnotations)

Method Summary

Modifier and Type	Method and 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(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
java.lang.String	getDescription()
java.lang.String	getMicronautDocumentation()
java.lang.String	getName() The name of the feature.
int	getOrder() The order of a feature controls the order in which it applies.
SecurityAuthenticationMode	getSecurityAuthenticationMode()
java.lang.String	getTitle()

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

getCategory, processSelectedFeatures, supports

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

getThirdPartyDocumentation, isCommunity, isPreview, isVisible

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

getDescription

Field Detail

ORDER

public static final int ORDER

See Also:

Constant Field Values

Constructor Detail

SecurityOAuth2

public SecurityOAuth2(SecurityAnnotations securityAnnotations)

Method Detail

getName

@NonNull
public java.lang.String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

getName in interface io.micronaut.core.naming.Named

Specified by:

getName in interface Feature

Returns:

the name of the feature

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

@NonNull
public java.lang.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(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

getMicronautDocumentation

public java.lang.String getMicronautDocumentation()

Specified by:

getMicronautDocumentation in interface Feature

Returns:

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

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 io.micronaut.core.order.Ordered

Specified by:

getOrder in interface Feature

Returns:

The order of the feature

getSecurityAuthenticationMode

@NonNull
public SecurityAuthenticationMode getSecurityAuthenticationMode()

Specified by:

getSecurityAuthenticationMode in interface SecurityAuthenticationModeProvider