com.launchdarkly.client

Interface LDClientInterface

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

LDClient

public interface LDClientInterface
extends java.io.Closeable

This interface defines the public methods of LDClient.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,com.google.gson.JsonElement>	allFlags(LDUser user) Deprecated. Use allFlagsState(com.launchdarkly.client.LDUser, com.launchdarkly.client.FlagsStateOption...) instead. Current versions of the client-side SDK will not generate analytics events correctly if you pass the result of allFlags().
FeatureFlagsState	allFlagsState(LDUser user, FlagsStateOption... options) Returns an object that encapsulates the state of all feature flags for a given user, including the flag values and also metadata that can be used on the front end.
boolean	boolVariation(java.lang.String featureKey, LDUser user, boolean defaultValue) Calculates the value of a feature flag for a given user.
EvaluationDetail<java.lang.Boolean>	boolVariationDetail(java.lang.String featureKey, LDUser user, boolean defaultValue) Calculates the value of a feature flag for a given user, and returns an object that describes the way the value was determined.
void	close() Closes the LaunchDarkly client event processing thread.
java.lang.Double	doubleVariation(java.lang.String featureKey, LDUser user, java.lang.Double defaultValue) Calculates the floating point numeric value of a feature flag for a given user.
EvaluationDetail<java.lang.Double>	doubleVariationDetail(java.lang.String featureKey, LDUser user, double defaultValue) Calculates the value of a feature flag for a given user, and returns an object that describes the way the value was determined.
void	flush() Flushes all pending events.
void	identify(LDUser user) Registers the user.
boolean	initialized()
java.lang.Integer	intVariation(java.lang.String featureKey, LDUser user, int defaultValue) Calculates the integer value of a feature flag for a given user.
EvaluationDetail<java.lang.Integer>	intVariationDetail(java.lang.String featureKey, LDUser user, int defaultValue) Calculates the value of a feature flag for a given user, and returns an object that describes the way the value was determined.
boolean	isFlagKnown(java.lang.String featureKey) Returns true if the specified feature flag currently exists.
boolean	isOffline() Returns true if the client is in offline mode.
com.google.gson.JsonElement	jsonVariation(java.lang.String featureKey, LDUser user, com.google.gson.JsonElement defaultValue) Calculates the JsonElement value of a feature flag for a given user.
EvaluationDetail<com.google.gson.JsonElement>	jsonVariationDetail(java.lang.String featureKey, LDUser user, com.google.gson.JsonElement defaultValue) Calculates the value of a feature flag for a given user, and returns an object that describes the way the value was determined.
java.lang.String	secureModeHash(LDUser user) For more info: https://github.com/launchdarkly/js-client#secure-mode
java.lang.String	stringVariation(java.lang.String featureKey, LDUser user, java.lang.String defaultValue) Calculates the String value of a feature flag for a given user.
EvaluationDetail<java.lang.String>	stringVariationDetail(java.lang.String featureKey, LDUser user, java.lang.String defaultValue) Calculates the value of a feature flag for a given user, and returns an object that describes the way the value was determined.
void	track(java.lang.String eventName, LDUser user) Tracks that a user performed an event.
void	track(java.lang.String eventName, LDUser user, com.google.gson.JsonElement data) Tracks that a user performed an event.
java.lang.String	version()

Method Detail

initialized

boolean initialized()

track

void track(java.lang.String eventName,
           LDUser user,
           com.google.gson.JsonElement data)

Tracks that a user performed an event.

Parameters:

eventName - the name of the event

user - the user that performed the event

data - a JSON object containing additional data associated with the event

track

void track(java.lang.String eventName,
           LDUser user)

Tracks that a user performed an event.

Parameters:

eventName - the name of the event

user - the user that performed the event

identify

void identify(LDUser user)

Registers the user.

Parameters:

user - the user to register

allFlags

@Deprecated
java.util.Map<java.lang.String,com.google.gson.JsonElement> allFlags(LDUser user)

Deprecated. Use allFlagsState(com.launchdarkly.client.LDUser, com.launchdarkly.client.FlagsStateOption...) instead. Current versions of the client-side SDK will not generate analytics events correctly if you pass the result of allFlags().

Returns a map from feature flag keys to JsonElement feature flag values for a given user. If the result of a flag's evaluation would have returned the default variation, it will have a null entry in the map. If the client is offline, has not been initialized, or a null user or user with null/empty user key a null map will be returned. This method will not send analytics events back to LaunchDarkly.

The most common use case for this method is to bootstrap a set of client-side feature flags from a back-end service.

Parameters:

user - the end user requesting the feature flags

Returns:

a map from feature flag keys to JsonElement for the specified user

allFlagsState

FeatureFlagsState allFlagsState(LDUser user,
                                FlagsStateOption... options)

Returns an object that encapsulates the state of all feature flags for a given user, including the flag values and also metadata that can be used on the front end. This method does not send analytics events back to LaunchDarkly.

The most common use case for this method is to bootstrap a set of client-side feature flags from a back-end service.

Parameters:

user - the end user requesting the feature flags

options - optional FlagsStateOption values affecting how the state is computed - for instance, to filter the set of flags to only include the client-side-enabled ones

Returns:

a FeatureFlagsState object (will never be null; see FeatureFlagsState.isValid()

Since:

4.3.0

boolVariation

boolean boolVariation(java.lang.String featureKey,
                      LDUser user,
                      boolean defaultValue)

Calculates the value of a feature flag for a given user.

Parameters:

featureKey - the unique key for the feature flag

user - the end user requesting the flag

defaultValue - the default value of the flag

Returns:

whether or not the flag should be enabled, or defaultValue if the flag is disabled in the LaunchDarkly control panel

intVariation

java.lang.Integer intVariation(java.lang.String featureKey,
                               LDUser user,
                               int defaultValue)

Calculates the integer value of a feature flag for a given user.

Parameters:

featureKey - the unique key for the feature flag

user - the end user requesting the flag

defaultValue - the default value of the flag

Returns:

the variation for the given user, or defaultValue if the flag is disabled in the LaunchDarkly control panel

doubleVariation

java.lang.Double doubleVariation(java.lang.String featureKey,
                                 LDUser user,
                                 java.lang.Double defaultValue)

Calculates the floating point numeric value of a feature flag for a given user.

Parameters:

featureKey - the unique key for the feature flag

user - the end user requesting the flag

defaultValue - the default value of the flag

Returns:

the variation for the given user, or defaultValue if the flag is disabled in the LaunchDarkly control panel

stringVariation

java.lang.String stringVariation(java.lang.String featureKey,
                                 LDUser user,
                                 java.lang.String defaultValue)

Calculates the String value of a feature flag for a given user.

Parameters:

featureKey - the unique key for the feature flag

user - the end user requesting the flag

defaultValue - the default value of the flag

Returns:

the variation for the given user, or defaultValue if the flag is disabled in the LaunchDarkly control panel

jsonVariation

com.google.gson.JsonElement jsonVariation(java.lang.String featureKey,
                                          LDUser user,
                                          com.google.gson.JsonElement defaultValue)

Calculates the JsonElement value of a feature flag for a given user.

Parameters:

featureKey - the unique key for the feature flag

user - the end user requesting the flag

defaultValue - the default value of the flag

Returns:

the variation for the given user, or defaultValue if the flag is disabled in the LaunchDarkly control panel

boolVariationDetail

EvaluationDetail<java.lang.Boolean> boolVariationDetail(java.lang.String featureKey,
                                                        LDUser user,
                                                        boolean defaultValue)

Calculates the value of a feature flag for a given user, and returns an object that describes the way the value was determined. The reason property in the result will also be included in analytics events, if you are capturing detailed event data for this flag.

Parameters:

featureKey - the unique key for the feature flag

user - the end user requesting the flag

defaultValue - the default value of the flag

Returns:

an EvaluationDetail object

Since:

2.3.0

intVariationDetail

EvaluationDetail<java.lang.Integer> intVariationDetail(java.lang.String featureKey,
                                                       LDUser user,
                                                       int defaultValue)

Calculates the value of a feature flag for a given user, and returns an object that describes the way the value was determined. The reason property in the result will also be included in analytics events, if you are capturing detailed event data for this flag.

Parameters:

featureKey - the unique key for the feature flag

user - the end user requesting the flag

defaultValue - the default value of the flag

Returns:

an EvaluationDetail object

Since:

2.3.0

doubleVariationDetail

EvaluationDetail<java.lang.Double> doubleVariationDetail(java.lang.String featureKey,
                                                         LDUser user,
                                                         double defaultValue)

Calculates the value of a feature flag for a given user, and returns an object that describes the way the value was determined. The reason property in the result will also be included in analytics events, if you are capturing detailed event data for this flag.

Parameters:

featureKey - the unique key for the feature flag

user - the end user requesting the flag

defaultValue - the default value of the flag

Returns:

an EvaluationDetail object

Since:

2.3.0

stringVariationDetail

EvaluationDetail<java.lang.String> stringVariationDetail(java.lang.String featureKey,
                                                         LDUser user,
                                                         java.lang.String defaultValue)

Calculates the value of a feature flag for a given user, and returns an object that describes the way the value was determined. The reason property in the result will also be included in analytics events, if you are capturing detailed event data for this flag.

Parameters:

featureKey - the unique key for the feature flag

user - the end user requesting the flag

defaultValue - the default value of the flag

Returns:

an EvaluationDetail object

Since:

2.3.0

jsonVariationDetail

EvaluationDetail<com.google.gson.JsonElement> jsonVariationDetail(java.lang.String featureKey,
                                                                  LDUser user,
                                                                  com.google.gson.JsonElement defaultValue)

Calculates the value of a feature flag for a given user, and returns an object that describes the way the value was determined. The reason property in the result will also be included in analytics events, if you are capturing detailed event data for this flag.

Parameters:

featureKey - the unique key for the feature flag

user - the end user requesting the flag

defaultValue - the default value of the flag

Returns:

an EvaluationDetail object

Since:

2.3.0

isFlagKnown

boolean isFlagKnown(java.lang.String featureKey)

Returns true if the specified feature flag currently exists.

Parameters:

featureKey - the unique key for the feature flag

Returns:

true if the flag exists

close

void close()
    throws java.io.IOException

Closes the LaunchDarkly client event processing thread. This should only be called on application shutdown.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException - if an exception is thrown by one of the underlying network services

flush

void flush()

Flushes all pending events.

isOffline

boolean isOffline()

Returns true if the client is in offline mode.

Returns:

whether the client is in offline mode

secureModeHash

java.lang.String secureModeHash(LDUser user)

For more info: https://github.com/launchdarkly/js-client#secure-mode

Parameters:

user - the user to be hashed along with the SDK key

Returns:

the hash, or null if the hash could not be calculated

version

java.lang.String version()