public interface LDClientInterface
extends java.io.Closeable
LDClient
.
Applications will normally interact directly with LDClient
, and must use its constructor to
initialize the SDK, but being able to refer to it indirectly via an interface may be helpul in test
scenarios (mocking) or for some dependency injection frameworks.
Modifier and Type | Method and Description |
---|---|
void |
alias(LDUser user,
LDUser previousUser)
Associates two users for analytics purposes.
|
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.
|
double |
doubleVariation(java.lang.String featureKey,
LDUser user,
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.
|
DataSourceStatusProvider |
getDataSourceStatusProvider()
Returns an interface for tracking the status of the data source.
|
DataStoreStatusProvider |
getDataStoreStatusProvider()
Returns an interface for tracking the status of a persistent data store.
|
FlagTracker |
getFlagTracker()
Returns an interface for tracking changes in feature flag configurations.
|
void |
identify(LDUser user)
Registers the user.
|
int |
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 |
isInitialized()
Tests whether the client is ready to be used.
|
boolean |
isOffline()
Returns true if the client is in offline mode.
|
LDValue |
jsonValueVariation(java.lang.String featureKey,
LDUser user,
LDValue defaultValue)
Calculates the
LDValue value of a feature flag for a given user. |
EvaluationDetail<LDValue> |
jsonValueVariationDetail(java.lang.String featureKey,
LDUser user,
LDValue defaultValue)
Calculates the
LDValue value of a feature flag for a given user. |
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 |
trackData(java.lang.String eventName,
LDUser user,
LDValue data)
Tracks that a user performed an event, and provides additional custom data.
|
void |
trackMetric(java.lang.String eventName,
LDUser user,
LDValue data,
double metricValue)
Tracks that a user performed an event, and provides an additional numeric value for custom metrics.
|
java.lang.String |
version()
The current version string of the SDK.
|
boolean isInitialized()
void track(java.lang.String eventName, LDUser user)
To add custom data to the event, use trackData(String, LDUser, LDValue)
.
eventName
- the name of the eventuser
- the user that performed the eventvoid trackData(java.lang.String eventName, LDUser user, LDValue data)
eventName
- the name of the eventuser
- the user that performed the eventdata
- an LDValue
containing additional data associated with the eventvoid trackMetric(java.lang.String eventName, LDUser user, LDValue data, double metricValue)
eventName
- the name of the eventuser
- the user that performed the eventdata
- an LDValue
containing additional data associated with the event; if not applicable,
you may pass either null
or LDValue.ofNull()
metricValue
- a numeric value used by the LaunchDarkly experimentation feature in numeric custom
metrics. Can be omitted if this event is used by only non-numeric metrics. This field will also be
returned as part of the custom event for Data Export.void identify(LDUser user)
user
- the user to registerFeatureFlagsState allFlagsState(LDUser user, FlagsStateOption... options)
The most common use case for this method is to bootstrap a set of client-side feature flags from a back-end service.
user
- the end user requesting the feature flagsoptions
- optional FlagsStateOption
values affecting how the state is computed - for
instance, to filter the set of flags to only include the client-side-enabled onesFeatureFlagsState
object (will never be null; see FeatureFlagsState.isValid()
boolean boolVariation(java.lang.String featureKey, LDUser user, boolean defaultValue)
featureKey
- the unique key for the feature flaguser
- the end user requesting the flagdefaultValue
- the default value of the flagdefaultValue
if the flag is disabled in the LaunchDarkly control panelint intVariation(java.lang.String featureKey, LDUser user, int defaultValue)
If the flag variation has a numeric value that is not an integer, it is rounded toward zero (truncated).
featureKey
- the unique key for the feature flaguser
- the end user requesting the flagdefaultValue
- the default value of the flagdefaultValue
if the flag is disabled in the LaunchDarkly control paneldouble doubleVariation(java.lang.String featureKey, LDUser user, double defaultValue)
featureKey
- the unique key for the feature flaguser
- the end user requesting the flagdefaultValue
- the default value of the flagdefaultValue
if the flag is disabled in the LaunchDarkly control paneljava.lang.String stringVariation(java.lang.String featureKey, LDUser user, java.lang.String defaultValue)
featureKey
- the unique key for the feature flaguser
- the end user requesting the flagdefaultValue
- the default value of the flagdefaultValue
if the flag is disabled in the LaunchDarkly control panelLDValue jsonValueVariation(java.lang.String featureKey, LDUser user, LDValue defaultValue)
LDValue
value of a feature flag for a given user.featureKey
- the unique key for the feature flaguser
- the end user requesting the flagdefaultValue
- the default value of the flagdefaultValue
if the flag is disabled in the LaunchDarkly control panel;
will never be a null reference, but may be LDValue.ofNull()
EvaluationDetail<java.lang.Boolean> boolVariationDetail(java.lang.String featureKey, LDUser user, boolean defaultValue)
reason
property in the result will also be included in
analytics events, if you are capturing detailed event data for this flag.featureKey
- the unique key for the feature flaguser
- the end user requesting the flagdefaultValue
- the default value of the flagEvaluationDetail
objectEvaluationDetail<java.lang.Integer> intVariationDetail(java.lang.String featureKey, LDUser user, int defaultValue)
reason
property in the result will also be included in
analytics events, if you are capturing detailed event data for this flag.
If the flag variation has a numeric value that is not an integer, it is rounded toward zero (truncated).
featureKey
- the unique key for the feature flaguser
- the end user requesting the flagdefaultValue
- the default value of the flagEvaluationDetail
objectEvaluationDetail<java.lang.Double> doubleVariationDetail(java.lang.String featureKey, LDUser user, double defaultValue)
reason
property in the result will also be included in
analytics events, if you are capturing detailed event data for this flag.featureKey
- the unique key for the feature flaguser
- the end user requesting the flagdefaultValue
- the default value of the flagEvaluationDetail
objectEvaluationDetail<java.lang.String> stringVariationDetail(java.lang.String featureKey, LDUser user, java.lang.String defaultValue)
reason
property in the result will also be included in
analytics events, if you are capturing detailed event data for this flag.featureKey
- the unique key for the feature flaguser
- the end user requesting the flagdefaultValue
- the default value of the flagEvaluationDetail
objectEvaluationDetail<LDValue> jsonValueVariationDetail(java.lang.String featureKey, LDUser user, LDValue defaultValue)
LDValue
value of a feature flag for a given user.featureKey
- the unique key for the feature flaguser
- the end user requesting the flagdefaultValue
- the default value of the flagEvaluationDetail
objectboolean isFlagKnown(java.lang.String featureKey)
featureKey
- the unique key for the feature flagvoid close() throws java.io.IOException
close
in interface java.lang.AutoCloseable
close
in interface java.io.Closeable
java.io.IOException
- if an exception is thrown by one of the underlying network servicesvoid flush()
boolean isOffline()
FlagTracker getFlagTracker()
The FlagTracker
contains methods for requesting notifications about feature flag changes using
an event listener model.
FlagTracker
DataSourceStatusProvider getDataSourceStatusProvider()
The data source is the mechanism that the SDK uses to get feature flag configurations, such as a
streaming connection (the default) or poll requests. The DataSourceStatusProvider
has methods
for checking whether the data source is (as far as the SDK knows) currently operational and tracking
changes in this status.
DataSourceStatusProvider
DataStoreStatusProvider getDataStoreStatusProvider()
The DataStoreStatusProvider
has methods for checking whether the data store is (as far as the
SDK knows) currently operational, tracking changes in this status, and getting cache statistics. These
are only relevant for a persistent data store; if you are using an in-memory data store, then this
method will return a stub object that provides no information.
DataStoreStatusProvider
java.lang.String secureModeHash(LDUser user)
user
- the user to be hashed along with the SDK keyvoid alias(LDUser user, LDUser previousUser)
user
- the newly identified user.previousUser
- the previously identified user.java.lang.String version()