com.optimizely.ab

Class OptimizelyFactory

java.lang.Object

com.optimizely.ab.OptimizelyFactory

public final class OptimizelyFactory
extends java.lang.Object

OptimizelyFactory is a utility class to instantiate an Optimizely client with a minimal number of configuration options. Basic default parameters can be configured via system properties or through the use of an optimizely.properties file. System properties takes precedence over the properties file and are managed via the PropertyUtils class. OptimizelyFactory also provides setter methods to override the system properties at runtime.

• setMaxEventBatchSize(int)
• setMaxEventBatchInterval(long)
• setEventQueueParams(int, int)
• setBlockingTimeout(long, java.util.concurrent.TimeUnit)
• setPollingInterval(long, java.util.concurrent.TimeUnit)
• setSdkKey(java.lang.String)
• setDatafileAccessToken(java.lang.String)

Constructor Summary

Constructors

Constructor and Description
OptimizelyFactory()

Method Summary

Modifier and Type	Method and Description
static com.optimizely.ab.Optimizely	newDefaultInstance() Returns a new Optimizely instance based on preset configuration.
static com.optimizely.ab.Optimizely	newDefaultInstance(com.optimizely.ab.config.ProjectConfigManager configManager) Returns a new Optimizely instance based on preset configuration.
static com.optimizely.ab.Optimizely	newDefaultInstance(com.optimizely.ab.config.ProjectConfigManager configManager, com.optimizely.ab.notification.NotificationCenter notificationCenter) Returns a new Optimizely instance based on preset configuration.
static com.optimizely.ab.Optimizely	newDefaultInstance(com.optimizely.ab.config.ProjectConfigManager configManager, com.optimizely.ab.notification.NotificationCenter notificationCenter, com.optimizely.ab.event.EventHandler eventHandler) Returns a new Optimizely instance based on preset configuration.
static com.optimizely.ab.Optimizely	newDefaultInstance(java.lang.String sdkKey) Returns a new Optimizely instance based on preset configuration.
static com.optimizely.ab.Optimizely	newDefaultInstance(java.lang.String sdkKey, java.lang.String fallback) Returns a new Optimizely instance based on preset configuration.
static com.optimizely.ab.Optimizely	newDefaultInstance(java.lang.String sdkKey, java.lang.String fallback, java.lang.String datafileAccessToken) Returns a new Optimizely instance with authenticated datafile support.
static void	setBlockingTimeout(long blockingDuration, java.util.concurrent.TimeUnit blockingTimeout) Convenience method for setting the blocking timeout.
static void	setDatafileAccessToken(java.lang.String datafileAccessToken) Convenience method for setting the Datafile Access Token on System properties.
static void	setEventQueueParams(int queueCapacity, int numberWorkers) Convenience method for setting the required queueing parameters for event dispatching.
static void	setMaxEventBatchInterval(long batchInterval) Convenience method for setting the maximum time interval in milliseconds between event dispatches.
static void	setMaxEventBatchSize(int batchSize) Convenience method for setting the maximum number of events contained within a batch.
static void	setPollingInterval(long pollingDuration, java.util.concurrent.TimeUnit pollingTimeout) Convenience method for setting the polling interval on System properties.
static void	setSdkKey(java.lang.String sdkKey) Convenience method for setting the sdk key on System properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptimizelyFactory

public OptimizelyFactory()

Method Detail

setMaxEventBatchSize

public static void setMaxEventBatchSize(int batchSize)

Convenience method for setting the maximum number of events contained within a batch. AsyncEventHandler

Parameters:

batchSize - The max number of events for batching

setMaxEventBatchInterval

public static void setMaxEventBatchInterval(long batchInterval)

Convenience method for setting the maximum time interval in milliseconds between event dispatches. AsyncEventHandler

Parameters:

batchInterval - The max time interval for event batching

setEventQueueParams

public static void setEventQueueParams(int queueCapacity,
                                       int numberWorkers)

Convenience method for setting the required queueing parameters for event dispatching. AsyncEventHandler

Parameters:

queueCapacity - A depth of the event queue

numberWorkers - The number of workers

setBlockingTimeout

public static void setBlockingTimeout(long blockingDuration,
                                      java.util.concurrent.TimeUnit blockingTimeout)

Convenience method for setting the blocking timeout. HttpProjectConfigManager.Builder#withBlockingTimeout(Long, TimeUnit)

Parameters:

blockingDuration - The blocking time duration

blockingTimeout - The blocking time unit

setPollingInterval

public static void setPollingInterval(long pollingDuration,
                                      java.util.concurrent.TimeUnit pollingTimeout)

Convenience method for setting the polling interval on System properties. HttpProjectConfigManager.Builder#withPollingInterval(Long, TimeUnit)

Parameters:

pollingDuration - The polling interval

pollingTimeout - The polling time unit

setSdkKey

public static void setSdkKey(java.lang.String sdkKey)

Convenience method for setting the sdk key on System properties. HttpProjectConfigManager.Builder#withSdkKey(String)

Parameters:

sdkKey - The sdk key

setDatafileAccessToken

public static void setDatafileAccessToken(java.lang.String datafileAccessToken)

Convenience method for setting the Datafile Access Token on System properties. HttpProjectConfigManager.Builder#withDatafileAccessToken(String)

Parameters:

datafileAccessToken - The datafile access token

newDefaultInstance

public static com.optimizely.ab.Optimizely newDefaultInstance()

Returns a new Optimizely instance based on preset configuration.

Returns:

A new Optimizely instance

newDefaultInstance

public static com.optimizely.ab.Optimizely newDefaultInstance(java.lang.String sdkKey)

Returns a new Optimizely instance based on preset configuration. EventHandler - AsyncEventHandler ProjectConfigManager - HttpProjectConfigManager

Parameters:

sdkKey - SDK key used to build the ProjectConfigManager.

Returns:

A new Optimizely instance

newDefaultInstance

public static com.optimizely.ab.Optimizely newDefaultInstance(java.lang.String sdkKey,
                                                              java.lang.String fallback)

Returns a new Optimizely instance based on preset configuration. EventHandler - AsyncEventHandler ProjectConfigManager - HttpProjectConfigManager

Parameters:

sdkKey - SDK key used to build the ProjectConfigManager.

fallback - Fallback datafile string used by the ProjectConfigManager to be immediately available.

Returns:

A new Optimizely instance

newDefaultInstance

public static com.optimizely.ab.Optimizely newDefaultInstance(java.lang.String sdkKey,
                                                              java.lang.String fallback,
                                                              java.lang.String datafileAccessToken)

Returns a new Optimizely instance with authenticated datafile support.

Parameters:

sdkKey - SDK key used to build the ProjectConfigManager.

fallback - Fallback datafile string used by the ProjectConfigManager to be immediately available.

datafileAccessToken - Token for authenticated datafile access.

Returns:

A new Optimizely instance

newDefaultInstance

public static com.optimizely.ab.Optimizely newDefaultInstance(com.optimizely.ab.config.ProjectConfigManager configManager)

Returns a new Optimizely instance based on preset configuration. EventHandler - AsyncEventHandler

Parameters:

configManager - The ProjectConfigManager supplied to Optimizely instance.

Returns:

A new Optimizely instance

newDefaultInstance

public static com.optimizely.ab.Optimizely newDefaultInstance(com.optimizely.ab.config.ProjectConfigManager configManager,
                                                              com.optimizely.ab.notification.NotificationCenter notificationCenter)

Returns a new Optimizely instance based on preset configuration. EventHandler - AsyncEventHandler

Parameters:

configManager - The ProjectConfigManager supplied to Optimizely instance.

notificationCenter - The NotificationCenter supplied to Optimizely instance.

Returns:

A new Optimizely instance

newDefaultInstance

public static com.optimizely.ab.Optimizely newDefaultInstance(com.optimizely.ab.config.ProjectConfigManager configManager,
                                                              com.optimizely.ab.notification.NotificationCenter notificationCenter,
                                                              com.optimizely.ab.event.EventHandler eventHandler)

Returns a new Optimizely instance based on preset configuration.

Parameters:

configManager - The ProjectConfigManager supplied to Optimizely instance.

notificationCenter - The ProjectConfigManager supplied to Optimizely instance.

eventHandler - The EventHandler supplied to Optimizely instance.

Returns:

A new Optimizely instance