Package org.exoplatform.commons.api.settings

Interface ExoFeatureService

public interface ExoFeatureService

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    FEATURE_STATUS_CHANGED_EVENT
    An event to trigger using ListenerService when a feature status changes using API

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addFeaturePlugin(FeaturePlugin featurePlugin)
    Add a feature plugin that will manage feature enablement that will be applied only on one feature identified by its name
    boolean
    isActiveFeature(String featureName)
    Check the status of a feature
    boolean
    isFeatureActiveForUser(String featureName, String username)
    Determines whether the feature is active for a user or not
    void
    saveActiveFeature(String featureName, boolean isActive)
    Switch feature featureName on or off

  • Field Details

    • FEATURE_STATUS_CHANGED_EVENT

      static final String FEATURE_STATUS_CHANGED_EVENT
      An event to trigger using ListenerService when a feature status changes using API
      See Also:

  • Method Details

    • isActiveFeature

      boolean isActiveFeature(String featureName)
      Check the status of a feature
      Parameters:
      featureName -
      Returns:
      true if the featureName is on, false if it's off

    • saveActiveFeature

      void saveActiveFeature(String featureName, boolean isActive)
      Switch feature featureName on or off
      Parameters:
      featureName -
      isActive - new status of feature, true = on and false = off

    • addFeaturePlugin

      void addFeaturePlugin(FeaturePlugin featurePlugin)
      Add a feature plugin that will manage feature enablement that will be applied only on one feature identified by its name
      Parameters:
      featurePlugin - of type FeaturePlugin

    • isFeatureActiveForUser

      boolean isFeatureActiveForUser(String featureName, String username)
      Determines whether the feature is active for a user or not
      Parameters:
      featureName -
      username -
      Returns:
      true if active, else false