Package com.launchdarkly.sdk.server.integrations

Class PollingDataSourceBuilder

java.lang.Object

com.launchdarkly.sdk.server.integrations.PollingDataSourceBuilder

All Implemented Interfaces:

DataSourceFactory

public abstract class PollingDataSourceBuilder
extends java.lang.Object
implements DataSourceFactory

Contains methods for configuring the polling data source.

Polling 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, create a builder with Components.pollingDataSource(), change its properties with the methods of this class, and pass it to LDConfig.Builder.dataSource(DataSourceFactory):

     LDConfig config = new LDConfig.Builder()
         .dataSource(Components.pollingDataSource().pollInterval(Duration.ofSeconds(45)))
         .build();
 

Note that this class is abstract; the actual implementation is created by calling Components.pollingDataSource().

Since:

4.12.0

Field Summary

Fields

Modifier and Type	Field	Description
protected java.net.URI	baseURI
static java.time.Duration	DEFAULT_POLL_INTERVAL	The default and minimum value for pollInterval(Duration): 30 seconds.
protected java.time.Duration	pollInterval

Constructor Summary

Constructors

Constructor	Description
PollingDataSourceBuilder()

Method Summary

Modifier and Type	Method	Description
PollingDataSourceBuilder	baseURI(java.net.URI baseURI)	Deprecated. Use LDConfig.Builder.serviceEndpoints(ServiceEndpointsBuilder) and ServiceEndpointsBuilder.polling(URI).
PollingDataSourceBuilder	pollInterval(java.time.Duration pollInterval)	Sets the interval at which the SDK will poll for feature flag updates.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.launchdarkly.sdk.server.interfaces.DataSourceFactory

createDataSource

Field Detail

DEFAULT_POLL_INTERVAL

public static final java.time.Duration DEFAULT_POLL_INTERVAL

The default and minimum value for pollInterval(Duration): 30 seconds.

baseURI

protected java.net.URI baseURI

pollInterval

protected java.time.Duration pollInterval

Constructor Detail

PollingDataSourceBuilder

public PollingDataSourceBuilder()

Method Detail

baseURI

@Deprecated
public PollingDataSourceBuilder baseURI(java.net.URI baseURI)

Deprecated.

Use LDConfig.Builder.serviceEndpoints(ServiceEndpointsBuilder) and ServiceEndpointsBuilder.polling(URI).

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

The preferred way to set this option is now with LDConfig.Builder.serviceEndpoints(ServiceEndpointsBuilder). If you set this deprecated option, it overrides any value that was set with LDConfig.Builder.serviceEndpoints(ServiceEndpointsBuilder).

You will only need to change this value in the following cases:

• You are using the Relay Proxy. Set streamUri to the base URI of the Relay Proxy instance.
• You are connecting to a test server or anything else other than the standard LaunchDarkly service.

Parameters:

baseURI - the base URI of the polling service; null to use the default

Returns:

the builder

pollInterval

public PollingDataSourceBuilder pollInterval(java.time.Duration pollInterval)

Sets the interval at which the SDK will poll for feature flag updates.

The default and minimum value is DEFAULT_POLL_INTERVAL. Values less than this will be set to the default.

Parameters:

pollInterval - the polling interval; null to use the default

Returns:

the builder