io.split.client

Class SplitClientConfig.Builder

java.lang.Object

io.split.client.SplitClientConfig.Builder

Enclosing class:

SplitClientConfig

public static final class SplitClientConfig.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SplitClientConfig	build()
SplitClientConfig.Builder	connectionTimeout(int ms) Http client connection timeout.
SplitClientConfig.Builder	disableLabels() Disable label capturing
SplitClientConfig.Builder	enableDebug()
SplitClientConfig.Builder	endpoint(String endpoint, String eventsEndpoint) The rest endpoint that sdk will hit for latest features and segments.
SplitClientConfig.Builder	featuresRefreshRate(int seconds) The SDK will poll the endpoint for changes to features at this period.
SplitClientConfig.Builder	impressionListener(ImpressionListener impressionListener, int queueSize) You can provide your own ImpressionListener to capture all impressions generated by SplitClient.
SplitClientConfig.Builder	impressionsQueueSize(int impressionsQueueSize) The impression listener captures the which key saw what treatment ("on", "off", etc) at what time.
SplitClientConfig.Builder	impressionsRefreshRate(int seconds) The ImpressionListener captures the which key saw what treatment ("on", "off", etc) at what time.
SplitClientConfig.Builder	metricsRefreshRate(int seconds) The diagnostic metrics collected by the SDK are pushed back to split endpoint at this period.
SplitClientConfig.Builder	proxyHost(String proxyHost) The host location of the proxy.
SplitClientConfig.Builder	proxyPassword(String proxyPassword) Set the password for authentication against the proxy (if proxy settings are enabled).
SplitClientConfig.Builder	proxyPort(int proxyPort) The port of the proxy.
SplitClientConfig.Builder	proxyUsername(String proxyUsername) Set the username for authentication against the proxy (if proxy settings are enabled).
SplitClientConfig.Builder	readTimeout(int ms) Http client read timeout.
SplitClientConfig.Builder	ready(int milliseconds) The SDK kicks off background threads to download data necessary for using the SDK.
SplitClientConfig.Builder	segmentsRefreshRate(int seconds) The SDK will poll the endpoint for changes to segments at this period in seconds.
SplitClientConfig.Builder	waitBeforeShutdown(int waitTime) How long to wait for impressions background thread before shutting down the underlying connections.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

endpoint

public SplitClientConfig.Builder endpoint(String endpoint,
                                          String eventsEndpoint)

The rest endpoint that sdk will hit for latest features and segments.

Parameters:

endpoint - MUST NOT be null

Returns:

this builder

featuresRefreshRate

public SplitClientConfig.Builder featuresRefreshRate(int seconds)

The SDK will poll the endpoint for changes to features at this period.

Implementation Note: The SDK actually polls at a random interval chosen between (0.5 * n, n). This is to ensure that SDKs that are deployed simultaneously on different machines do not inundate the backend with requests at the same interval.

Parameters:

seconds - MUST be greater than 0. Default value is 60.

Returns:

this builder

segmentsRefreshRate

public SplitClientConfig.Builder segmentsRefreshRate(int seconds)

The SDK will poll the endpoint for changes to segments at this period in seconds.

Implementation Note: The SDK actually polls at a random interval chosen between (0.5 * n, n). This is to ensure that SDKs that are deployed simultaneously on different machines do not inundate the backend with requests at the same interval.

Parameters:

seconds - MUST be greater than 0. Default value is 60.

Returns:

this builder

impressionsRefreshRate

public SplitClientConfig.Builder impressionsRefreshRate(int seconds)

The ImpressionListener captures the which key saw what treatment ("on", "off", etc) at what time. This log is periodically pushed back to split endpoint. This parameter controls how quickly does the cache expire after a write.

This is an ADVANCED parameter

Parameters:

seconds - MUST be > 0.

Returns:

this builder

impressionsQueueSize

public SplitClientConfig.Builder impressionsQueueSize(int impressionsQueueSize)

The impression listener captures the which key saw what treatment ("on", "off", etc) at what time. This log is periodically pushed back to split endpoint. This parameter controls the in-memory queue size to store them before they are pushed back to split endpoint. If the value chosen is too small and more than the default size(5000) of impressions are generated, the old ones will be dropped and the sdk will show a warning.

This is an ADVANCED parameter.

Parameters:

impressionsQueueSize - MUST be > 0. Default is 5000.

Returns:

this builder

impressionListener

public SplitClientConfig.Builder impressionListener(ImpressionListener impressionListener,
                                                    int queueSize)

You can provide your own ImpressionListener to capture all impressions generated by SplitClient. An Impression is generated each time getTreatment is called.

Note that we will wrap any ImpressionListener provided in our own implementation with an Executor controlling impressions going into your ImpressionListener. This is done to protect SplitClient from any slowness caused by your ImpressionListener. The Executor will be given the capacity you provide as parameter which is the number of impressions that can be saved in a blocking queue while waiting for your ImpressionListener to log them. Of course, the larger the value of capacity, the more memory can be taken up.

The executor will create two threads.

This is an ADVANCED function.

Parameters:

impressionListener -

queueSize - maximum number of impressions that will be queued in memory. If the impressionListener is slow, the queue will fill up and any subsequent impressions will be dropped.

Returns:

this builder

metricsRefreshRate

public SplitClientConfig.Builder metricsRefreshRate(int seconds)

The diagnostic metrics collected by the SDK are pushed back to split endpoint at this period.

This is an ADVANCED parameter

Parameters:

seconds - MUST be > 0.

Returns:

this builder

connectionTimeout

public SplitClientConfig.Builder connectionTimeout(int ms)

Http client connection timeout. Default value is 15000ms.

Parameters:

ms - MUST be greater than 0.

Returns:

this builder

readTimeout

public SplitClientConfig.Builder readTimeout(int ms)

Http client read timeout. Default value is 15000ms.

Parameters:

ms - MUST be greater than 0.

Returns:

this builder

enableDebug

public SplitClientConfig.Builder enableDebug()

disableLabels

public SplitClientConfig.Builder disableLabels()

Disable label capturing

Returns:

this builder

ready

public SplitClientConfig.Builder ready(int milliseconds)

The SDK kicks off background threads to download data necessary for using the SDK. You can choose to block until the SDK has downloaded split definitions so that you will not get the 'control' treatment.

If this parameter is set to a non-negative value, the SDK will block for that number of milliseconds for the data to be downloaded.

If the download is not successful in this time period, a TimeOutException will be thrown.

A negative value implies that the SDK building MUST NOT block. In this scenario, the SDK might return the 'control' treatment until the desired data has been downloaded.

Parameters:

milliseconds - MUST BE greater than or equal to 0;

Returns:

this builder

waitBeforeShutdown

public SplitClientConfig.Builder waitBeforeShutdown(int waitTime)

How long to wait for impressions background thread before shutting down the underlying connections.

Parameters:

waitTime - tine in milliseconds

Returns:

this builder

proxyHost

public SplitClientConfig.Builder proxyHost(String proxyHost)

The host location of the proxy. Default is localhost.

Parameters:

proxyHost - location of the proxy

Returns:

this builder

proxyPort

public SplitClientConfig.Builder proxyPort(int proxyPort)

The port of the proxy. Default is -1.

Parameters:

proxyPort - port for the proxy

Returns:

this builder

proxyUsername

public SplitClientConfig.Builder proxyUsername(String proxyUsername)

Set the username for authentication against the proxy (if proxy settings are enabled). (Optional).

Parameters:

proxyUsername -

Returns:

this builder

proxyPassword

public SplitClientConfig.Builder proxyPassword(String proxyPassword)

Set the password for authentication against the proxy (if proxy settings are enabled). (Optional).

Parameters:

proxyPassword -

Returns:

this builder

build

public SplitClientConfig build()