org.ametys.runtime.plugin

Interface FeatureActivator

All Known Implementing Classes:

AbstractFeatureActivator, ExcludePolicyFeatureActivator, IncludePolicyFeatureActivator

public interface FeatureActivator

An activator of features, which will be loaded by the PluginsManager.
The implemententations must define the strategy in order to determine which extension points, components, etc. need to be loaded.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FeatureActivator.PluginsInformation Helper class containing all relevant information after features list computation.

Method Summary

Modifier and Type	Method and Description
FeatureActivator.PluginsInformation	computeActiveFeatures(Map<String,String> componentsConfig, boolean safeMode) Computes the actual plugins and features to load, based on values selected by the administrator. This method does not actually load nor execute any Java code.
String	fullDump(FeatureActivator.PluginsInformation pluginInfo) Dumps the given FeatureActivator.PluginsInformation, in order to log in debug level.
String	shortDump(FeatureActivator.PluginsInformation pluginInfo) Dumps the given FeatureActivator.PluginsInformation, in order to log in info level.

Method Detail

computeActiveFeatures

FeatureActivator.PluginsInformation computeActiveFeatures(Map<String,String> componentsConfig,
                                                          boolean safeMode)

Computes the actual plugins and features to load, based on values selected by the administrator.
This method does not actually load nor execute any Java code. It reads plugins definitions, selects active features and gets components and extensions definitions.

Parameters:

componentsConfig - chosen components, among those with the same role.

safeMode - true if application is in safe mode

Returns:

all information gathered during plugins reading.

fullDump

String fullDump(FeatureActivator.PluginsInformation pluginInfo)

Dumps the given FeatureActivator.PluginsInformation, in order to log in debug level.

Parameters:

pluginInfo - The information about plugins

Returns:

The string to display in debug level

shortDump

String shortDump(FeatureActivator.PluginsInformation pluginInfo)

Dumps the given FeatureActivator.PluginsInformation, in order to log in info level.

Parameters:

pluginInfo - The information about plugins

Returns:

The string to display in info level