Package io.micronaut.starter.feature.agorapulse.permissions

Class Permissions

java.lang.Object

io.micronaut.starter.feature.agorapulse.permissions.Permissions

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, AgoraPulseFeature, CommunityFeature, MicronautCommunityFeature

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

Micronaut Permissions community feature. Provides integration with the Micronaut Permissions library, a lightweight library for declaring object-level permissions in Micronaut applications. This feature adds required dependencies, example code, and manages related features such as Security and Mockito.

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
Permissions(Mockito mockito, Security security)

Method Summary

Modifier and Type	Method	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(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
String	getCategory()
@NonNull String	getCommunityFeatureName()
String	getCommunityFeatureTitle()
@Nullable String	getDescription()
String	getThirdPartyDocumentation(GeneratorContext generatorContext)
void	processSelectedFeatures(FeatureContext featureContext)	If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set).

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.projectgen.core.feature.Feature

getFrameworkDocumentation, getOrder, isPreview, supports

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

isVisible, supportsCurrentMicronautVersion

Constructor Details

Permissions

public Permissions(Mockito mockito,
 Security security)

Method Details

getCommunityFeatureName

@NonNull
public @NonNull String getCommunityFeatureName()

Specified by:

getCommunityFeatureName in interface CommunityFeature

getCommunityFeatureTitle

public String getCommunityFeatureTitle()

Specified by:

getCommunityFeatureTitle in interface CommunityFeature

getCategory

public String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.

getDescription

@Nullable
public @Nullable String getDescription()

Specified by:

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

Specified by:

getDescription in interface Feature

getThirdPartyDocumentation

public String getThirdPartyDocumentation(GeneratorContext generatorContext)

Specified by:

getThirdPartyDocumentation in interface AgoraPulseFeature

Specified by:

getThirdPartyDocumentation in interface Feature

Parameters:

generatorContext - Generator Context

Returns:

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

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

Parameters:

generatorContext - THe generator context

processSelectedFeatures

public void processSelectedFeatures(FeatureContext featureContext)

Description copied from interface: Feature

If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set). This method can be implemented to allow features to modify the list of features that will apply to the project. The methods FeatureContext.addFeature(Feature) and FeatureContext.exclude(FeaturePredicate) are the primary ways to add and remove features from the context. FeatureContext.isPresent(Class) can be used to determine the existence of other features in order to make decisions.

Specified by:

processSelectedFeatures in interface Feature

Parameters:

featureContext - The feature context