io.micronaut.starter.feature.multitenancy

Class MultitenancyGorm

java.lang.Object

io.micronaut.starter.feature.multitenancy.MultitenancyGorm

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, LanguageSpecificFeature

@Singleton
public class MultitenancyGorm
extends java.lang.Object
implements Feature, LanguageSpecificFeature

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
MultitenancyGorm(Multitenancy multitenancy)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategory()
java.lang.String	getDescription()
java.lang.String	getMicronautDocumentation()
java.lang.String	getName() The name of the feature.
Language	getRequiredLanguage()
java.lang.String	getThirdPartyDocumentation()
java.lang.String	getTitle()
boolean	isPreview()
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(ApplicationType, io.micronaut.starter.options.Options, java.util.Set).
boolean	supports(ApplicationType applicationType) This method must be implemented to ensure it is only selectable for the desired application types.

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

apply, getOrder, isVisible

Constructor Detail

MultitenancyGorm

public MultitenancyGorm(Multitenancy multitenancy)

Method Detail

isPreview

public boolean isPreview()

Specified by:

isPreview in interface Feature

Returns:

Indicates the feature is in preview status and is subject to change.

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(ApplicationType, 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

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

public java.lang.String getDescription()

Specified by:

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

Specified by:

getDescription in interface Feature

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

getThirdPartyDocumentation

public java.lang.String getThirdPartyDocumentation()

Specified by:

getThirdPartyDocumentation in interface Feature

Returns:

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

supports

public boolean supports(ApplicationType applicationType)

Description copied from interface: Feature

This method must be implemented to ensure it is only selectable for the desired application types. This method is not used for determining if a default feature should be applied.

Specified by:

supports in interface Feature

Parameters:

applicationType - The application type

Returns:

True if the feature can be selected by the user

getRequiredLanguage

public Language getRequiredLanguage()

Specified by:

getRequiredLanguage in interface LanguageSpecificFeature

Returns:

The language this feature requires, or empty if the feature can be used with any language.

getCategory

public java.lang.String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.