com.launchdarkly.client

Class LDConfig.Builder

java.lang.Object

com.launchdarkly.client.LDConfig.Builder

Enclosing class:

LDConfig

public static class LDConfig.Builder
extends java.lang.Object

A builder that helps construct LDConfig objects. Builder calls can be chained, enabling the following pattern:

 LDConfig config = new LDConfig.Builder()
      .connectTimeoutMillis(3)
      .socketTimeoutMillis(3)
      .build()
 

Constructor Summary

Constructors

Constructor and Description
Builder() Creates a builder with all configuration parameters set to the default

Method Summary

Modifier and Type	Method and Description
LDConfig.Builder	allAttributesPrivate(boolean allPrivate) Deprecated. Use Components.sendEvents() with EventProcessorBuilder.allAttributesPrivate(boolean).
LDConfig.Builder	baseURI(java.net.URI baseURI) Deprecated. Use Components.streamingDataSource() with StreamingDataSourceBuilder.pollingBaseURI(URI), or Components.pollingDataSource() with PollingDataSourceBuilder.baseURI(URI).
LDConfig	build() Builds the configured LDConfig object.
LDConfig.Builder	capacity(int capacity) Deprecated. Use Components.sendEvents() with EventProcessorBuilder.capacity(int).
LDConfig.Builder	connectTimeout(int connectTimeout) Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.connectTimeoutMillis(int).
LDConfig.Builder	connectTimeoutMillis(int connectTimeoutMillis) Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.connectTimeoutMillis(int).
LDConfig.Builder	dataSource(UpdateProcessorFactory factory) Sets the implementation of the component that receives feature flag data from LaunchDarkly, using a factory object.
LDConfig.Builder	dataStore(FeatureStoreFactory factory) Sets the implementation of the data store to be used for holding feature flags and related data received from LaunchDarkly, using a factory object.
LDConfig.Builder	diagnosticOptOut(boolean diagnosticOptOut) Set to true to opt out of sending diagnostics data.
LDConfig.Builder	eventProcessorFactory(EventProcessorFactory factory) Deprecated. Use events(EventProcessorFactory).
LDConfig.Builder	events(EventProcessorFactory factory) Sets the implementation of EventProcessor to be used for processing analytics events.
LDConfig.Builder	eventsURI(java.net.URI eventsURI) Deprecated. Use @link Components.sendEvents() wtih EventProcessorBuilder.baseURI(URI).
LDConfig.Builder	featureStore(FeatureStore store) Deprecated. Please use featureStoreFactory(FeatureStoreFactory).
LDConfig.Builder	featureStoreFactory(FeatureStoreFactory factory) Deprecated. Use dataStore(FeatureStoreFactory).
LDConfig.Builder	flushInterval(int flushInterval) Deprecated. Use Components.sendEvents() with EventProcessorBuilder.flushIntervalSeconds(int).
LDConfig.Builder	http(HttpConfigurationFactory factory) Sets the SDK's networking configuration, using a factory object.
LDConfig.Builder	inlineUsersInEvents(boolean inlineUsersInEvents) Deprecated. Use Components.sendEvents() with EventProcessorBuilder.inlineUsersInEvents(boolean).
LDConfig.Builder	offline(boolean offline) Set whether this client is offline.
LDConfig.Builder	pollingIntervalMillis(long pollingIntervalMillis) Deprecated. Use Components.pollingDataSource() and PollingDataSourceBuilder.pollIntervalMillis(long).
LDConfig.Builder	privateAttributeNames(java.lang.String... names) Deprecated. Use Components.sendEvents() with EventProcessorBuilder.privateAttributeNames(String...).
LDConfig.Builder	proxyHost(java.lang.String host) Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.proxyHostAndPort(String, int).
LDConfig.Builder	proxyPassword(java.lang.String password) Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.proxyAuth(com.launchdarkly.client.interfaces.HttpAuthentication) and Components.httpBasicAuthentication(String, String).
LDConfig.Builder	proxyPort(int port) Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.proxyHostAndPort(String, int).
LDConfig.Builder	proxyUsername(java.lang.String username) Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.proxyAuth(com.launchdarkly.client.interfaces.HttpAuthentication) and Components.httpBasicAuthentication(String, String).
LDConfig.Builder	reconnectTimeMs(long reconnectTimeMs) Deprecated. Use Components.streamingDataSource() and StreamingDataSourceBuilder.initialReconnectDelayMillis(long).
LDConfig.Builder	samplingInterval(int samplingInterval) Deprecated. This feature will be removed in a future version of the SDK.
LDConfig.Builder	sendEvents(boolean sendEvents) Deprecated. Use Components.noEvents().
LDConfig.Builder	socketTimeout(int socketTimeout) Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.socketTimeoutMillis(int).
LDConfig.Builder	socketTimeoutMillis(int socketTimeoutMillis) Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.socketTimeoutMillis(int).
LDConfig.Builder	sslSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory, javax.net.ssl.X509TrustManager trustManager) Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.sslSocketFactory(SSLSocketFactory, X509TrustManager).
LDConfig.Builder	startWaitMillis(long startWaitMillis) Set how long the constructor will block awaiting a successful connection to LaunchDarkly.
LDConfig.Builder	stream(boolean stream) Deprecated. Use Components.streamingDataSource() or Components.pollingDataSource().
LDConfig.Builder	streamURI(java.net.URI streamURI) Deprecated. Use Components.streamingDataSource() with StreamingDataSourceBuilder.pollingBaseURI(URI).
LDConfig.Builder	updateProcessorFactory(UpdateProcessorFactory factory) Deprecated. Use dataSource(UpdateProcessorFactory).
LDConfig.Builder	useLdd(boolean useLdd) Deprecated. Use Components.externalUpdatesOnly().
LDConfig.Builder	userKeysCapacity(int capacity) Deprecated. Use Components.sendEvents() with EventProcessorBuilder.userKeysCapacity(int).
LDConfig.Builder	userKeysFlushInterval(int flushInterval) Deprecated. Use Components.sendEvents() with EventProcessorBuilder.userKeysFlushIntervalSeconds(int).
LDConfig.Builder	wrapperName(java.lang.String wrapperName) Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.wrapper(String, String).
LDConfig.Builder	wrapperVersion(java.lang.String wrapperVersion) Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.wrapper(String, String).

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates a builder with all configuration parameters set to the default

Method Detail

baseURI

@Deprecated
public LDConfig.Builder baseURI(java.net.URI baseURI)

Deprecated. Use Components.streamingDataSource() with StreamingDataSourceBuilder.pollingBaseURI(URI), or Components.pollingDataSource() with PollingDataSourceBuilder.baseURI(URI).

Deprecated method for setting the base URI for the polling service.

This method has no effect if you have used dataSource(UpdateProcessorFactory) to specify polling or streaming options, which is the preferred method.

Parameters:

baseURI - the base URL of the LaunchDarkly server for this configuration.

Returns:

the builder

eventsURI

@Deprecated
public LDConfig.Builder eventsURI(java.net.URI eventsURI)

Deprecated. Use @link Components.sendEvents() wtih EventProcessorBuilder.baseURI(URI).

Deprecated method for setting the base URI of the LaunchDarkly analytics event service.

Parameters:

eventsURI - the events URL of the LaunchDarkly server for this configuration

Returns:

the builder

streamURI

@Deprecated
public LDConfig.Builder streamURI(java.net.URI streamURI)

Deprecated. Use Components.streamingDataSource() with StreamingDataSourceBuilder.pollingBaseURI(URI).

Deprecated method for setting the base URI for the streaming service.

This method has no effect if you have used dataSource(UpdateProcessorFactory) to specify polling or streaming options, which is the preferred method.

Parameters:

streamURI - the base URL of the LaunchDarkly streaming server

Returns:

the builder

dataStore

public LDConfig.Builder dataStore(FeatureStoreFactory factory)

Sets the implementation of the data store to be used for holding feature flags and related data received from LaunchDarkly, using a factory object. The default is Components.inMemoryDataStore(); for database integrations, use Components.persistentDataStore(com.launchdarkly.client.interfaces.PersistentDataStoreFactory).

Note that the interface is still called FeatureStoreFactory, but in a future version it will be renamed to DataStoreFactory.

Parameters:

factory - the factory object

Returns:

the builder

Since:

4.12.0

featureStore

@Deprecated
public LDConfig.Builder featureStore(FeatureStore store)

Deprecated. Please use featureStoreFactory(FeatureStoreFactory).

Sets the implementation of FeatureStore to be used for holding feature flags and related data received from LaunchDarkly. The default is InMemoryFeatureStore, but you may use RedisFeatureStore or a custom implementation.

Parameters:

store - the feature store implementation

Returns:

the builder

featureStoreFactory

@Deprecated
public LDConfig.Builder featureStoreFactory(FeatureStoreFactory factory)

Deprecated. Use dataStore(FeatureStoreFactory).

Deprecated name for dataStore(FeatureStoreFactory).

Parameters:

factory - the factory object

Returns:

the builder

Since:

4.0.0

events

public LDConfig.Builder events(EventProcessorFactory factory)

Sets the implementation of EventProcessor to be used for processing analytics events.

The default is Components.sendEvents(), but you may choose to use a custom implementation (for instance, a test fixture), or disable events with Components.noEvents().

Parameters:

factory - a builder/factory object for event configuration

Returns:

the builder

Since:

4.12.0

eventProcessorFactory

@Deprecated
public LDConfig.Builder eventProcessorFactory(EventProcessorFactory factory)

Deprecated. Use events(EventProcessorFactory).

Deprecated name for events(EventProcessorFactory).

Parameters:

factory - the factory object

Returns:

the builder

Since:

4.0.0

dataSource

public LDConfig.Builder dataSource(UpdateProcessorFactory factory)

Sets the implementation of the component that receives feature flag data from LaunchDarkly, using a factory object. Depending on the implementation, the factory may be a builder that allows you to set other configuration options as well.

The default is Components.streamingDataSource(). You may instead use Components.pollingDataSource(), or a test fixture such as FileData.dataSource(). See those methods for details on how to configure them.

Note that the interface is still named UpdateProcessorFactory, but in a future version it will be renamed to DataSourceFactory.

Parameters:

factory - the factory object

Returns:

the builder

Since:

4.12.0

updateProcessorFactory

@Deprecated
public LDConfig.Builder updateProcessorFactory(UpdateProcessorFactory factory)

Deprecated. Use dataSource(UpdateProcessorFactory).

Deprecated name for dataSource(UpdateProcessorFactory).

Parameters:

factory - the factory object

Returns:

the builder

Since:

4.0.0

stream

@Deprecated
public LDConfig.Builder stream(boolean stream)

Deprecated. Use Components.streamingDataSource() or Components.pollingDataSource().

Deprecated method for enabling or disabling streaming mode.

By default, streaming is enabled. It should only be disabled on the advice of LaunchDarkly support.

This method has no effect if you have specified a data source with dataSource(UpdateProcessorFactory), which is the preferred method.

Parameters:

stream - whether streaming mode should be enabled

Returns:

the builder

http

public LDConfig.Builder http(HttpConfigurationFactory factory)

Sets the SDK's networking configuration, using a factory object. This object is normally a configuration builder obtained from Components.httpConfiguration(), which has methods for setting individual HTTP-related properties.

Parameters:

factory - the factory object

Returns:

the builder

Since:

4.13.0

See Also:

Components.httpConfiguration()

connectTimeout

@Deprecated
public LDConfig.Builder connectTimeout(int connectTimeout)

Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.connectTimeoutMillis(int).

Deprecated method for setting the connection timeout.

Parameters:

connectTimeout - the connection timeout in seconds

Returns:

the builder

socketTimeout

@Deprecated
public LDConfig.Builder socketTimeout(int socketTimeout)

Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.socketTimeoutMillis(int).

Deprecated method for setting the socket read timeout.

Parameters:

socketTimeout - the socket timeout in seconds

Returns:

the builder

connectTimeoutMillis

@Deprecated
public LDConfig.Builder connectTimeoutMillis(int connectTimeoutMillis)

Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.connectTimeoutMillis(int).

Deprecated method for setting the connection timeout.

Parameters:

connectTimeoutMillis - the connection timeout in milliseconds

Returns:

the builder

socketTimeoutMillis

@Deprecated
public LDConfig.Builder socketTimeoutMillis(int socketTimeoutMillis)

Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.socketTimeoutMillis(int).

Deprecated method for setting the socket read timeout.

Parameters:

socketTimeoutMillis - the socket timeout in milliseconds

Returns:

the builder

flushInterval

@Deprecated
public LDConfig.Builder flushInterval(int flushInterval)

Deprecated. Use Components.sendEvents() with EventProcessorBuilder.flushIntervalSeconds(int).

Deprecated method for setting the event buffer flush interval.

Parameters:

flushInterval - the flush interval in seconds

Returns:

the builder

capacity

@Deprecated
public LDConfig.Builder capacity(int capacity)

Deprecated. Use Components.sendEvents() with EventProcessorBuilder.capacity(int).

Deprecated method for setting the capacity of the events buffer.

Parameters:

capacity - the capacity of the event buffer

Returns:

the builder

proxyHost

@Deprecated
public LDConfig.Builder proxyHost(java.lang.String host)

Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.proxyHostAndPort(String, int).

Deprecated method for specifying an HTTP proxy. If this is not set, but proxyPort(int) is specified, this will default to localhost.

If neither proxyHost(String) nor proxyPort(int) are specified, a proxy will not be used, and LDClient will connect to LaunchDarkly directly.

Parameters:

host - the proxy hostname

Returns:

the builder

proxyPort

@Deprecated
public LDConfig.Builder proxyPort(int port)

Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.proxyHostAndPort(String, int).

Deprecated method for specifying the port of an HTTP proxy.

Parameters:

port - the proxy port

Returns:

the builder

proxyUsername

@Deprecated
public LDConfig.Builder proxyUsername(java.lang.String username)

Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.proxyAuth(com.launchdarkly.client.interfaces.HttpAuthentication) and Components.httpBasicAuthentication(String, String).

Deprecated method for specifying HTTP proxy authorization credentials.

Parameters:

username - the proxy username

Returns:

the builder

proxyPassword

@Deprecated
public LDConfig.Builder proxyPassword(java.lang.String password)

Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.proxyAuth(com.launchdarkly.client.interfaces.HttpAuthentication) and Components.httpBasicAuthentication(String, String).

Deprecated method for specifying HTTP proxy authorization credentials.

Parameters:

password - the proxy password

Returns:

the builder

sslSocketFactory

@Deprecated
public LDConfig.Builder sslSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory,
                                                     javax.net.ssl.X509TrustManager trustManager)

Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.sslSocketFactory(SSLSocketFactory, X509TrustManager).

Deprecated method for specifying a custom SSL socket factory and certificate trust manager.

Parameters:

sslSocketFactory - the SSL socket factory

trustManager - the trust manager

Returns:

the builder

Since:

4.7.0

useLdd

@Deprecated
public LDConfig.Builder useLdd(boolean useLdd)

Deprecated. Use Components.externalUpdatesOnly().

Deprecated method for using the LaunchDarkly Relay Proxy in daemon mode.

See Components.externalUpdatesOnly() for the preferred way to do this.

Parameters:

useLdd - true to use the relay in daemon mode; false to use streaming or polling

Returns:

the builder

offline

public LDConfig.Builder offline(boolean offline)

Set whether this client is offline.

In offline mode, the SDK will not make network connections to LaunchDarkly for any purpose. Feature flag data will only be available if it already exists in the data store, and analytics events will not be sent.

This is equivalent to calling dataSource(Components.externalUpdatesOnly()) and events(Components.noEvents()). It overrides any other values you may have set for dataSource(UpdateProcessorFactory) or events(EventProcessorFactory).

Parameters:

offline - when set to true no calls to LaunchDarkly will be made

Returns:

the builder

allAttributesPrivate

@Deprecated
public LDConfig.Builder allAttributesPrivate(boolean allPrivate)

Deprecated. Use Components.sendEvents() with EventProcessorBuilder.allAttributesPrivate(boolean).

Deprecated method for making all user attributes private.

Parameters:

allPrivate - true if all user attributes should be private

Returns:

the builder

sendEvents

@Deprecated
public LDConfig.Builder sendEvents(boolean sendEvents)

Deprecated. Use Components.noEvents().

Deprecated method for disabling analytics events.

Parameters:

sendEvents - when set to false, no events will be sent to LaunchDarkly

Returns:

the builder

pollingIntervalMillis

@Deprecated
public LDConfig.Builder pollingIntervalMillis(long pollingIntervalMillis)

Deprecated. Use Components.pollingDataSource() and PollingDataSourceBuilder.pollIntervalMillis(long).

Deprecated method for setting the polling interval in polling mode.

Values less than the default of 30000 will be set to the default.

This method has no effect if you have not disabled streaming mode, or if you have specified a non-polling data source with dataSource(UpdateProcessorFactory).

Parameters:

pollingIntervalMillis - rule update polling interval in milliseconds

Returns:

the builder

startWaitMillis

public LDConfig.Builder startWaitMillis(long startWaitMillis)

Set how long the constructor will block awaiting a successful connection to LaunchDarkly. Setting this to 0 will not block and cause the constructor to return immediately. Default value: 5000

Parameters:

startWaitMillis - milliseconds to wait

Returns:

the builder

samplingInterval

@Deprecated
public LDConfig.Builder samplingInterval(int samplingInterval)

Deprecated. This feature will be removed in a future version of the SDK.

Enable event sampling. When set to the default of zero, sampling is disabled and all events are sent back to LaunchDarkly. When set to greater than zero, there is a 1 in samplingInterval chance events will be will be sent.

Example: if you want 5% sampling rate, set samplingInterval to 20.

Parameters:

samplingInterval - the sampling interval

Returns:

the builder

reconnectTimeMs

@Deprecated
public LDConfig.Builder reconnectTimeMs(long reconnectTimeMs)

Deprecated. Use Components.streamingDataSource() and StreamingDataSourceBuilder.initialReconnectDelayMillis(long).

Deprecated method for setting the initial reconnect delay for the streaming connection.

This method has no effect if you have disabled streaming mode, or if you have specified a non-streaming data source with dataSource(UpdateProcessorFactory).

Parameters:

reconnectTimeMs - the reconnect time base value in milliseconds

Returns:

the builder

privateAttributeNames

@Deprecated
public LDConfig.Builder privateAttributeNames(java.lang.String... names)

Deprecated. Use Components.sendEvents() with EventProcessorBuilder.privateAttributeNames(String...).

Deprecated method for specifying globally private user attributes.

Parameters:

names - a set of names that will be removed from user data set to LaunchDarkly

Returns:

the builder

userKeysCapacity

@Deprecated
public LDConfig.Builder userKeysCapacity(int capacity)

Deprecated. Use Components.sendEvents() with EventProcessorBuilder.userKeysCapacity(int).

Deprecated method for setting the number of user keys that can be cached for analytics events.

Parameters:

capacity - the maximum number of user keys to remember

Returns:

the builder

userKeysFlushInterval

@Deprecated
public LDConfig.Builder userKeysFlushInterval(int flushInterval)

Deprecated. Use Components.sendEvents() with EventProcessorBuilder.userKeysFlushIntervalSeconds(int).

Deprecated method for setting the expiration time of the user key cache for analytics events.

Parameters:

flushInterval - the flush interval in seconds

Returns:

the builder

inlineUsersInEvents

@Deprecated
public LDConfig.Builder inlineUsersInEvents(boolean inlineUsersInEvents)

Deprecated. Use Components.sendEvents() with EventProcessorBuilder.inlineUsersInEvents(boolean).

Deprecated method for setting whether to include full user details in every analytics event.

Parameters:

inlineUsersInEvents - true if you want full user details in each event

Returns:

the builder

diagnosticOptOut

public LDConfig.Builder diagnosticOptOut(boolean diagnosticOptOut)

Set to true to opt out of sending diagnostics data.

Unless diagnosticOptOut is set to true, the client will send some diagnostics data to the LaunchDarkly servers in order to assist in the development of future SDK improvements. These diagnostics consist of an initial payload containing some details of SDK in use, the SDK's configuration, and the platform the SDK is being run on; as well as payloads sent periodically with information on irregular occurrences such as dropped events.

Parameters:

diagnosticOptOut - true if you want to opt out of sending any diagnostics data

Returns:

the builder

Since:

4.12.0

See Also:

EventProcessorBuilder.diagnosticRecordingIntervalSeconds(int)

wrapperName

@Deprecated
public LDConfig.Builder wrapperName(java.lang.String wrapperName)

Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.wrapper(String, String).

Deprecated method of specifing a wrapper library identifier.

Parameters:

wrapperName - an identifying name for the wrapper library

Returns:

the builder

Since:

4.12.0

wrapperVersion

@Deprecated
public LDConfig.Builder wrapperVersion(java.lang.String wrapperVersion)

Deprecated. Use Components.httpConfiguration() with HttpConfigurationBuilder.wrapper(String, String).

Deprecated method of specifing a wrapper library identifier.

Parameters:

wrapperVersion - version string for the wrapper library

Returns:

the builder

Since:

4.12.0

build

public LDConfig build()

Builds the configured LDConfig object.

Returns:

the LDConfig configured by this builder