com.atlassian.confluence.it

Class DarkFeaturesHelper

java.lang.Object

com.atlassian.confluence.it.DarkFeaturesHelper

public class DarkFeaturesHelper
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_USER_ENABLED_FEATURES
static String	USER_DARKFEATURES_PATH

Constructor Summary

Constructors

Constructor and Description
DarkFeaturesHelper(ConfluenceRpc rpc)

Method Summary

Modifier and Type	Method and Description
boolean	disableSiteFeature(String featureKey)
boolean	disableUserFeature(String featureKey)
void	enableDarkFeatureModules(com.google.common.collect.Multimap<Plugin,String> pluginModules, boolean enable) Dark features can be implemented by using disabled plugin modules, this method provides a way for tests to enable a set of plugin modules that comprise a dark feature
boolean	enableSiteFeature(String featureKey)
boolean	enableSiteFeatures(String... featureKeys)
boolean	enableUserFeature(String featureKey)
boolean	enableUserFeatures(String... featureKeys)
boolean	isDarkFeatureModulesEnabled(com.google.common.collect.Multimap<Plugin,String> pluginModules) Dark features can be implemented by using disabled plugin modules, this method queries the state of a set of dark feature modules.
boolean	isEnabled(String featureKey)
static boolean	isEnabled(String featureKey, ConfluenceRpc rpc) Deprecated. Since 5.0 Use the non-static method.
boolean	isSiteFeatureEnabled(String featureKey)
void	loadEnabledSiteFeatures(User user, String... features)
void	setUserEnabledFeatures(User user, String featureKeys) Sets all Dark Features enabled for the given user.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_USER_ENABLED_FEATURES

public static final String PROPERTY_USER_ENABLED_FEATURES

See Also:

Constant Field Values

USER_DARKFEATURES_PATH

public static final String USER_DARKFEATURES_PATH

See Also:

Constant Field Values

Constructor Detail

DarkFeaturesHelper

public DarkFeaturesHelper(ConfluenceRpc rpc)

Method Detail

setUserEnabledFeatures

public void setUserEnabledFeatures(User user,
                                   String featureKeys)

Sets all Dark Features enabled for the given user.

Parameters:

user - the user to enable/disable features for

featureKeys - a comma-separated list of feature keys, or a blank string to disable all features

enableUserFeatures

public boolean enableUserFeatures(String... featureKeys)

enableUserFeature

public boolean enableUserFeature(String featureKey)

disableUserFeature

public boolean disableUserFeature(String featureKey)

enableSiteFeatures

public boolean enableSiteFeatures(String... featureKeys)

enableSiteFeature

public boolean enableSiteFeature(String featureKey)

disableSiteFeature

public boolean disableSiteFeature(String featureKey)

isEnabled

@Deprecated
public static boolean isEnabled(String featureKey,
                                            ConfluenceRpc rpc)

Deprecated. Since 5.0 Use the non-static method.

isEnabled

public boolean isEnabled(String featureKey)

isSiteFeatureEnabled

public boolean isSiteFeatureEnabled(String featureKey)

loadEnabledSiteFeatures

public void loadEnabledSiteFeatures(User user,
                                    String... features)

enableDarkFeatureModules

public void enableDarkFeatureModules(com.google.common.collect.Multimap<Plugin,String> pluginModules,
                                     boolean enable)

Dark features can be implemented by using disabled plugin modules, this method provides a way for tests to enable a set of plugin modules that comprise a dark feature

Parameters:

pluginModules -

enable - - whether the modules should be enabled or disabled

isDarkFeatureModulesEnabled

public boolean isDarkFeatureModulesEnabled(com.google.common.collect.Multimap<Plugin,String> pluginModules)

Dark features can be implemented by using disabled plugin modules, this method queries the state of a set of dark feature modules.

Parameters:

pluginModules - - the set of plugin modules that comprise the dark feature.

Returns:

true if ALL modules in the pluginModules map are enabled.