com.flagsmith

Class FlagsmithClient

java.lang.Object

com.flagsmith.FlagsmithClient

public class FlagsmithClient
extends Object

A client for Flagsmith API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlagsmithClient.Builder

Method Summary

Modifier and Type	Method and Description
FlagsmithCache	getCache() This method returns a Flagsmith cache object that encapsulates methods to manipulate the cache.
List<Flag>	getFeatureFlags() Get a list of existing Features for the given environment
List<Flag>	getFeatureFlags(FeatureUser user) Get a list of existing Features for the given environment and user
List<Flag>	getFeatureFlags(FeatureUser user, boolean doThrow) Get a list of existing Features for the given environment and user
String	getFeatureFlagValue(String featureId) Get Feature value (remote config) for given feature id.
String	getFeatureFlagValue(String featureId, FeatureUser user) Get Feature value (remote config) for given feature id and user
static String	getFeatureFlagValue(String featureId, FlagsAndTraits flagsAndTraits) Get Feature value (remote config) for given feature id and user
Trait	getTrait(FeatureUser user, String key) Get user Trait for given user identity and trait key.
static Trait	getTrait(FlagsAndTraits flagsAndTraits, String key) Get user Trait from a given FlagsAndTraits and trait key.
List<Trait>	getTraits(FeatureUser user, String... keys) Get a list of user Traits for user identity and trait keys
static List<Trait>	getTraits(FlagsAndTraits flagsAndTraits, String... keys) Get a list of user Traits for user identity and trait keys
FlagsAndTraits	getUserFlagsAndTraits(FeatureUser user) Get a list of existing user Traits and Flags for the given environment and identity user It fails silently if there is an error
FlagsAndTraits	getUserFlagsAndTraits(FeatureUser user, boolean doThrow) Get a list of existing user Traits and Flags for the given environment and identity user
boolean	hasFeatureFlag(String featureId) Check if Feature flag exist and is enabled
boolean	hasFeatureFlag(String featureId, FeatureUser user) Check if Feature flag exist and is enabled for given user
static boolean	hasFeatureFlag(String featureId, FlagsAndTraits flagsAndTraits) Check if Feature flag exist and is enabled in a FlagsAndTraits
List<Trait>	identifyUserWithTraits(FeatureUser user, List<Trait> traits) Create or update a list of user Traits for given user identity.
List<Trait>	identifyUserWithTraits(FeatureUser user, List<Trait> traits, boolean doThrow) Create or update a list of user Traits for given user identity.
static FlagsmithClient.Builder	newBuilder()
Trait	updateTrait(FeatureUser user, Trait toUpdate) Update user Trait for given user and Trait details.
Trait	updateTrait(FeatureUser user, Trait toUpdate, boolean doThrow) Update user Trait for given user and Trait details.

Methods inherited from class java.lang.Object

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

Method Detail

getFeatureFlags

public List<Flag> getFeatureFlags()

Get a list of existing Features for the given environment

Returns:

a list of feature flags

getFeatureFlags

public List<Flag> getFeatureFlags(FeatureUser user)

Get a list of existing Features for the given environment and user

Parameters:

user - a user in context

Returns:

a list of feature flags

getFeatureFlags

public List<Flag> getFeatureFlags(FeatureUser user,
                                  boolean doThrow)

Get a list of existing Features for the given environment and user

Parameters:

user - a user in context

doThrow - throw exceptions or fail silently

Returns:

a list of feature flags

hasFeatureFlag

public boolean hasFeatureFlag(String featureId)

Check if Feature flag exist and is enabled

Parameters:

featureId - an identifier for the feature

Returns:

true if feature flag exist and enabled, false otherwise

hasFeatureFlag

public boolean hasFeatureFlag(String featureId,
                              FeatureUser user)

Check if Feature flag exist and is enabled for given user

Parameters:

featureId - a unique feature name identifier

user - a user in context

Returns:

true if feature flag exist and enabled, false otherwise

hasFeatureFlag

public static boolean hasFeatureFlag(String featureId,
                                     FlagsAndTraits flagsAndTraits)

Check if Feature flag exist and is enabled in a FlagsAndTraits

Parameters:

featureId - a unique feature name identifier

flagsAndTraits - flags and traits object

Returns:

true if feature flag exist and enabled, false otherwise

getFeatureFlagValue

public String getFeatureFlagValue(String featureId)

Get Feature value (remote config) for given feature id.

Parameters:

featureId - a unique feature name identifier

Returns:

a value for the Feature or null if feature does not exist

getFeatureFlagValue

public String getFeatureFlagValue(String featureId,
                                  FeatureUser user)

Get Feature value (remote config) for given feature id and user

Parameters:

featureId - a unique feature name identifier

user - a user in context

Returns:

a value for the feature or null if does not exist

getFeatureFlagValue

public static String getFeatureFlagValue(String featureId,
                                         FlagsAndTraits flagsAndTraits)

Get Feature value (remote config) for given feature id and user

Parameters:

featureId - a unique feature name identifier

flagsAndTraits - flags and traits object

Returns:

a value for the feature or null if does not exist

getTrait

public Trait getTrait(FeatureUser user,
                      String key)

Get user Trait for given user identity and trait key.

Parameters:

key - a unique user trait key

user - a user in context

Returns:

a Trait object or null if does not exist

getTrait

public static Trait getTrait(FlagsAndTraits flagsAndTraits,
                             String key)

Get user Trait from a given FlagsAndTraits and trait key.

Parameters:

key - a unique user trait key

flagsAndTraits - flags and traits object

Returns:

a Trait object or null if does not exist

getTraits

public List<Trait> getTraits(FeatureUser user,
                             String... keys)

Get a list of user Traits for user identity and trait keys

Returns:

a list of user Trait

getTraits

public static List<Trait> getTraits(FlagsAndTraits flagsAndTraits,
                                    String... keys)

Get a list of user Traits for user identity and trait keys

Returns:

a list of user Trait

getUserFlagsAndTraits

public FlagsAndTraits getUserFlagsAndTraits(FeatureUser user)

Get a list of existing user Traits and Flags for the given environment and identity user It fails silently if there is an error

Parameters:

user - a user in context

Returns:

a list of user Traits and Flags or empty FlagsAndTraits

getUserFlagsAndTraits

public FlagsAndTraits getUserFlagsAndTraits(FeatureUser user,
                                            boolean doThrow)

Get a list of existing user Traits and Flags for the given environment and identity user

Parameters:

user - a user in context

doThrow - indicates if errors should throw an exception or fail silently

Returns:

a list of user Traits and Flags

updateTrait

public Trait updateTrait(FeatureUser user,
                         Trait toUpdate)

Update user Trait for given user and Trait details.

Parameters:

toUpdate - a user trait to update

user - a user in context

Returns:

a Trait object or null if does not exist

updateTrait

public Trait updateTrait(FeatureUser user,
                         Trait toUpdate,
                         boolean doThrow)

Update user Trait for given user and Trait details.

Parameters:

toUpdate - a user trait to update

user - a user in context

doThrow - throw exceptions or fail silently

Returns:

a Trait object or null if does not exist

identifyUserWithTraits

public List<Trait> identifyUserWithTraits(FeatureUser user,
                                          List<Trait> traits)

Create or update a list of user Traits for given user identity.

Please note this will override any existing identity with given list.

Parameters:

user - a user in context

traits - a list of Trait object to be created or updated

Returns:

a list of added Trait objects

identifyUserWithTraits

public List<Trait> identifyUserWithTraits(FeatureUser user,
                                          List<Trait> traits,
                                          boolean doThrow)

Create or update a list of user Traits for given user identity.

Please note this will override any existing identity with given list.

Parameters:

user - a user in context

traits - a list of Trait object to be created or updated

doThrow - throw exceptions or fail silently

Returns:

a list of added Trait objects

getCache

public FlagsmithCache getCache()

This method returns a Flagsmith cache object that encapsulates methods to manipulate the cache.

Returns:

if enabled - a flagsmith cache object that exposes methods to manipulate the cache, otherwise null.

newBuilder

public static FlagsmithClient.Builder newBuilder()