com.gooddata.sdk.service.featureflag

Class FeatureFlagService

java.lang.Object

com.gooddata.sdk.service.AbstractService

com.gooddata.sdk.service.featureflag.FeatureFlagService

public class FeatureFlagService
extends AbstractService

Provides feature flag management. Feature flag is a boolean flag used for enabling / disabling some specific feature of GoodData platform. It can be used in various scopes (per project, per project group, per user, global etc.).

Nested Class Summary

Nested classes/interfaces inherited from class com.gooddata.sdk.service.AbstractService

AbstractService.OutputStreamResponseExtractor

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.springframework.web.util.UriTemplate	AGGREGATED_FEATURE_FLAGS_TEMPLATE
protected static org.springframework.web.util.UriTemplate	PROJECT_FEATURE_FLAG_TEMPLATE
protected static org.springframework.web.util.UriTemplate	PROJECT_FEATURE_FLAGS_TEMPLATE

Fields inherited from class com.gooddata.sdk.service.AbstractService

mapper, restTemplate

Constructor Summary

Constructors

Constructor and Description
FeatureFlagService(org.springframework.web.client.RestTemplate restTemplate, GoodDataSettings settings) Constructs service for GoodData feature flags management.

Method Summary

Modifier and Type	Method and Description
ProjectFeatureFlag	createProjectFeatureFlag(Project project, ProjectFeatureFlag flag) Creates new feature flag for given project.
void	deleteProjectFeatureFlag(ProjectFeatureFlag flag) Deletes existing project feature flag.
ProjectFeatureFlag	getProjectFeatureFlag(Project project, String featureFlagName) Returns project feature flag (only project scoped flags, use listFeatureFlags(Project) for aggregated flags from all scopes) for given project by its unique name (aka "key").
FeatureFlags	listFeatureFlags(Project project) Returns aggregated feature flags for given project and current user (aggregates global, project group, project and user feature flags).
ProjectFeatureFlags	listProjectFeatureFlags(Project project) Returns project feature flags (only project scoped flags, use listFeatureFlags(Project) for aggregated flags from all scopes) for given project.
ProjectFeatureFlag	updateProjectFeatureFlag(ProjectFeatureFlag flag) Updates existing project feature flag.

Methods inherited from class com.gooddata.sdk.service.AbstractService

extractData

Methods inherited from class java.lang.Object

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

Field Detail

PROJECT_FEATURE_FLAG_TEMPLATE

protected static final org.springframework.web.util.UriTemplate PROJECT_FEATURE_FLAG_TEMPLATE

PROJECT_FEATURE_FLAGS_TEMPLATE

protected static final org.springframework.web.util.UriTemplate PROJECT_FEATURE_FLAGS_TEMPLATE

AGGREGATED_FEATURE_FLAGS_TEMPLATE

protected static final org.springframework.web.util.UriTemplate AGGREGATED_FEATURE_FLAGS_TEMPLATE

Constructor Detail

FeatureFlagService

public FeatureFlagService(org.springframework.web.client.RestTemplate restTemplate,
                          GoodDataSettings settings)

Constructs service for GoodData feature flags management.

Parameters:

restTemplate - RESTful HTTP Spring template

settings - settings

Method Detail

listFeatureFlags

public FeatureFlags listFeatureFlags(Project project)

Returns aggregated feature flags for given project and current user (aggregates global, project group, project and user feature flags). It doesn't matter whether feature flag is enabled or not, it'll be included in both cases.

Parameters:

project - project, cannot be null

Returns:

aggregated feature flags for given project and current user

listProjectFeatureFlags

public ProjectFeatureFlags listProjectFeatureFlags(Project project)

Returns project feature flags (only project scoped flags, use listFeatureFlags(Project) for aggregated flags from all scopes) for given project. It doesn't matter whether feature flag is enabled or not, it'll be included in both cases.

Parameters:

project - project, cannot be null

Returns:

list of all feature flags for given project

getProjectFeatureFlag

public ProjectFeatureFlag getProjectFeatureFlag(Project project,
                                                String featureFlagName)

Returns project feature flag (only project scoped flags, use listFeatureFlags(Project) for aggregated flags from all scopes) for given project by its unique name (aka "key"). It doesn't matter whether feature flag is enabled or not, it'll be included in both cases.

Parameters:

project - project, cannot be null

featureFlagName - unique name (key) of feature flag, cannot be empty

Returns:

feature flag for given project with given name (key)

createProjectFeatureFlag

public ProjectFeatureFlag createProjectFeatureFlag(Project project,
                                                   ProjectFeatureFlag flag)

Creates new feature flag for given project.

Usually, it doesn't make sense to create feature flag that is disabled because this is the same as having no feature flag at all.

Parameters:

project - project for which the feature flag should be created, cannot be null

flag - feature flag to be created, cannot be null

Returns:

created feature flag

updateProjectFeatureFlag

public ProjectFeatureFlag updateProjectFeatureFlag(ProjectFeatureFlag flag)

Updates existing project feature flag. Note that it doesn't make sense to update any other property than ProjectFeatureFlag.isEnabled().

Parameters:

flag - feature flag to be updated, cannot be null and it has to contain URI

Returns:

updated feature flag

deleteProjectFeatureFlag

public void deleteProjectFeatureFlag(ProjectFeatureFlag flag)

Deletes existing project feature flag.

Parameters:

flag - existing project feature flag with links set properly, cannot be null