Package com.launchdarkly.sdk.android

Class DataSystemComponents

java.lang.Object

com.launchdarkly.sdk.android.DataSystemComponents

public abstract class DataSystemComponents
extends Object

Factory methods for FDv2 data source components used with the DataSystemBuilder.

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

Most factory methods return a declarative InitializerEntry or SynchronizerEntry. Configure properties on the entry, then pass it to ConnectionModeBuilder.initializers(com.launchdarkly.sdk.android.integrations.InitializerEntry[]) or ConnectionModeBuilder.synchronizers(com.launchdarkly.sdk.android.integrations.SynchronizerEntry[]).

Example:

     LDConfig config = new LDConfig.Builder(AutoEnvAttributes.Enabled)
         .mobileKey("my-key")
         .dataSystem(
             Components.dataSystem()
                 .customizeConnectionMode(ConnectionMode.STREAMING,
                     DataSystemComponents.customMode()
                         .initializers(DataSystemComponents.pollingInitializer())
                         .synchronizers(
                             DataSystemComponents.streamingSynchronizer()
                                 .initialReconnectDelayMillis(500),
                             DataSystemComponents.pollingSynchronizer()
                                 .pollIntervalMillis(300_000))))
         .build();
 

See Also:

• DataSystemBuilder
• ConnectionModeBuilder

Method Summary

Modifier and Type	Method	Description
static AutomaticModeSwitchingConfig.Builder	automaticModeSwitching()	Returns a builder for configuring automatic connection mode switching in response to platform events (foreground/background and network availability).
static CacheInitializerEntry	cacheInitializer()	Returns an entry for the cache initializer used in default FDv2 pipelines.
static ConnectionModeBuilder	customMode()	Returns a builder for configuring a custom data pipeline for a connection mode.
static Map<ConnectionMode,ModeDefinition>	makeDefaultModeTable()	Produces the default mode table used by DataSystemBuilder.buildModeTable(boolean).
static PollingInitializerEntry	pollingInitializer()	Returns an entry for a polling initializer.
static PollingSynchronizerEntry	pollingSynchronizer()	Returns an entry for a polling synchronizer.
static StreamingSynchronizerEntry	streamingSynchronizer()	Returns an entry for a streaming synchronizer.

Methods inherited from class java.lang.Object

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

Method Details

pollingInitializer

public static PollingInitializerEntry pollingInitializer()

Returns an entry for a polling initializer.

A polling initializer makes a single poll request to obtain the initial feature flag data set.

Returns:

a polling initializer entry

cacheInitializer

public static CacheInitializerEntry cacheInitializer()

Returns an entry for the cache initializer used in default FDv2 pipelines.

Returns:

a cache initializer entry

pollingSynchronizer

public static PollingSynchronizerEntry pollingSynchronizer()

Returns an entry for a polling synchronizer.

A polling synchronizer periodically polls LaunchDarkly for feature flag updates. The poll interval can be configured via PollingSynchronizerEntry.pollIntervalMillis(int).

Returns:

a polling synchronizer entry

streamingSynchronizer

public static StreamingSynchronizerEntry streamingSynchronizer()

Returns an entry for a streaming synchronizer.

A streaming synchronizer maintains a persistent connection to LaunchDarkly and receives real-time feature flag updates. The initial reconnect delay can be configured via StreamingSynchronizerEntry.initialReconnectDelayMillis(int).

Returns:

a streaming synchronizer entry

makeDefaultModeTable

@NonNull
public static Map<ConnectionMode,ModeDefinition> makeDefaultModeTable()

Produces the default mode table used by DataSystemBuilder.buildModeTable(boolean). Defined here (rather than in DataSystemBuilder) because the FDv1 fallback synchronizer references package-private types that are not visible from the integrations package.

This method is public only for cross-package access within the SDK; it is not intended for use by application code.

automaticModeSwitching

public static AutomaticModeSwitchingConfig.Builder automaticModeSwitching()

Returns a builder for configuring automatic connection mode switching in response to platform events (foreground/background and network availability).

Pass the result of AutomaticModeSwitchingConfig.Builder.build() to DataSystemBuilder.automaticModeSwitching(AutomaticModeSwitchingConfig).

     Components.dataSystem()
         .automaticModeSwitching(
             DataSystemComponents.automaticModeSwitching()
                 .lifecycle(false)
                 .network(true)
                 .build())
 

For all-on or all-off behavior, you may use AutomaticModeSwitchingConfig.enabled() or AutomaticModeSwitchingConfig.disabled() instead of this builder.

Returns:

a builder for automatic mode switching (both lifecycle and network enabled by default)

See Also:

• AutomaticModeSwitchingConfig
• DataSystemBuilder.automaticModeSwitching(AutomaticModeSwitchingConfig)

customMode

public static ConnectionModeBuilder customMode()

Returns a builder for configuring a custom data pipeline for a connection mode.

Use this to specify which initializers and synchronizers should run when the SDK is operating in a particular ConnectionMode. Pass the result to DataSystemBuilder.customizeConnectionMode(ConnectionMode, ConnectionModeBuilder).

     LDConfig config = new LDConfig.Builder(AutoEnvAttributes.Enabled)
         .mobileKey("my-key")
         .dataSystem(
             Components.dataSystem()
                 .customizeConnectionMode(ConnectionMode.BACKGROUND,
                     DataSystemComponents.customMode()
                         .synchronizers(
                             DataSystemComponents.pollingSynchronizer()
                                 .pollIntervalMillis(21_600_000))))
         .build();
 

Returns:

a builder for configuring a custom connection mode pipeline

See Also:

• ConnectionModeBuilder
• DataSystemBuilder.customizeConnectionMode(ConnectionMode, ConnectionModeBuilder)