org.ametys.runtime.plugin

Class PluginsManager

java.lang.Object

org.ametys.runtime.plugin.PluginsManager

public final class PluginsManager
extends Object

The PluginManager is in charge to load and initialize plugins.
It gives access to the extension points.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginsManager.InactivityCause Cause of the deactivation of a feature
static class	PluginsManager.PluginsInformation Helper class containing all relevant informations after features list computation.
static class	PluginsManager.Status PluginsManager status after initialization.

Field Summary

Fields

Modifier and Type	Field and Description
private static PluginsManager	__instance
private Map<String,Plugin>	_allPlugins
private Map<String,ComponentDefinition>	_components
private Collection<PluginIssue>	_errors
private Map<String,ExtensionPointDefinition>	_extensionPoints
private Map<String,Map<String,ExtensionDefinition>>	_extensions
private Map<String,Feature>	_features
private Map<String,PluginsManager.InactivityCause>	_inactiveFeatures
private Map<String,File>	_locations
private Logger	_logger
private Map<String,Plugin>	_plugins
private Map<String,String>	_resourceURIs
private boolean	_safeMode
private PluginsManager.Status	_status
static String	FEATURE_ID_SEPARATOR Separator between pluginName and featureName
static String	PLUGIN_FILENAME Plugin filename
static String	PLUGIN_NAME_REGEXP The regexp to determine if a plugin name is correct (add ^ and $ as delimiters if this is your only test)
static String	PLUGIN_NAMES_IGNORED The regexp to determine if a plugin name is ignored (CVS or .* or *.bak or *.old)

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PluginsManager()

Method Summary

Modifier and Type	Method and Description
private void	_addPlugin(Map<String,Plugin> plugins, String pluginName, File pluginDir, Collection<String> excludedPlugins)
private Map<String,Plugin>	_computeActivePlugins(Collection<String> excludedPlugins, Map<String,Feature> initialFeatures, Map<String,PluginsManager.InactivityCause> inactiveFeatures, Map<String,ExtensionPointDefinition> extensionPoints, Collection<PluginIssue> errors)
private Map<String,ComponentDefinition>	_computeComponents(Map<String,Feature> features, Map<String,String> componentsConfig, Collection<PluginIssue> errors)
private Map<String,Map<String,ExtensionDefinition>>	_computeExtensions(Map<String,Feature> features, Collection<PluginIssue> errors)
private void	_computeFeaturesDependencies(String featureId, Map<String,Feature> features, Map<String,Feature> result, String initialFeatureId, Collection<PluginIssue> errors)
private Map<String,Collection<String>>	_computeIncomingDeactivations(Map<String,Feature> features)
private Map<String,Collection<String>>	_computeIncompingDependencies(Map<String,Feature> features)
private String	_dumpFeature(Feature feature, Map<String,PluginsManager.InactivityCause> inactiveFeatures)
private String	_dumpPlugin(Plugin plugin, Collection<String> excludedPlugins, Map<String,PluginsManager.InactivityCause> inactiveFeatures)
private PluginsComponentManager	_enterSafeMode(ComponentManager parentCM, Context context, String contextPath)
private Configuration	_getComponentConfiguration(Configuration initialConfiguration, String contextPath, String pluginName, Collection<PluginIssue> errors)
private Configuration	_getConfigurationFromStream(String pluginName, InputStream is, String path, Collection<String> excludedPlugins)
private void	_initResourceURIs()
private void	_loadComponents(PluginsComponentManager manager, Map<String,ComponentDefinition> components, String contextPath, Collection<PluginIssue> errors)
private void	_loadExtensionsPoints(PluginsComponentManager manager, Map<String,ExtensionPointDefinition> extensionPoints, Map<String,Map<String,ExtensionDefinition>> extensionsDefinitions, String contextPath, Collection<PluginIssue> errors)
private void	_loadRuntimeInit(PluginsComponentManager manager, Collection<PluginIssue> errors)
private Map<String,Plugin>	_parsePlugins(String contextPath, Collection<String> locations, Map<String,File> externalPlugins, Collection<String> excludedPlugins)
private void	_pluginError(String pluginName, String message, PluginIssue.PluginIssueCode code, Collection<String> excludedPlugins, Exception e)
private Map<String,Feature>	_processOutgoingDependencies(Map<String,Feature> initialFeatures, Map<String,PluginsManager.InactivityCause> inactiveFeatures, Collection<PluginIssue> errors)
private void	_removeInactiveFeatures(Map<String,Feature> initialFeatures, Map<String,PluginsManager.InactivityCause> inactiveFeatures, Map<String,Collection<String>> incomingDeactivations, Map<String,String> componentsConfig)
private PluginsManager.PluginsInformation	computeActiveFeatures(String contextPath, Collection<String> excludedPlugins, Collection<String> excludedFeatures, Map<String,String> componentsConfig) Computes the actual plugins and features to load, based on values selected by the administrator. This method don't actually load nor execute any Java code.
String	dump(Map<String,PluginsManager.InactivityCause> inactiveFeatures) Outputs the structure of the plugins.
Map<String,Plugin>	getAllPlugins() Returns all existing plugins definitions.
Set<String>	getBundledPluginsNames() Returns a String array containing the names of the plugins bundled in jars
Collection<String>	getComponents() Returns the components roles.
Collection<PluginIssue>	getErrors() Returns errors gathered during plugins loading.
Map<String,Collection<String>>	getExtensionPoints() Returns the extensions points and their extensions
Map<String,Feature>	getFeatures() Returns loaded features declarations.
Map<String,PluginsManager.InactivityCause>	getInactiveFeatures() Returns inactive features id and cause of deactivation.
static PluginsManager	getInstance() Returns the shared instance of the PluginManager
File	getPluginLocation(String pluginName) Returns the plugin filesystem location for the given plugin or null if the plugin is loaded from the classpath.
Set<String>	getPluginNames() Returns the names of the plugins
Map<String,Plugin>	getPlugins() Returns active plugins declarations.
String	getResourceURI(String pluginName) Returns the base URI for the given plugin resources, or null if the plugin does not exist or is located in the file system.
PluginsManager.Status	getStatus() Returns the status after initialization.
PluginsComponentManager	init(ComponentManager parentCM, Context context, String contextPath, boolean forceSafeMode) Initialization of the plugin manager
boolean	isSafeMode() Returns true if the safe mode is activated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PLUGIN_NAMES_IGNORED

public static final String PLUGIN_NAMES_IGNORED

The regexp to determine if a plugin name is ignored (CVS or .* or *.bak or *.old)

See Also:

Constant Field Values

PLUGIN_NAME_REGEXP

public static final String PLUGIN_NAME_REGEXP

The regexp to determine if a plugin name is correct (add ^ and $ as delimiters if this is your only test)

See Also:

Constant Field Values

FEATURE_ID_SEPARATOR

public static final String FEATURE_ID_SEPARATOR

Separator between pluginName and featureName

See Also:

Constant Field Values

PLUGIN_FILENAME

public static final String PLUGIN_FILENAME

Plugin filename

See Also:

Constant Field Values

__instance

private static PluginsManager __instance

_safeMode

private boolean _safeMode

_resourceURIs

private Map<String,String> _resourceURIs

_locations

private Map<String,File> _locations

_allPlugins

private Map<String,Plugin> _allPlugins

_plugins

private Map<String,Plugin> _plugins

_features

private Map<String,Feature> _features

_inactiveFeatures

private Map<String,PluginsManager.InactivityCause> _inactiveFeatures

_extensionPoints

private Map<String,ExtensionPointDefinition> _extensionPoints

_components

private Map<String,ComponentDefinition> _components

_extensions

private Map<String,Map<String,ExtensionDefinition>> _extensions

_status

private PluginsManager.Status _status

_logger

private Logger _logger

_errors

private Collection<PluginIssue> _errors

Constructor Detail

PluginsManager

private PluginsManager()

Method Detail

getInstance

public static PluginsManager getInstance()

Returns the shared instance of the PluginManager

Returns:

the shared instance of the PluginManager

isSafeMode

public boolean isSafeMode()

Returns true if the safe mode is activated.

Returns:

true if the safe mode is activated.

getErrors

public Collection<PluginIssue> getErrors()

Returns errors gathered during plugins loading.

Returns:

errors gathered during plugins loading.

getPluginNames

public Set<String> getPluginNames()

Returns the names of the plugins

Returns:

the names of the plugins

getBundledPluginsNames

public Set<String> getBundledPluginsNames()

Returns a String array containing the names of the plugins bundled in jars

Returns:

a String array containing the names of the plugins bundled in jars

getPlugins

public Map<String,Plugin> getPlugins()

Returns active plugins declarations.

Returns:

active plugins declarations.

getAllPlugins

public Map<String,Plugin> getAllPlugins()

Returns all existing plugins definitions.

Returns:

all existing plugins definitions.

getFeatures

public Map<String,Feature> getFeatures()

Returns loaded features declarations.
They may be different than active feature in case of safe mode.

Returns:

loaded features declarations.

getInactiveFeatures

public Map<String,PluginsManager.InactivityCause> getInactiveFeatures()

Returns inactive features id and cause of deactivation.

Returns:

inactive features id and cause of deactivation.

getExtensionPoints

public Map<String,Collection<String>> getExtensionPoints()

Returns the extensions points and their extensions

Returns:

the extensions points and their extensions

getComponents

public Collection<String> getComponents()

Returns the components roles.

Returns:

the components roles.

getResourceURI

public String getResourceURI(String pluginName)

Returns the base URI for the given plugin resources, or null if the plugin does not exist or is located in the file system.

Parameters:

pluginName - the name of the plugin

Returns:

the base URI for the given plugin resources, or null if the plugin does not exist or is located in the file system.

getPluginLocation

public File getPluginLocation(String pluginName)

Returns the plugin filesystem location for the given plugin or null if the plugin is loaded from the classpath.

Parameters:

pluginName - the plugin name

Returns:

the plugin location for the given plugin

getStatus

public PluginsManager.Status getStatus()

Returns the status after initialization.

Returns:

the status after initialization.

init

public PluginsComponentManager init(ComponentManager parentCM,
                                    Context context,
                                    String contextPath,
                                    boolean forceSafeMode)
                             throws Exception

Initialization of the plugin manager

Parameters:

parentCM - the parent ComponentManager.

context - the Avalon context

contextPath - the Web context path on the server filesystem

forceSafeMode - true to force the application to enter the safe mode

Returns:

the PluginsComponentManager containing loaded components.

Throws:

Exception - if something wrong occurs during plugins loading

dump

public String dump(Map<String,PluginsManager.InactivityCause> inactiveFeatures)

Outputs the structure of the plugins.

Parameters:

inactiveFeatures - id and cause of inactive features

Returns:

a String representation of all existing plugins and features.

_dumpPlugin

private String _dumpPlugin(Plugin plugin,
                           Collection<String> excludedPlugins,
                           Map<String,PluginsManager.InactivityCause> inactiveFeatures)

_dumpFeature

private String _dumpFeature(Feature feature,
                            Map<String,PluginsManager.InactivityCause> inactiveFeatures)

_initResourceURIs

private void _initResourceURIs()
                        throws IOException

Throws:

IOException

_parsePlugins

private Map<String,Plugin> _parsePlugins(String contextPath,
                                         Collection<String> locations,
                                         Map<String,File> externalPlugins,
                                         Collection<String> excludedPlugins)
                                  throws IOException

Throws:

IOException

_addPlugin

private void _addPlugin(Map<String,Plugin> plugins,
                        String pluginName,
                        File pluginDir,
                        Collection<String> excludedPlugins)
                 throws IOException

Throws:

IOException

_getConfigurationFromStream

private Configuration _getConfigurationFromStream(String pluginName,
                                                  InputStream is,
                                                  String path,
                                                  Collection<String> excludedPlugins)

_pluginError

private void _pluginError(String pluginName,
                          String message,
                          PluginIssue.PluginIssueCode code,
                          Collection<String> excludedPlugins,
                          Exception e)

computeActiveFeatures

private PluginsManager.PluginsInformation computeActiveFeatures(String contextPath,
                                                                Collection<String> excludedPlugins,
                                                                Collection<String> excludedFeatures,
                                                                Map<String,String> componentsConfig)

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

Parameters:

contextPath - the application context path.

excludedPlugins - manually excluded plugins.

excludedFeatures - manually excluded features.

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

Returns:

all informations gathered during plugins reading.

_computeActivePlugins

private Map<String,Plugin> _computeActivePlugins(Collection<String> excludedPlugins,
                                                 Map<String,Feature> initialFeatures,
                                                 Map<String,PluginsManager.InactivityCause> inactiveFeatures,
                                                 Map<String,ExtensionPointDefinition> extensionPoints,
                                                 Collection<PluginIssue> errors)

_removeInactiveFeatures

private void _removeInactiveFeatures(Map<String,Feature> initialFeatures,
                                     Map<String,PluginsManager.InactivityCause> inactiveFeatures,
                                     Map<String,Collection<String>> incomingDeactivations,
                                     Map<String,String> componentsConfig)

_computeIncomingDeactivations

private Map<String,Collection<String>> _computeIncomingDeactivations(Map<String,Feature> features)

_processOutgoingDependencies

private Map<String,Feature> _processOutgoingDependencies(Map<String,Feature> initialFeatures,
                                                         Map<String,PluginsManager.InactivityCause> inactiveFeatures,
                                                         Collection<PluginIssue> errors)

_computeIncompingDependencies

private Map<String,Collection<String>> _computeIncompingDependencies(Map<String,Feature> features)

_computeFeaturesDependencies

private void _computeFeaturesDependencies(String featureId,
                                          Map<String,Feature> features,
                                          Map<String,Feature> result,
                                          String initialFeatureId,
                                          Collection<PluginIssue> errors)

_computeExtensions

private Map<String,Map<String,ExtensionDefinition>> _computeExtensions(Map<String,Feature> features,
                                                                       Collection<PluginIssue> errors)

_computeComponents

private Map<String,ComponentDefinition> _computeComponents(Map<String,Feature> features,
                                                           Map<String,String> componentsConfig,
                                                           Collection<PluginIssue> errors)

_loadExtensionsPoints

private void _loadExtensionsPoints(PluginsComponentManager manager,
                                   Map<String,ExtensionPointDefinition> extensionPoints,
                                   Map<String,Map<String,ExtensionDefinition>> extensionsDefinitions,
                                   String contextPath,
                                   Collection<PluginIssue> errors)

_loadComponents

private void _loadComponents(PluginsComponentManager manager,
                             Map<String,ComponentDefinition> components,
                             String contextPath,
                             Collection<PluginIssue> errors)

_getComponentConfiguration

private Configuration _getComponentConfiguration(Configuration initialConfiguration,
                                                 String contextPath,
                                                 String pluginName,
                                                 Collection<PluginIssue> errors)

_loadRuntimeInit

private void _loadRuntimeInit(PluginsComponentManager manager,
                              Collection<PluginIssue> errors)

_enterSafeMode

private PluginsComponentManager _enterSafeMode(ComponentManager parentCM,
                                               Context context,
                                               String contextPath)