Package org.ametys.runtime.plugin

Class Feature

java.lang.Object

org.ametys.runtime.plugin.Feature

public class Feature
extends Object

A plugin is composed by features, containing components definitions and extensions.

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,ComponentDefinition>	_components
private Map<String,ConfigParameterInfo>	_configParameters
private Collection<String>	_configParametersRefs
private Configuration	_configuration
private Collection<String>	_deactivations
private Collection<String>	_dependencies
private Map<String,Map<String,ExtensionDefinition>>	_extensions
private String	_featureName
private Collection<String>	_overrides
private Map<String,ConfigParameterInfo>	_paramCheckers
private boolean	_passive
private String	_pluginName
private boolean	_safe

Constructor Summary

Constructors

Constructor	Description
Feature(String pluginName, String featureName)

Method Summary

Modifier and Type	Method	Description
private void	_configureComponents()
private void	_configureConfigParameterReferences(Configuration configConfiguration)
private void	_configureConfigParameters(Configuration configConfiguration)
private void	_configureDeactivations()
private static Collection<String>	_configureDeactivationsOrOverrides(Configuration configuration, String attributeName, String pluginName)
private void	_configureDependencies()
private void	_configureExtensions()
private void	_configureOverrides()
private void	_configureParametersCheckers(Configuration configConfiguration)
(package private) void	configure(Configuration configuration)
(package private) Map<String,ComponentDefinition>	getComponents()
Map<String,String>	getComponentsIds()	Returns the components declared within this feature, stored by role.
(package private) Map<String,ConfigParameterInfo>	getConfigParameters()
(package private) Collection<String>	getConfigParametersReferences()
(package private) Configuration	getConfiguration()
(package private) Collection<String>	getDeactivations()
(package private) Collection<String>	getDependencies()
(package private) Map<String,Map<String,ExtensionDefinition>>	getExtensions()
Map<String,Collection<String>>	getExtensionsIds()	Returns the extensions declared within this feature, grouped by extension point.
String	getFeatureId()	Returns the feature id, ie.
String	getFeatureName()	Returns this feature name
(package private) Collection<String>	getOverrides()
(package private) Map<String,ConfigParameterInfo>	getParameterCheckers()
String	getPluginName()	Returns the declaring plugin name
boolean	isPassive()	Returns true if this feature is passive.
boolean	isSafe()	Returns true if this feature is declared as safe.

Methods inherited from class java.lang.Object

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

Field Detail

_pluginName

private String _pluginName

_featureName

private String _featureName

_configuration

private Configuration _configuration

_safe

private boolean _safe

_passive

private boolean _passive

_dependencies

private Collection<String> _dependencies

_deactivations

private Collection<String> _deactivations

_overrides

private Collection<String> _overrides

_configParameters

private Map<String,ConfigParameterInfo> _configParameters

_configParametersRefs

private Collection<String> _configParametersRefs

_paramCheckers

private Map<String,ConfigParameterInfo> _paramCheckers

_extensions

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

_components

private Map<String,ComponentDefinition> _components

Constructor Detail

Feature

Feature(String pluginName,
        String featureName)

Method Detail

getPluginName

public String getPluginName()

Returns the declaring plugin name

Returns:

the declaring plugin name

getFeatureName

public String getFeatureName()

Returns this feature name

Returns:

this feature name

getFeatureId

public String getFeatureId()

Returns the feature id, ie. getPluginName() + '/' + getFeatureName()

Returns:

the feature id.

isPassive

public boolean isPassive()

Returns true if this feature is passive.

Returns:

true if this feature is passive.

isSafe

public boolean isSafe()

Returns true if this feature is declared as safe.

Returns:

true if this feature is declared as safe.

getExtensionsIds

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

Returns the extensions declared within this feature, grouped by extension point.

Returns:

the extensions declared within this feature, grouped by extension point.

getComponentsIds

public Map<String,String> getComponentsIds()

Returns the components declared within this feature, stored by role.

Returns:

the components declared within this feature, stored by role.

getConfiguration

Configuration getConfiguration()

getDependencies

Collection<String> getDependencies()

getDeactivations

Collection<String> getDeactivations()

getOverrides

Collection<String> getOverrides()

getExtensions

Map<String,Map<String,ExtensionDefinition>> getExtensions()

getComponents

Map<String,ComponentDefinition> getComponents()

getConfigParameters

Map<String,ConfigParameterInfo> getConfigParameters()

getConfigParametersReferences

Collection<String> getConfigParametersReferences()

getParameterCheckers

Map<String,ConfigParameterInfo> getParameterCheckers()

configure

void configure(Configuration configuration)

_configureDependencies

private void _configureDependencies()

_configureDeactivations

private void _configureDeactivations()

_configureOverrides

private void _configureOverrides()

_configureDeactivationsOrOverrides

private static Collection<String> _configureDeactivationsOrOverrides(Configuration configuration,
                                                                     String attributeName,
                                                                     String pluginName)

_configureConfigParameters

private void _configureConfigParameters(Configuration configConfiguration)

_configureConfigParameterReferences

private void _configureConfigParameterReferences(Configuration configConfiguration)

_configureParametersCheckers

private void _configureParametersCheckers(Configuration configConfiguration)

_configureExtensions

private void _configureExtensions()

_configureComponents

private void _configureComponents()