Package com.launchdarkly.sdk.server.interfaces

The package for interfaces that allow customization of LaunchDarkly components, and interfaces to other advanced SDK features.

Most applications will not need to refer to these types. You will use them if you are creating a plug-in component, such as a database integration, or if you use advanced features such as LDClientInterface.getDataStoreStatusProvider() or LDClientInterface.getFlagTracker().

Interface Summary

Interface	Description
BigSegmentStore	Interface for a read-only data store that allows querying of user membership in Big Segments.
BigSegmentStoreFactory	Interface for a factory that creates some implementation of BigSegmentStore.
BigSegmentStoreStatusProvider	An interface for querying the status of a Big Segment store.
BigSegmentStoreStatusProvider.StatusListener	Interface for receiving Big Segment status change notifications.
BigSegmentStoreTypes.Membership	A query interface returned by BigSegmentStore.getMembership(String).
ClientContext	Context information provided by the LDClient when creating components.
DataSource	Interface for an object that receives updates to feature flags, user segments, and anything else that might come from LaunchDarkly, and passes them to a DataStore.
DataSourceFactory	Interface for a factory that creates some implementation of DataSource.
DataSourceStatusProvider	An interface for querying the status of a DataSource.
DataSourceStatusProvider.StatusListener	Interface for receiving status change notifications.
DataSourceUpdates	Interface that a data source implementation will use to push data into the SDK.
DataStore	Interface for a data store that holds feature flags and related data received by the SDK.
DataStoreFactory	Interface for a factory that creates some implementation of DataStore.
DataStoreStatusProvider	An interface for querying the status of a persistent data store.
DataStoreStatusProvider.StatusListener	Interface for receiving status change notifications.
DataStoreUpdates	Interface that a data store implementation can use to report information back to the SDK.
DiagnosticDescription	Optional interface for components to describe their own configuration.
EventProcessor	Interface for an object that can send or store analytics events.
EventProcessorFactory	Interface for a factory that creates some implementation of EventProcessor.
EventSender	Interface for a component that can deliver preformatted event data.
EventSenderFactory	Interface for a factory that creates some implementation of EventSender.
FlagChangeListener	An event listener that is notified when a feature flag's configuration has changed.
FlagTracker	An interface for tracking changes in feature flag configurations.
FlagValueChangeListener	An event listener that is notified when a feature flag's value has changed for a specific user.
HttpAuthentication	Represents a supported method of HTTP authentication, including proxy authentication.
HttpConfiguration	Encapsulates top-level HTTP configuration that applies to all SDK components.
HttpConfigurationFactory	Interface for a factory that creates an HttpConfiguration.
LDClientInterface	This interface defines the public methods of LDClient.
LoggingConfiguration	Encapsulates the SDK's general logging configuration.
LoggingConfigurationFactory	Interface for a factory that creates a LoggingConfiguration.
PersistentDataStore	Interface for a data store that holds feature flags and related data in a serialized form.
PersistentDataStoreFactory	Interface for a factory that creates some implementation of a persistent data store.

Class Summary

Class	Description
ApplicationInfo	Encapsulates the SDK's application metadata.
BasicConfiguration	The most basic properties of the SDK client that are available to all SDK component factories.
BigSegmentsConfiguration	Encapsulates the SDK's configuration with regard to Big Segments.
BigSegmentStoreStatusProvider.Status	Information about the status of a Big Segment store, provided by BigSegmentStoreStatusProvider
BigSegmentStoreTypes	Types that are used by the BigSegmentStore interface.
BigSegmentStoreTypes.StoreMetadata	Values returned by BigSegmentStore.getMetadata().
DataSourceStatusProvider.ErrorInfo	A description of an error condition that the data source encountered.
DataSourceStatusProvider.Status	Information about the data source's status and about the last status change.
DataStoreStatusProvider.CacheStats	A snapshot of cache statistics.
DataStoreStatusProvider.Status	Information about a status change.
DataStoreTypes	Types that are used by the DataStore interface.
DataStoreTypes.DataKind	Represents a separately namespaced collection of storable data items.
DataStoreTypes.FullDataSet<TDescriptor>	Wrapper for a set of storable items being passed to a data store.
DataStoreTypes.ItemDescriptor	A versioned item (or placeholder) storable in a DataStore.
DataStoreTypes.KeyedItems<TDescriptor>	Wrapper for a set of storable items being passed to a data store, within a single DataStoreTypes.DataKind.
DataStoreTypes.SerializedItemDescriptor	A versioned item (or placeholder) storable in a PersistentDataStore.
Event	Base class for all analytics events that are generated by the client.
Event.AliasEvent	An event generated by aliasing users
Event.Custom	A custom event created with LDClientInterface.track(String, LDUser) or one of its overloads.
Event.FeatureRequest	An event generated by a feature flag evaluation.
Event.Identify	An event created with LDClientInterface.identify(LDUser).
Event.Index	An event created internally by the SDK to hold user data that may be referenced by multiple events.
EventSender.Result	Encapsulates the results of a call to EventSender.sendEventData(EventDataKind, String, int, URI).
FlagChangeEvent	Parameter class used with FlagChangeListener.
FlagValueChangeEvent	Parameter class used with FlagValueChangeListener.
HttpAuthentication.Challenge	Properties of an HTTP authentication challenge.
ServiceEndpoints	Specifies the base service URIs used by SDK components.

Enum Summary

Enum	Description
DataSourceStatusProvider.ErrorKind	An enumeration describing the general type of an error reported in DataSourceStatusProvider.ErrorInfo.
DataSourceStatusProvider.State	An enumeration of possible values for DataSourceStatusProvider.Status.getState().
EventSender.EventDataKind	Enumerated values corresponding to different kinds of event data.

Exception Summary

Exception	Description
SerializationException	General exception class for all errors in serializing or deserializing JSON.