com.launchdarkly.sdk.server.integrations

Class DataSystemModes

java.lang.Object

com.launchdarkly.sdk.server.integrations.DataSystemModes

public final class DataSystemModes
extends java.lang.Object

A set of different data system modes which provide pre-configured DataSystemBuilders.

This class is not stable, and not subject to any backwards compatibility guarantees or semantic versioning. It is in early access. If you want access to this feature please join the EAP. https://launchdarkly.com/docs/sdk/features/data-saving-mode

This implementation is non-static to allow for easy usage with "Components". Where we can return an instance of this object, and the user can chain into their desired configuration.

Constructor Summary

Constructors

Constructor and Description
DataSystemModes()

Method Summary

Modifier and Type	Method and Description
DataSystemBuilder	custom() Custom returns a builder suitable for creating a custom data acquisition strategy.
DataSystemBuilder	daemon(ComponentConfigurer<DataStore> persistentStore) Configures the SDK to read from a persistent store integration that is populated by Relay Proxy or other SDKs.
DataSystemBuilder	defaultMode() Configure's LaunchDarkly's recommended flag data acquisition strategy.
DataSystemBuilder	persistentStore(ComponentConfigurer<DataStore> persistentStore) PersistentStore is similar to Default, with the addition of a persistent store integration.
DataSystemBuilder	polling() Configure the SDK to poll data instead of receiving real-time updates via a stream.
DataSystemBuilder	streaming() Configures the SDK to stream data without polling for the initial payload.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSystemModes

public DataSystemModes()

Method Detail

defaultMode

public DataSystemBuilder defaultMode()

Configure's LaunchDarkly's recommended flag data acquisition strategy.

Currently, it operates a two-phase method for getting data: first, it requests data from LaunchDarkly's global CDN. Then, it initiates a streaming connection to LaunchDarkly's Flag Delivery services to receive real-time updates. If the streaming connection is interrupted for an extended period of time, the SDK will automatically fall back to polling the global CDN for updates.

Example:

     LDConfig config = new LDConfig.Builder("my-sdk-key")
       .dataSystem(Components.dataSystem().defaultMode());
 

Returns:

a builder containing our default configuration

streaming

public DataSystemBuilder streaming()

Configures the SDK to stream data without polling for the initial payload.

This is not our recommended strategy, which is defaultMode(), but it may be suitable for some situations.

This configuration will not automatically fall back to polling, but it can be instructed by LaunchDarkly to fall back to polling in certain situations.

Example:

     LDConfig config = new LDConfig.Builder("my-sdk-key")
       .dataSystem(Components.dataSystem().streaming());
 

Returns:

a builder containing a primarily streaming configuration

polling

public DataSystemBuilder polling()

Configure the SDK to poll data instead of receiving real-time updates via a stream.

This is not our recommended strategy, which is defaultMode(), but it may be required for certain network configurations.

Example:

     LDConfig config = new LDConfig.Builder("my-sdk-key")
       .dataSystem(Components.dataSystem().polling());
 

Returns:

a builder containing a polling-only configuration

daemon

public DataSystemBuilder daemon(ComponentConfigurer<DataStore> persistentStore)

Configures the SDK to read from a persistent store integration that is populated by Relay Proxy or other SDKs. The SDK will not connect to LaunchDarkly. In this mode, the SDK never writes to the data store.

Example:

     LDConfig config = new LDConfig.Builder("my-sdk-key")
       .dataSystem(Components.dataSystem().daemon(persistentStore));
 

Parameters:

persistentStore - the persistent store configurer

Returns:

a builder which is configured for daemon mode

persistentStore

public DataSystemBuilder persistentStore(ComponentConfigurer<DataStore> persistentStore)

PersistentStore is similar to Default, with the addition of a persistent store integration. Before data has arrived from LaunchDarkly, the SDK is able to evaluate flags using data from the persistent store. Once fresh data is available, the SDK will no longer read from the persistent store, although it will keep it up to date.

Example:

     LDConfig config = new LDConfig.Builder("my-sdk-key")
       .dataSystem(Components.dataSystem()
         .persistentStore(Components.persistentDataStore(SomeDatabaseName.dataStore())));
 

Parameters:

persistentStore - the persistent store configurer

Returns:

a builder which is configured for persistent store mode

custom

public DataSystemBuilder custom()

Custom returns a builder suitable for creating a custom data acquisition strategy. You may configure how the SDK uses a Persistent Store, how the SDK obtains an initial set of data, and how the SDK keeps data up to date.

Example:

     LDConfig config = new LDConfig.Builder("my-sdk-key")
       .dataSystem(Components.dataSystem().custom()
         .initializers(DataSystemComponents.pollingInitializer())
         .synchronizers(DataSystemComponents.streamingSynchronizer(), DataSystemComponents.pollingSynchronizer())
         .fDv1FallbackSynchronizer(DataSystemComponents.fDv1Polling()));
 

Returns:

a builder without any base configuration