com.launchdarkly.sdk.server.subsystems

Interface DataSourceUpdateSinkV2

All Superinterfaces:

TransactionalDataSourceUpdateSink

public interface DataSourceUpdateSinkV2
extends TransactionalDataSourceUpdateSink

Interfaces required by data source updates implementations in FDv2.

This interface extends TransactionalDataSourceUpdateSink to add status tracking and status update capabilities required for FDv2 data sources.

Since:

5.0.0

See Also:

TransactionalDataSourceUpdateSink, DataSource

Method Summary

Modifier and Type	Method and Description
DataStoreStatusProvider	getDataStoreStatusProvider() An object that provides status tracking for the data store, if applicable.
void	updateStatus(DataSourceStatusProvider.State newState, DataSourceStatusProvider.ErrorInfo newError) Informs the SDK of a change in the data source's status.

Methods inherited from interface com.launchdarkly.sdk.server.subsystems.TransactionalDataSourceUpdateSink

apply

Method Detail

getDataStoreStatusProvider

DataStoreStatusProvider getDataStoreStatusProvider()

An object that provides status tracking for the data store, if applicable.

This may be useful if the data source needs to be aware of storage problems that might require it to take some special action: for instance, if a database outage may have caused some data to be lost and therefore the data should be re-requested from LaunchDarkly.

Returns:

a DataStoreStatusProvider

updateStatus

void updateStatus(DataSourceStatusProvider.State newState,
                  DataSourceStatusProvider.ErrorInfo newError)

Informs the SDK of a change in the data source's status.

Data source implementations should use this method if they have any concept of being in a valid state, a temporarily disconnected state, or a permanently stopped state.

If newState is different from the previous state, and/or newError is non-null, the SDK will start returning the new status (adding a timestamp for the change) from DataSourceStatusProvider.getStatus(), and will trigger status change events to any registered listeners.

A special case is that if newState is DataSourceStatusProvider.State.INTERRUPTED, but the previous state was DataSourceStatusProvider.State.INITIALIZING, the state will remain at DataSourceStatusProvider.State.INITIALIZING because DataSourceStatusProvider.State.INTERRUPTED is only meaningful after a successful startup.

Parameters:

newState - the data source state

newError - information about a new error, if any

See Also:

DataSourceStatusProvider