com.atlassian.confluence.featureflag

Interface FeatureFlagServiceClient

All Superinterfaces:

FeatureFlagServiceTestClient

All Known Implementing Classes:

SystemPropertyFeatureFlagServiceClient

public interface FeatureFlagServiceClient
extends FeatureFlagServiceTestClient

Confluence wrapper around the Feature Flag Service. Feature requests are bound to a tenant context which is scoped to the currently active Work Context. It provides methods to sensibly default the feature flag state when the feature specified is not defined or the remote feature flag service is unavailable.

Method Summary

Modifier and Type	Method and Description
default Map<String,Boolean>	getAllFeatureKeys() This method is used to evaluate all the feature flags in the configured environment.
boolean	isExperimentalFeatureEnabled(String featureKey) Evaluate the state for a given experimental feature flag that will query the Atlassian Experiments Service (AES).
boolean	isExperimentalFeatureEnabled(String featureKey, boolean defaultValue, com.atlassian.featureflag.client.api.FeatureFlagContext additionalContext) Behaves the same as isExperimentalFeatureEnabled(String) but allows for a default value to be returned if the feature flag service cannot be contacted and additional context for customization.
default boolean	isFeatureEnabled(String featureKey) Evaluate the state for a given feature flag.
boolean	isFeatureEnabled(String featureKey, boolean defaultValue) Evaluate the state of a feature flag.
boolean	isFeatureEnabled(String featureKey, boolean defaultValue, com.atlassian.featureflag.client.api.FeatureFlagContext additionalContext) Evaluate the state of a feature flag.
default boolean	isVertigoFeatureEnabled(String featureKey) Behaves the same as isFeatureEnabled unless the system is running in vertigo mode in which case the feature flag will always evaluate to true.
boolean	isVertigoFeatureEnabled(String featureKey, boolean defaultValue) Behaves the same as isFeatureEnabled unless the system is running in vertigo mode in which case the feature flag will always evaluate to true.
boolean	isVertigoFeatureEnabled(String featureKey, boolean defaultValue, com.atlassian.featureflag.client.api.FeatureFlagContext additionalContext) Behaves the same as isFeatureEnabled unless the system is running in vertigo mode in which case the feature flag will always evaluate to true.

Methods inherited from interface com.atlassian.confluence.featureflag.FeatureFlagServiceTestClient

setFlagValue

Method Detail

isFeatureEnabled

default boolean isFeatureEnabled(String featureKey)

Evaluate the state for a given feature flag. If the flag isn't present in the FFS or the FFS is unreachable then the flag will evaluate to false.

Parameters:

featureKey -

Returns:

whether the feature is enabled or not

isFeatureEnabled

boolean isFeatureEnabled(String featureKey,
                         boolean defaultValue)

Evaluate the state of a feature flag. If the flag doesn't exist on the FFS or the FFS is unreachable then the default value parameter will be returned.

Parameters:

featureKey -

defaultValue -

Returns:

whether the feature is enabled or not

isFeatureEnabled

boolean isFeatureEnabled(String featureKey,
                         boolean defaultValue,
                         com.atlassian.featureflag.client.api.FeatureFlagContext additionalContext)

Evaluate the state of a feature flag. If the flag doesn't exist on the FFS or the FFS is unreachable then the default value parameter will be returned.

Parameters:

featureKey -

defaultValue -

additionalContext - Additional context information to be passed to the FFS

Returns:

whether the feature is enabled or not

isExperimentalFeatureEnabled

boolean isExperimentalFeatureEnabled(String featureKey)

Evaluate the state for a given experimental feature flag that will query the Atlassian Experiments Service (AES). If the flag isn't present in the FFS or the required services (AES and FFS) are unreachable, then the flag will evaluate to false.

Parameters:

featureKey -

Returns:

whether the feature is enabled or not

isExperimentalFeatureEnabled

boolean isExperimentalFeatureEnabled(String featureKey,
                                     boolean defaultValue,
                                     com.atlassian.featureflag.client.api.FeatureFlagContext additionalContext)

Behaves the same as isExperimentalFeatureEnabled(String) but allows for a default value to be returned if the feature flag service cannot be contacted and additional context for customization.

Parameters:

featureKey -

defaultValue -

additionalContext - Additional context information to be passed to the FFS

Returns:

whether the feature is enabled or not

isVertigoFeatureEnabled

default boolean isVertigoFeatureEnabled(String featureKey)

Behaves the same as isFeatureEnabled unless the system is running in vertigo mode in which case the feature flag will always evaluate to true.

Parameters:

featureKey -

Returns:

whether the feature is enabled or not

isVertigoFeatureEnabled

boolean isVertigoFeatureEnabled(String featureKey,
                                boolean defaultValue)

Behaves the same as isFeatureEnabled unless the system is running in vertigo mode in which case the feature flag will always evaluate to true.

Parameters:

featureKey -

defaultValue -

Returns:

whether the feature is enabled or not

isVertigoFeatureEnabled

boolean isVertigoFeatureEnabled(String featureKey,
                                boolean defaultValue,
                                com.atlassian.featureflag.client.api.FeatureFlagContext additionalContext)

Behaves the same as isFeatureEnabled unless the system is running in vertigo mode in which case the feature flag will always evaluate to true.

Parameters:

featureKey -

defaultValue -

additionalContext - Additional context information to be passed to the FFS

Returns:

whether the feature is enabled or not

getAllFeatureKeys

default Map<String,Boolean> getAllFeatureKeys()

This method is used to evaluate all the feature flags in the configured environment. The returned result is a map from feature key to evaluated value.

Returns:

A feature flag key and evaluate value map.