View Javadoc

1   package com.atlassian.sal.api.features;
2   
3   import com.atlassian.annotations.PublicSpi;
4   import com.google.common.collect.ImmutableSet;
5   
6   /**
7    * Persist site wide dark feature keys. <strong>The storage part used by the default {@link DarkFeatureManager}
8    * implementation.</strong>
9    *
10   * @since 2.10
11   */
12  @PublicSpi
13  public interface SiteDarkFeaturesStorage {
14      /**
15       * Enable the given dark feature key site wide.
16       *
17       * @param featureKey the feature key to be enabled; not blank, leading and trailing whitespaces are removed
18       */
19      void enable(String featureKey);
20  
21      /**
22       * Disable the given dark feature key site wide.
23       *
24       * @param featureKey the feature key to be disabled; not blank, leading and trailing whitespaces are removed
25       */
26      void disable(String featureKey);
27  
28      /**
29       * @return all enabled site wide dark feature keys.
30       */
31      ImmutableSet<String> getEnabledDarkFeatures();
32  }