com.atlassian.bamboo

Interface DarkFeatureService

@Internal
public interface DarkFeatureService

An interface that indicates which features are on or off. These can come from system properties or configurable Dark Features.

Since:

5.9

Method Summary

Methods

Modifier and Type	Method and Description
void	disableFeatureForCurrentUser(String featureKey) Disable a given feature for the current user.
void	disableFeatureForUser(String featureKey, com.atlassian.user.User user) Disable a given feature for a given user.
void	enableFeatureForCurrentUser(String featureKey) Enable a given feature for the current user.
void	enableFeatureForUser(String featureKey, com.atlassian.user.User user) Enable a given feature for a given user.
boolean	isArtifactStorageConfigurationEnabled() Check whether the artifact storage configuration is enabled.
boolean	isArtifactStorageSpaceLimited() Whether server-side artifact storage space is limited according to AdministrationConfiguration.getStorageLimit() storage limits.
boolean	isExperimentalRestAdminApiEnabled() Check whether the experimental REST admin API is enabled.
boolean	isFeatureForCurrentUserEnabled(String featureKey) Check whether a given feature key is enabled for the current user.
boolean	isFeatureForUserEnabled(String featureKey, com.atlassian.user.User user) Check whether a given feature key is enabled for a given user.
boolean	isSimplifiedPlanConfigEnabled() Check whether the simplified plan configuration is enabled.

Method Detail

isSimplifiedPlanConfigEnabled

boolean isSimplifiedPlanConfigEnabled()

Check whether the simplified plan configuration is enabled.

Returns:

is the simplified plan configuration enabled.

isArtifactStorageConfigurationEnabled

boolean isArtifactStorageConfigurationEnabled()

Check whether the artifact storage configuration is enabled.

Returns:

is the artifact storage configuration enabled.

isArtifactStorageSpaceLimited

boolean isArtifactStorageSpaceLimited()

Whether server-side artifact storage space is limited according to AdministrationConfiguration.getStorageLimit() storage limits.

isExperimentalRestAdminApiEnabled

boolean isExperimentalRestAdminApiEnabled()

Check whether the experimental REST admin API is enabled.

Returns:

whether the REST admin API is enabled.

enableFeatureForCurrentUser

void enableFeatureForCurrentUser(@NotNull
                               String featureKey)

Enable a given feature for the current user.

Parameters:

featureKey - the feature key to be enabled.

Throws:

IllegalArgumentException - if the current user is not logged in.

enableFeatureForUser

void enableFeatureForUser(@NotNull
                        String featureKey,
                        @NotNull
                        com.atlassian.user.User user)

Enable a given feature for a given user.

Parameters:

featureKey - the feature key to be enabled.

user - the user for which the feature should be enabled.

Throws:

org.acegisecurity.AccessDeniedException - if the current user is not an admin.

disableFeatureForCurrentUser

void disableFeatureForCurrentUser(@NotNull
                                String featureKey)

Disable a given feature for the current user.

Parameters:

featureKey - the feature key to be enabled.

Throws:

IllegalArgumentException - if the current user is not logged in.

disableFeatureForUser

void disableFeatureForUser(@NotNull
                         String featureKey,
                         @NotNull
                         com.atlassian.user.User user)

Disable a given feature for a given user.

Parameters:

featureKey - the feature key to be disabled.

user - the user for which the feature should be disabled.

Throws:

org.acegisecurity.AccessDeniedException - if the current user is not an admin.

isFeatureForUserEnabled

boolean isFeatureForUserEnabled(@NotNull
                              String featureKey,
                              @NotNull
                              com.atlassian.user.User user)

Check whether a given feature key is enabled for a given user. Apart from checking whether the feature is enabled for the given user, this will also check site-wide enabled features.

Parameters:

featureKey - the feature key

user - the user

Returns:

whether the feature key is enabled for the given user.

isFeatureForCurrentUserEnabled

boolean isFeatureForCurrentUserEnabled(@NotNull
                                     String featureKey)

Check whether a given feature key is enabled for the current user. Apart from checking whether the feature is enabled for the current user, this will also check site-wide enabled features.

Parameters:

featureKey - the feature key

Returns:

whether the feature key is enabled for the current user.