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.

  • Method Details

    • 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.

    • getConfigParameters

      public Map<String,ConfigParameterInfo> getConfigParameters()
      List the configuration parameters declared in the feature. See #getConfigParametersReferences
      Returns:
      The non null map of parameters

    • getConfigParametersReferences

      public Collection<String> getConfigParametersReferences()
      List the configuration parameters referenced from the feature. See #getConfigParameters
      Returns:
      The non null map of parameters