com.launchdarkly.client.LDConfig Maven / Gradle / Ivy
package com.launchdarkly.client;
import com.google.common.collect.ImmutableSet;
import com.launchdarkly.client.integrations.EventProcessorBuilder;
import com.launchdarkly.client.integrations.HttpConfigurationBuilder;
import com.launchdarkly.client.integrations.PollingDataSourceBuilder;
import com.launchdarkly.client.integrations.StreamingDataSourceBuilder;
import com.launchdarkly.client.interfaces.HttpConfiguration;
import com.launchdarkly.client.interfaces.HttpConfigurationFactory;
import java.net.URI;
import javax.net.ssl.SSLSocketFactory;
import javax.net.ssl.X509TrustManager;
/**
* This class exposes advanced configuration options for the {@link LDClient}. Instances of this class must be constructed with a {@link com.launchdarkly.client.LDConfig.Builder}.
*/
public final class LDConfig {
static final URI DEFAULT_BASE_URI = URI.create("https://app.launchdarkly.com");
static final URI DEFAULT_EVENTS_URI = URI.create("https://events.launchdarkly.com");
static final URI DEFAULT_STREAM_URI = URI.create("https://stream.launchdarkly.com");
private static final int DEFAULT_CAPACITY = 10000;
private static final int DEFAULT_FLUSH_INTERVAL_SECONDS = 5;
private static final long MIN_POLLING_INTERVAL_MILLIS = PollingDataSourceBuilder.DEFAULT_POLL_INTERVAL_MILLIS;
private static final long DEFAULT_START_WAIT_MILLIS = 5000L;
private static final int DEFAULT_SAMPLING_INTERVAL = 0;
private static final int DEFAULT_USER_KEYS_CAPACITY = 1000;
private static final int DEFAULT_USER_KEYS_FLUSH_INTERVAL_SECONDS = 60 * 5;
private static final long DEFAULT_RECONNECT_TIME_MILLIS = StreamingDataSourceBuilder.DEFAULT_INITIAL_RECONNECT_DELAY_MILLIS;
protected static final LDConfig DEFAULT = new Builder().build();
final UpdateProcessorFactory dataSourceFactory;
final FeatureStoreFactory dataStoreFactory;
final boolean diagnosticOptOut;
final EventProcessorFactory eventProcessorFactory;
final HttpConfiguration httpConfig;
final boolean offline;
final long startWaitMillis;
final URI deprecatedBaseURI;
final URI deprecatedEventsURI;
final URI deprecatedStreamURI;
final int deprecatedCapacity;
final int deprecatedFlushInterval;
final boolean deprecatedStream;
final FeatureStore deprecatedFeatureStore;
final boolean deprecatedAllAttributesPrivate;
final ImmutableSet deprecatedPrivateAttrNames;
final boolean deprecatedSendEvents;
final long deprecatedPollingIntervalMillis;
final int deprecatedSamplingInterval;
final long deprecatedReconnectTimeMs;
final int deprecatedUserKeysCapacity;
final int deprecatedUserKeysFlushInterval;
final boolean deprecatedInlineUsersInEvents;
protected LDConfig(Builder builder) {
this.dataStoreFactory = builder.dataStoreFactory;
this.eventProcessorFactory = builder.eventProcessorFactory;
this.dataSourceFactory = builder.dataSourceFactory;
this.diagnosticOptOut = builder.diagnosticOptOut;
this.offline = builder.offline;
this.startWaitMillis = builder.startWaitMillis;
if (builder.httpConfigFactory != null) {
this.httpConfig = builder.httpConfigFactory.createHttpConfiguration();
} else {
this.httpConfig = Components.httpConfiguration()
.connectTimeoutMillis(builder.connectTimeoutMillis)
.proxyHostAndPort(builder.proxyPort == -1 ? null : builder.proxyHost, builder.proxyPort)
.proxyAuth(builder.proxyUsername == null || builder.proxyPassword == null ? null :
Components.httpBasicAuthentication(builder.proxyUsername, builder.proxyPassword))
.socketTimeoutMillis(builder.socketTimeoutMillis)
.sslSocketFactory(builder.sslSocketFactory, builder.trustManager)
.wrapper(builder.wrapperName, builder.wrapperVersion)
.createHttpConfiguration();
}
this.deprecatedAllAttributesPrivate = builder.allAttributesPrivate;
this.deprecatedBaseURI = builder.baseURI;
this.deprecatedCapacity = builder.capacity;
this.deprecatedEventsURI = builder.eventsURI;
this.deprecatedFeatureStore = builder.featureStore;
this.deprecatedFlushInterval = builder.flushIntervalSeconds;
this.deprecatedInlineUsersInEvents = builder.inlineUsersInEvents;
if (builder.pollingIntervalMillis < MIN_POLLING_INTERVAL_MILLIS) {
this.deprecatedPollingIntervalMillis = MIN_POLLING_INTERVAL_MILLIS;
} else {
this.deprecatedPollingIntervalMillis = builder.pollingIntervalMillis;
}
this.deprecatedPrivateAttrNames = builder.privateAttrNames;
this.deprecatedSendEvents = builder.sendEvents;
this.deprecatedStream = builder.stream;
this.deprecatedStreamURI = builder.streamURI;
this.deprecatedSamplingInterval = builder.samplingInterval;
this.deprecatedReconnectTimeMs = builder.reconnectTimeMillis;
this.deprecatedUserKeysCapacity = builder.userKeysCapacity;
this.deprecatedUserKeysFlushInterval = builder.userKeysFlushInterval;
}
LDConfig(LDConfig config) {
this.dataSourceFactory = config.dataSourceFactory;
this.dataStoreFactory = config.dataStoreFactory;
this.diagnosticOptOut = config.diagnosticOptOut;
this.eventProcessorFactory = config.eventProcessorFactory;
this.httpConfig = config.httpConfig;
this.offline = config.offline;
this.startWaitMillis = config.startWaitMillis;
this.deprecatedAllAttributesPrivate = config.deprecatedAllAttributesPrivate;
this.deprecatedBaseURI = config.deprecatedBaseURI;
this.deprecatedCapacity = config.deprecatedCapacity;
this.deprecatedEventsURI = config.deprecatedEventsURI;
this.deprecatedFeatureStore = config.deprecatedFeatureStore;
this.deprecatedFlushInterval = config.deprecatedFlushInterval;
this.deprecatedInlineUsersInEvents = config.deprecatedInlineUsersInEvents;
this.deprecatedPollingIntervalMillis = config.deprecatedPollingIntervalMillis;
this.deprecatedPrivateAttrNames = config.deprecatedPrivateAttrNames;
this.deprecatedReconnectTimeMs = config.deprecatedReconnectTimeMs;
this.deprecatedSamplingInterval = config.deprecatedSamplingInterval;
this.deprecatedSendEvents = config.deprecatedSendEvents;
this.deprecatedStream = config.deprecatedStream;
this.deprecatedStreamURI = config.deprecatedStreamURI;
this.deprecatedUserKeysCapacity = config.deprecatedUserKeysCapacity;
this.deprecatedUserKeysFlushInterval = config.deprecatedUserKeysFlushInterval;
}
/**
* A builder that helps construct
* {@link com.launchdarkly.client.LDConfig} objects. Builder calls can be chained, enabling the
* following pattern:
*
* LDConfig config = new LDConfig.Builder()
* .connectTimeoutMillis(3)
* .socketTimeoutMillis(3)
* .build()
*
*/
public static class Builder {
private URI baseURI = DEFAULT_BASE_URI;
private URI eventsURI = DEFAULT_EVENTS_URI;
private URI streamURI = DEFAULT_STREAM_URI;
private HttpConfigurationFactory httpConfigFactory = null;
private int connectTimeoutMillis = HttpConfigurationBuilder.DEFAULT_CONNECT_TIMEOUT_MILLIS;
private int socketTimeoutMillis = HttpConfigurationBuilder.DEFAULT_SOCKET_TIMEOUT_MILLIS;
private boolean diagnosticOptOut = false;
private int capacity = DEFAULT_CAPACITY;
private int flushIntervalSeconds = DEFAULT_FLUSH_INTERVAL_SECONDS;
private String proxyHost = "localhost";
private int proxyPort = -1;
private String proxyUsername = null;
private String proxyPassword = null;
private boolean stream = true;
private boolean offline = false;
private boolean allAttributesPrivate = false;
private boolean sendEvents = true;
private long pollingIntervalMillis = MIN_POLLING_INTERVAL_MILLIS;
private FeatureStore featureStore = null;
private FeatureStoreFactory dataStoreFactory = null;
private EventProcessorFactory eventProcessorFactory = null;
private UpdateProcessorFactory dataSourceFactory = null;
private long startWaitMillis = DEFAULT_START_WAIT_MILLIS;
private int samplingInterval = DEFAULT_SAMPLING_INTERVAL;
private long reconnectTimeMillis = DEFAULT_RECONNECT_TIME_MILLIS;
private ImmutableSet privateAttrNames = ImmutableSet.of();
private int userKeysCapacity = DEFAULT_USER_KEYS_CAPACITY;
private int userKeysFlushInterval = DEFAULT_USER_KEYS_FLUSH_INTERVAL_SECONDS;
private boolean inlineUsersInEvents = false;
private SSLSocketFactory sslSocketFactory = null;
private X509TrustManager trustManager = null;
private String wrapperName = null;
private String wrapperVersion = null;
/**
* Creates a builder with all configuration parameters set to the default
*/
public Builder() {
}
/**
* Deprecated method for setting the base URI for the polling service.
*
* This method has no effect if you have used {@link #dataSource(UpdateProcessorFactory)} to
* specify polling or streaming options, which is the preferred method.
*
* @param baseURI the base URL of the LaunchDarkly server for this configuration.
* @return the builder
* @deprecated Use {@link Components#streamingDataSource()} with {@link StreamingDataSourceBuilder#pollingBaseURI(URI)},
* or {@link Components#pollingDataSource()} with {@link PollingDataSourceBuilder#baseURI(URI)}.
*/
@Deprecated
public Builder baseURI(URI baseURI) {
this.baseURI = baseURI;
return this;
}
/**
* Deprecated method for setting the base URI of the LaunchDarkly analytics event service.
*
* @param eventsURI the events URL of the LaunchDarkly server for this configuration
* @return the builder
* @deprecated Use @link {@link Components#sendEvents()} wtih {@link EventProcessorBuilder#baseURI(URI)}.
*/
@Deprecated
public Builder eventsURI(URI eventsURI) {
this.eventsURI = eventsURI;
return this;
}
/**
* Deprecated method for setting the base URI for the streaming service.
*
* This method has no effect if you have used {@link #dataSource(UpdateProcessorFactory)} to
* specify polling or streaming options, which is the preferred method.
*
* @param streamURI the base URL of the LaunchDarkly streaming server
* @return the builder
* @deprecated Use {@link Components#streamingDataSource()} with {@link StreamingDataSourceBuilder#pollingBaseURI(URI)}.
*/
@Deprecated
public Builder streamURI(URI streamURI) {
this.streamURI = streamURI;
return this;
}
/**
* 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
* {@link Components#inMemoryDataStore()}; for database integrations, use
* {@link Components#persistentDataStore(com.launchdarkly.client.interfaces.PersistentDataStoreFactory)}.
*
* Note that the interface is still called {@link FeatureStoreFactory}, but in a future version
* it will be renamed to {@code DataStoreFactory}.
*
* @param factory the factory object
* @return the builder
* @since 4.12.0
*/
public Builder dataStore(FeatureStoreFactory factory) {
this.dataStoreFactory = factory;
return this;
}
/**
* Sets the implementation of {@link FeatureStore} to be used for holding feature flags and
* related data received from LaunchDarkly. The default is {@link InMemoryFeatureStore}, but
* you may use {@link RedisFeatureStore} or a custom implementation.
* @param store the feature store implementation
* @return the builder
* @deprecated Please use {@link #featureStoreFactory(FeatureStoreFactory)}.
*/
@Deprecated
public Builder featureStore(FeatureStore store) {
this.featureStore = store;
return this;
}
/**
* Deprecated name for {@link #dataStore(FeatureStoreFactory)}.
* @param factory the factory object
* @return the builder
* @since 4.0.0
* @deprecated Use {@link #dataStore(FeatureStoreFactory)}.
*/
@Deprecated
public Builder featureStoreFactory(FeatureStoreFactory factory) {
this.dataStoreFactory = factory;
return this;
}
/**
* Sets the implementation of {@link EventProcessor} to be used for processing analytics events.
*
* The default is {@link Components#sendEvents()}, but you may choose to use a custom implementation
* (for instance, a test fixture), or disable events with {@link Components#noEvents()}.
*
* @param factory a builder/factory object for event configuration
* @return the builder
* @since 4.12.0
*/
public Builder events(EventProcessorFactory factory) {
this.eventProcessorFactory = factory;
return this;
}
/**
* Deprecated name for {@link #events(EventProcessorFactory)}.
* @param factory the factory object
* @return the builder
* @since 4.0.0
* @deprecated Use {@link #events(EventProcessorFactory)}.
*/
@Deprecated
public Builder eventProcessorFactory(EventProcessorFactory factory) {
this.eventProcessorFactory = factory;
return this;
}
/**
* 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 {@link Components#streamingDataSource()}. You may instead use
* {@link Components#pollingDataSource()}, or a test fixture such as
* {@link com.launchdarkly.client.integrations.FileData#dataSource()}. See those methods
* for details on how to configure them.
*
* Note that the interface is still named {@link UpdateProcessorFactory}, but in a future version
* it will be renamed to {@code DataSourceFactory}.
*
* @param factory the factory object
* @return the builder
* @since 4.12.0
*/
public Builder dataSource(UpdateProcessorFactory factory) {
this.dataSourceFactory = factory;
return this;
}
/**
* Deprecated name for {@link #dataSource(UpdateProcessorFactory)}.
* @param factory the factory object
* @return the builder
* @since 4.0.0
* @deprecated Use {@link #dataSource(UpdateProcessorFactory)}.
*/
@Deprecated
public Builder updateProcessorFactory(UpdateProcessorFactory factory) {
this.dataSourceFactory = factory;
return this;
}
/**
* 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 {@link #dataSource(UpdateProcessorFactory)},
* which is the preferred method.
*
* @param stream whether streaming mode should be enabled
* @return the builder
* @deprecated Use {@link Components#streamingDataSource()} or {@link Components#pollingDataSource()}.
*/
@Deprecated
public Builder stream(boolean stream) {
this.stream = stream;
return this;
}
/**
* Sets the SDK's networking configuration, using a factory object. This object is normally a
* configuration builder obtained from {@link Components#httpConfiguration()}, which has methods
* for setting individual HTTP-related properties.
*
* @param factory the factory object
* @return the builder
* @since 4.13.0
* @see Components#httpConfiguration()
*/
public Builder http(HttpConfigurationFactory factory) {
this.httpConfigFactory = factory;
return this;
}
/**
* Deprecated method for setting the connection timeout.
*
* @param connectTimeout the connection timeout in seconds
* @return the builder
* @deprecated Use {@link Components#httpConfiguration()} with {@link HttpConfigurationBuilder#connectTimeoutMillis(int)}.
*/
@Deprecated
public Builder connectTimeout(int connectTimeout) {
return connectTimeoutMillis(connectTimeout * 1000);
}
/**
* Deprecated method for setting the socket read timeout.
*
* @param socketTimeout the socket timeout in seconds
* @return the builder
* @deprecated Use {@link Components#httpConfiguration()} with {@link HttpConfigurationBuilder#socketTimeoutMillis(int)}.
*/
@Deprecated
public Builder socketTimeout(int socketTimeout) {
return socketTimeoutMillis(socketTimeout * 1000);
}
/**
* Deprecated method for setting the connection timeout.
*
* @param connectTimeoutMillis the connection timeout in milliseconds
* @return the builder
* @deprecated Use {@link Components#httpConfiguration()} with {@link HttpConfigurationBuilder#connectTimeoutMillis(int)}.
*/
@Deprecated
public Builder connectTimeoutMillis(int connectTimeoutMillis) {
this.connectTimeoutMillis = connectTimeoutMillis;
return this;
}
/**
* Deprecated method for setting the socket read timeout.
*
* @param socketTimeoutMillis the socket timeout in milliseconds
* @return the builder
* @deprecated Use {@link Components#httpConfiguration()} with {@link HttpConfigurationBuilder#socketTimeoutMillis(int)}.
*/
@Deprecated
public Builder socketTimeoutMillis(int socketTimeoutMillis) {
this.socketTimeoutMillis = socketTimeoutMillis;
return this;
}
/**
* Deprecated method for setting the event buffer flush interval.
*
* @param flushInterval the flush interval in seconds
* @return the builder
* @deprecated Use {@link Components#sendEvents()} with {@link EventProcessorBuilder#flushIntervalSeconds(int)}.
*/
@Deprecated
public Builder flushInterval(int flushInterval) {
this.flushIntervalSeconds = flushInterval;
return this;
}
/**
* Deprecated method for setting the capacity of the events buffer.
*
* @param capacity the capacity of the event buffer
* @return the builder
* @deprecated Use {@link Components#sendEvents()} with {@link EventProcessorBuilder#capacity(int)}.
*/
@Deprecated
public Builder capacity(int capacity) {
this.capacity = capacity;
return this;
}
/**
* Deprecated method for specifying an HTTP proxy.
*
* If this is not set, but {@link #proxyPort(int)} is specified, this will default to localhost.
*
* If neither {@link #proxyHost(String)} nor {@link #proxyPort(int)} are specified,
* a proxy will not be used, and {@link LDClient} will connect to LaunchDarkly directly.
*
*
* @param host the proxy hostname
* @return the builder
* @deprecated Use {@link Components#httpConfiguration()} with {@link HttpConfigurationBuilder#proxyHostAndPort(String, int)}.
*/
@Deprecated
public Builder proxyHost(String host) {
this.proxyHost = host;
return this;
}
/**
* Deprecated method for specifying the port of an HTTP proxy.
*
* @param port the proxy port
* @return the builder
* @deprecated Use {@link Components#httpConfiguration()} with {@link HttpConfigurationBuilder#proxyHostAndPort(String, int)}.
*/
@Deprecated
public Builder proxyPort(int port) {
this.proxyPort = port;
return this;
}
/**
* Deprecated method for specifying HTTP proxy authorization credentials.
*
* @param username the proxy username
* @return the builder
* @deprecated Use {@link Components#httpConfiguration()} with {@link HttpConfigurationBuilder#proxyAuth(com.launchdarkly.client.interfaces.HttpAuthentication)}
* and {@link Components#httpBasicAuthentication(String, String)}.
*/
@Deprecated
public Builder proxyUsername(String username) {
this.proxyUsername = username;
return this;
}
/**
* Deprecated method for specifying HTTP proxy authorization credentials.
*
* @param password the proxy password
* @return the builder
* @deprecated Use {@link Components#httpConfiguration()} with {@link HttpConfigurationBuilder#proxyAuth(com.launchdarkly.client.interfaces.HttpAuthentication)}
* and {@link Components#httpBasicAuthentication(String, String)}.
*/
@Deprecated
public Builder proxyPassword(String password) {
this.proxyPassword = password;
return this;
}
/**
* Deprecated method for specifying a custom SSL socket factory and certificate trust manager.
*
* @param sslSocketFactory the SSL socket factory
* @param trustManager the trust manager
* @return the builder
*
* @since 4.7.0
* @deprecated Use {@link Components#httpConfiguration()} with {@link HttpConfigurationBuilder#sslSocketFactory(SSLSocketFactory, X509TrustManager)}.
*/
@Deprecated
public Builder sslSocketFactory(SSLSocketFactory sslSocketFactory, X509TrustManager trustManager) {
this.sslSocketFactory = sslSocketFactory;
this.trustManager = trustManager;
return this;
}
/**
* Deprecated method for using the LaunchDarkly Relay Proxy in daemon mode.
*
* See {@link Components#externalUpdatesOnly()} for the preferred way to do this.
*
* @param useLdd true to use the relay in daemon mode; false to use streaming or polling
* @return the builder
* @deprecated Use {@link Components#externalUpdatesOnly()}.
*/
@Deprecated
public Builder useLdd(boolean useLdd) {
if (useLdd) {
return dataSource(Components.externalUpdatesOnly());
} else {
return dataSource(null);
}
}
/**
* 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 {@code dataSource(Components.externalUpdatesOnly())} and
* {@code events(Components.noEvents())}. It overrides any other values you may have set for
* {@link #dataSource(UpdateProcessorFactory)} or {@link #events(EventProcessorFactory)}.
*
* @param offline when set to true no calls to LaunchDarkly will be made
* @return the builder
*/
public Builder offline(boolean offline) {
this.offline = offline;
return this;
}
/**
* Deprecated method for making all user attributes private.
*
* @param allPrivate true if all user attributes should be private
* @return the builder
* @deprecated Use {@link Components#sendEvents()} with {@link EventProcessorBuilder#allAttributesPrivate(boolean)}.
*/
@Deprecated
public Builder allAttributesPrivate(boolean allPrivate) {
this.allAttributesPrivate = allPrivate;
return this;
}
/**
* Deprecated method for disabling analytics events.
*
* @param sendEvents when set to false, no events will be sent to LaunchDarkly
* @return the builder
* @deprecated Use {@link Components#noEvents()}.
*/
@Deprecated
public Builder sendEvents(boolean sendEvents) {
this.sendEvents = sendEvents;
return this;
}
/**
* 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 {@link #dataSource(UpdateProcessorFactory)}.
*
* @param pollingIntervalMillis rule update polling interval in milliseconds
* @return the builder
* @deprecated Use {@link Components#pollingDataSource()} and {@link PollingDataSourceBuilder#pollIntervalMillis(long)}.
*/
@Deprecated
public Builder pollingIntervalMillis(long pollingIntervalMillis) {
this.pollingIntervalMillis = pollingIntervalMillis;
return this;
}
/**
* 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
*
* @param startWaitMillis milliseconds to wait
* @return the builder
*/
public Builder startWaitMillis(long startWaitMillis) {
this.startWaitMillis = startWaitMillis;
return this;
}
/**
* 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.
*
* @param samplingInterval the sampling interval
* @return the builder
* @deprecated This feature will be removed in a future version of the SDK.
*/
@Deprecated
public Builder samplingInterval(int samplingInterval) {
this.samplingInterval = samplingInterval;
return this;
}
/**
* 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 {@link #dataSource(UpdateProcessorFactory)}.
*
* @param reconnectTimeMs the reconnect time base value in milliseconds
* @return the builder
* @deprecated Use {@link Components#streamingDataSource()} and {@link StreamingDataSourceBuilder#initialReconnectDelayMillis(long)}.
*/
@Deprecated
public Builder reconnectTimeMs(long reconnectTimeMs) {
this.reconnectTimeMillis = reconnectTimeMs;
return this;
}
/**
* Deprecated method for specifying globally private user attributes.
*
* @param names a set of names that will be removed from user data set to LaunchDarkly
* @return the builder
* @deprecated Use {@link Components#sendEvents()} with {@link EventProcessorBuilder#privateAttributeNames(String...)}.
*/
@Deprecated
public Builder privateAttributeNames(String... names) {
this.privateAttrNames = ImmutableSet.copyOf(names);
return this;
}
/**
* Deprecated method for setting the number of user keys that can be cached for analytics events.
*
* @param capacity the maximum number of user keys to remember
* @return the builder
* @deprecated Use {@link Components#sendEvents()} with {@link EventProcessorBuilder#userKeysCapacity(int)}.
*/
@Deprecated
public Builder userKeysCapacity(int capacity) {
this.userKeysCapacity = capacity;
return this;
}
/**
* Deprecated method for setting the expiration time of the user key cache for analytics events.
*
* @param flushInterval the flush interval in seconds
* @return the builder
* @deprecated Use {@link Components#sendEvents()} with {@link EventProcessorBuilder#userKeysFlushIntervalSeconds(int)}.
*/
@Deprecated
public Builder userKeysFlushInterval(int flushInterval) {
this.userKeysFlushInterval = flushInterval;
return this;
}
/**
* Deprecated method for setting whether to include full user details in every analytics event.
*
* @param inlineUsersInEvents true if you want full user details in each event
* @return the builder
* @deprecated Use {@link Components#sendEvents()} with {@link EventProcessorBuilder#inlineUsersInEvents(boolean)}.
*/
@Deprecated
public Builder inlineUsersInEvents(boolean inlineUsersInEvents) {
this.inlineUsersInEvents = inlineUsersInEvents;
return this;
}
/**
* Set to true to opt out of sending diagnostics data.
*
* Unless {@code 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.
*
* @see com.launchdarkly.client.integrations.EventProcessorBuilder#diagnosticRecordingIntervalSeconds(int)
*
* @param diagnosticOptOut true if you want to opt out of sending any diagnostics data
* @return the builder
* @since 4.12.0
*/
public Builder diagnosticOptOut(boolean diagnosticOptOut) {
this.diagnosticOptOut = diagnosticOptOut;
return this;
}
/**
* Deprecated method of specifing a wrapper library identifier.
*
* @param wrapperName an identifying name for the wrapper library
* @return the builder
* @since 4.12.0
* @deprecated Use {@link Components#httpConfiguration()} with {@link HttpConfigurationBuilder#wrapper(String, String)}.
*/
@Deprecated
public Builder wrapperName(String wrapperName) {
this.wrapperName = wrapperName;
return this;
}
/**
* Deprecated method of specifing a wrapper library identifier.
*
* @param wrapperVersion version string for the wrapper library
* @return the builder
* @since 4.12.0
* @deprecated Use {@link Components#httpConfiguration()} with {@link HttpConfigurationBuilder#wrapper(String, String)}.
*/
@Deprecated
public Builder wrapperVersion(String wrapperVersion) {
this.wrapperVersion = wrapperVersion;
return this;
}
/**
* Builds the configured {@link com.launchdarkly.client.LDConfig} object.
*
* @return the {@link com.launchdarkly.client.LDConfig} configured by this builder
*/
public LDConfig build() {
return new LDConfig(this);
}
}
}