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	Description
`static class`	`PluginsManager.InactivityCause`	Cause of the deactivation of a feature
`static class`	`PluginsManager.Status`	PluginsManager status after initialization.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`FEATURE_ID_SEPARATOR`	Separator between pluginName and featureName
`static String`	`INCLUDED_FEATURES_CONTEXT_ATTRIBUTE`	Context attribute containing the features to include.
`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)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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
  - INCLUDED_FEATURES_CONTEXT_ATTRIBUTE
```
public static final String INCLUDED_FEATURES_CONTEXT_ATTRIBUTE
```
    Context attribute containing the features to include.
    If present PluginsManager will init with IncludePolicyFeatureActivator and the provided collection of features (as strings).
    If not present, PluginsManager will init with ExcludePolicyFeatureActivator which is the default one.
    Use with care.
- 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

Class PluginsManager

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PLUGIN_NAMES_IGNORED

PLUGIN_NAME_REGEXP

FEATURE_ID_SEPARATOR

PLUGIN_FILENAME

INCLUDED_FEATURES_CONTEXT_ATTRIBUTE

Method Detail

getInstance

isSafeMode

getErrors

getPluginNames

getBundledPluginsNames

getPlugins

getAllPlugins

getFeatures

getInactiveFeatures

getExtensionPoints

getComponents

getResourceURI

getPluginLocation

getStatus

init