Components (launchdarkly-java-server-sdk 4.14.2 API)

java.lang.Object
- com.launchdarkly.client.Components

```
public abstract class Components
extends java.lang.Object
```
Provides configurable factories for the standard implementations of LaunchDarkly component interfaces.
Some of the configuration options in LDConfig.Builder affect the entire SDK, but others are specific to one area of functionality, such as how the SDK receives feature flag updates or processes analytics events. For the latter, the standard way to specify a configuration is to call one of the static methods in Components (such as streamingDataSource()), apply any desired configuration change to the object that that method returns (such as StreamingDataSourceBuilder.initialReconnectDelayMillis(long), and then use the corresponding method in LDConfig.Builder (such as LDConfig.Builder.dataSource(UpdateProcessorFactory)) to use that configured component in the SDK.

Since:

4.0.0

Constructor Summary

Constructors
Constructor and Description

Components()

Constructors
Constructor and Description
`Components()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static EventProcessorFactory`	`defaultEventProcessor()` Deprecated. Use `sendEvents()` or `noEvents()`.
`static UpdateProcessorFactory`	`defaultUpdateProcessor()` Deprecated. Use `streamingDataSource()`, `pollingDataSource()`, or `externalUpdatesOnly()`.
`static UpdateProcessorFactory`	`externalUpdatesOnly()` Returns a configuration object that disables a direct connection with LaunchDarkly for feature flag updates.
`static HttpAuthentication`	`httpBasicAuthentication(java.lang.String username, java.lang.String password)` Configures HTTP basic authentication, for use with a proxy server.
`static HttpConfigurationBuilder`	`httpConfiguration()` Returns a configurable factory for the SDK's networking configuration.
`static FeatureStoreFactory`	`inMemoryDataStore()` Returns a configuration object for using the default in-memory implementation of a data store.
`static FeatureStoreFactory`	`inMemoryFeatureStore()` Deprecated. Use `inMemoryDataStore()`.
`static EventProcessorFactory`	`noEvents()` Returns a configuration object that disables analytics events.
`static EventProcessorFactory`	`nullEventProcessor()` Deprecated. Use `noEvents()`.
`static UpdateProcessorFactory`	`nullUpdateProcessor()` Deprecated. Use `externalUpdatesOnly()`.
`static PersistentDataStoreBuilder`	`persistentDataStore(PersistentDataStoreFactory storeFactory)` Returns a configuration builder for some implementation of a persistent data store.
`static PollingDataSourceBuilder`	`pollingDataSource()` Returns a configurable factory for using polling mode to get feature flag data.
`static RedisFeatureStoreBuilder`	`redisFeatureStore()` Deprecated. Use `persistentDataStore(PersistentDataStoreFactory)` with `Redis.dataStore()`.
`static RedisFeatureStoreBuilder`	`redisFeatureStore(java.net.URI redisUri)` Deprecated. Use `persistentDataStore(PersistentDataStoreFactory)` with `Redis.dataStore()` and `RedisDataStoreBuilder.uri(URI)`.
`static EventProcessorBuilder`	`sendEvents()` Returns a configuration builder for analytics event delivery.
`static StreamingDataSourceBuilder`	`streamingDataSource()` Returns a configurable factory for using streaming mode to get feature flag data.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Components
```
public Components()
```
- Method Detail
  - inMemoryDataStore
```
public static FeatureStoreFactory inMemoryDataStore()
```
    Returns a configuration object for using the default in-memory implementation of a data store.
    Since it is the default, you do not normally need to call this method, unless you need to create a data store instance for testing purposes.
    Note that the interface is still named FeatureStoreFactory, but in a future version it will be renamed to DataStoreFactory.
    
    Returns:
    
    a factory object
    
    Since:
    
    4.12.0
    
    See Also:
    
    LDConfig.Builder.dataStore(FeatureStoreFactory)
  - persistentDataStore
```
public static PersistentDataStoreBuilder persistentDataStore(PersistentDataStoreFactory storeFactory)
```
    Returns a configuration builder for some implementation of a persistent data store.
    This method is used in conjunction with another factory object provided by specific components such as the Redis integration. The latter provides builder methods for options that are specific to that integration, while the PersistentDataStoreBuilder provides options that are applicable to any persistent data store (such as caching). For example:
```
     LDConfig config = new LDConfig.Builder()
         .dataStore(
             Components.persistentDataStore(
                 Redis.dataStore().url("redis://my-redis-host")
             ).cacheSeconds(15)
         )
         .build();
 
```
    See PersistentDataStoreBuilder for more on how this method is used.
    Parameters:
    
    storeFactory - the factory/builder for the specific kind of persistent data store
    
    Returns:
    
    a PersistentDataStoreBuilder
    
    Since:
    
    4.12.0
    
    See Also:
    
    LDConfig.Builder.dataStore(FeatureStoreFactory), Redis
  - inMemoryFeatureStore
```
@Deprecated
public static FeatureStoreFactory inMemoryFeatureStore()
```
    Deprecated. Use inMemoryDataStore().
    
    Deprecated name for inMemoryDataStore().
    
    Returns:
    
    a factory object
  - redisFeatureStore
```
@Deprecated
public static RedisFeatureStoreBuilder redisFeatureStore()
```
    Deprecated. Use persistentDataStore(PersistentDataStoreFactory) with Redis.dataStore().
    
    Deprecated name for Redis.dataStore().
    
    Returns:
    
    a factory/builder object
  - redisFeatureStore
```
@Deprecated
public static RedisFeatureStoreBuilder redisFeatureStore(java.net.URI redisUri)
```
    Deprecated. Use persistentDataStore(PersistentDataStoreFactory) with Redis.dataStore() and RedisDataStoreBuilder.uri(URI).
    
    Deprecated name for Redis.dataStore().
    
    Parameters:
    
    redisUri - the URI of the Redis host
    
    Returns:
    
    a factory/builder object
  - sendEvents
```
public static EventProcessorBuilder sendEvents()
```
    Returns a configuration builder for analytics event delivery.
    The default configuration has events enabled with default settings. If you want to customize this behavior, call this method to obtain a builder, change its properties with the EventProcessorBuilder properties, and pass it to LDConfig.Builder.events(EventProcessorFactory):
```
     LDConfig config = new LDConfig.Builder()
         .events(Components.sendEvents().capacity(5000).flushIntervalSeconds(2))
         .build();
 
```
    To completely disable sending analytics events, use noEvents() instead.
    Returns:
    
    a builder for setting streaming connection properties
    
    Since:
    
    4.12.0
    
    See Also:
    
    noEvents(), LDConfig.Builder.events(com.launchdarkly.client.EventProcessorFactory)
  - defaultEventProcessor
```
@Deprecated
public static EventProcessorFactory defaultEventProcessor()
```
    Deprecated. Use sendEvents() or noEvents().
    Deprecated method for using the default analytics events implementation.
    If you pass the return value of this method to LDConfig.Builder.events(EventProcessorFactory), the behavior is as follows:
    - If you have set LDConfig.Builder.offline(boolean) to true, or LDConfig.Builder.sendEvents(boolean) to false, the SDK will not send events to LaunchDarkly.
    - Otherwise, it will send events, using the properties set by the deprecated events configuration methods such as LDConfig.Builder.capacity(int).
    Returns:
    
    a factory object
  - noEvents
```
public static EventProcessorFactory noEvents()
```
    Returns a configuration object that disables analytics events.
    Passing this to LDConfig.Builder.events(EventProcessorFactory) causes the SDK to discard all analytics events and not send them to LaunchDarkly, regardless of any other configuration.
```
     LDConfig config = new LDConfig.Builder()
         .events(Components.noEvents())
         .build();
 
```
    Returns:
    
    a factory object
    
    Since:
    
    4.12.0
    
    See Also:
    
    sendEvents(), LDConfig.Builder.events(EventProcessorFactory)
  - nullEventProcessor
```
@Deprecated
public static EventProcessorFactory nullEventProcessor()
```
    Deprecated. Use noEvents().
    
    Deprecated name for noEvents().
    
    Returns:
    
    a factory object
    
    See Also:
    
    LDConfig.Builder.events(EventProcessorFactory)
  - streamingDataSource
```
public static StreamingDataSourceBuilder streamingDataSource()
```
    Returns a configurable factory for using streaming mode to get feature flag data.
    By default, the SDK uses a streaming connection to receive feature flag data from LaunchDarkly. To use the default behavior, you do not need to call this method. However, if you want to customize the behavior of the connection, call this method to obtain a builder, change its properties with the StreamingDataSourceBuilder methods, and pass it to LDConfig.Builder.dataSource(UpdateProcessorFactory):
```
 
     LDConfig config = new LDConfig.Builder()
         .dataSource(Components.streamingDataSource().initialReconnectDelayMillis(500))
         .build();
 
```
    These properties will override any equivalent deprecated properties that were set with LDConfig.Builder, such as LDConfig.Builder.reconnectTimeMs(long).
    (Note that the interface is still named UpdateProcessorFactory, but in a future version it will be renamed to DataSourceFactory.)
    Returns:
    
    a builder for setting streaming connection properties
    
    Since:
    
    4.12.0
    
    See Also:
    
    LDConfig.Builder.dataSource(UpdateProcessorFactory)
  - pollingDataSource
```
public static PollingDataSourceBuilder pollingDataSource()
```
    Returns a configurable factory for using polling mode to get feature flag data.
    This is not the default behavior; by default, the SDK uses a streaming connection to receive feature flag data from LaunchDarkly. In polling mode, the SDK instead makes a new HTTP request to LaunchDarkly at regular intervals. HTTP caching allows it to avoid redundantly downloading data if there have been no changes, but polling is still less efficient than streaming and should only be used on the advice of LaunchDarkly support.
    To use polling mode, call this method to obtain a builder, change its properties with the PollingDataSourceBuilder methods, and pass it to LDConfig.Builder.dataSource(UpdateProcessorFactory):
```
     LDConfig config = new LDConfig.Builder()
         .dataSource(Components.pollingDataSource().pollIntervalMillis(45000))
         .build();
 
```
    These properties will override any equivalent deprecated properties that were set with LDConfig.Builder, such as LDConfig.Builder.pollingIntervalMillis(long). However, setting LDConfig.Builder.offline(boolean) to true will supersede this setting and completely disable network requests.
    (Note that the interface is still named UpdateProcessorFactory, but in a future version it will be renamed to DataSourceFactory.)
    Returns:
    
    a builder for setting polling properties
    
    Since:
    
    4.12.0
    
    See Also:
    
    LDConfig.Builder.dataSource(UpdateProcessorFactory)
  - defaultUpdateProcessor
```
@Deprecated
public static UpdateProcessorFactory defaultUpdateProcessor()
```
    Deprecated. Use streamingDataSource(), pollingDataSource(), or externalUpdatesOnly().
    Deprecated method for using the default data source implementation.
    If you pass the return value of this method to LDConfig.Builder.dataSource(UpdateProcessorFactory), the behavior is as follows:
    - If you have set LDConfig.Builder.offline(boolean) or LDConfig.Builder.useLdd(boolean) to true, the SDK will not connect to LaunchDarkly for feature flag data.
    - If you have set LDConfig.Builder.stream(boolean) to false, it will use polling mode-- equivalent to using pollingDataSource() with the options set by LDConfig.Builder.baseURI(URI) and LDConfig.Builder.pollingIntervalMillis(long).
    - Otherwise, it will use streaming mode-- equivalent to using streamingDataSource() with the options set by LDConfig.Builder.streamURI(URI) and LDConfig.Builder.reconnectTimeMs(long).
    Returns:
    
    a factory object
  - externalUpdatesOnly
```
public static UpdateProcessorFactory externalUpdatesOnly()
```
    Returns a configuration object that disables a direct connection with LaunchDarkly for feature flag updates.
    Passing this to LDConfig.Builder.dataSource(UpdateProcessorFactory) causes the SDK not to retrieve feature flag data from LaunchDarkly, regardless of any other configuration. This is normally done if you are using the Relay Proxy in "daemon mode", where an external process-- the Relay Proxy-- connects to LaunchDarkly and populates a persistent data store with the feature flag data. The data store could also be populated by another process that is running the LaunchDarkly SDK. If there is no external process updating the data store, then the SDK will not have any feature flag data and will return application default values only.
```
     LDConfig config = new LDConfig.Builder()
         .dataSource(Components.externalUpdatesOnly())
         .dataStore(Components.persistentDataStore(Redis.dataStore())) // assuming the Relay Proxy is using Redis
         .build();
 
```
    (Note that the interface is still named UpdateProcessorFactory, but in a future version it will be renamed to DataSourceFactory.)
    Returns:
    
    a factory object
    
    Since:
    
    4.12.0
    
    See Also:
    
    LDConfig.Builder.dataSource(UpdateProcessorFactory)
  - nullUpdateProcessor
```
@Deprecated
public static UpdateProcessorFactory nullUpdateProcessor()
```
    Deprecated. Use externalUpdatesOnly().
    
    Deprecated name for externalUpdatesOnly().
    
    Returns:
    
    a factory object
  - httpConfiguration
```
public static HttpConfigurationBuilder httpConfiguration()
```
    Returns a configurable factory for the SDK's networking configuration.
    Passing this to LDConfig.Builder.http(com.launchdarkly.client.interfaces.HttpConfigurationFactory) applies this configuration to all HTTP/HTTPS requests made by the SDK.
```
     LDConfig config = new LDConfig.Builder()
         .http(
              Components.httpConfiguration()
                  .connectTimeoutMillis(3000)
                  .proxyHostAndPort("my-proxy", 8080)
         )
         .build();
 
```
    These properties will override any equivalent deprecated properties that were set with LDConfig.Builder, such as LDConfig.Builder.connectTimeout(int). However, setting LDConfig.Builder.offline(boolean) to true will supersede these settings and completely disable network requests.
    Returns:
    
    a factory object
    
    Since:
    
    4.13.0
    
    See Also:
    
    LDConfig.Builder.http(com.launchdarkly.client.interfaces.HttpConfigurationFactory)
  - httpBasicAuthentication
```
public static HttpAuthentication httpBasicAuthentication(java.lang.String username,
                                                         java.lang.String password)
```
    Configures HTTP basic authentication, for use with a proxy server.
```
     LDConfig config = new LDConfig.Builder()
         .http(
              Components.httpConfiguration()
                  .proxyHostAndPort("my-proxy", 8080)
                  .proxyAuthentication(Components.httpBasicAuthentication("username", "password"))
         )
         .build();
 
```
    Parameters:
    
    username - the username
    
    password - the password
    
    Returns:
    
    the basic authentication strategy
    
    Since:
    
    4.13.0
    
    See Also:
    
    HttpConfigurationBuilder.proxyAuth(HttpAuthentication)

Class Components

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Components

Method Detail

inMemoryDataStore

persistentDataStore

inMemoryFeatureStore

redisFeatureStore

redisFeatureStore

sendEvents

defaultEventProcessor

noEvents

nullEventProcessor

streamingDataSource

pollingDataSource

defaultUpdateProcessor

externalUpdatesOnly

nullUpdateProcessor

httpConfiguration

httpBasicAuthentication