com.optimizely.ab.config

Class PollingProjectConfigManager

java.lang.Object

com.optimizely.ab.config.PollingProjectConfigManager

All Implemented Interfaces:

ProjectConfigManager, OptimizelyConfigManager, java.lang.AutoCloseable

public abstract class PollingProjectConfigManager
extends java.lang.Object
implements ProjectConfigManager, java.lang.AutoCloseable, OptimizelyConfigManager

PollingProjectConfigManager is an abstract class that provides basic scheduling and caching. Instances of this class, must implement the poll() method which is responsible for fetching a given ProjectConfig. If this class is never started then calls will be made directly to poll() since no scheduled execution is being performed. Calling getConfig() should block until the ProjectConfig is initially set. A default ProjectConfig can be provided to bootstrap the initial ProjectConfig return value and prevent blocking.

Constructor Summary

Constructors

Constructor and Description
PollingProjectConfigManager(long period, java.util.concurrent.TimeUnit timeUnit)
PollingProjectConfigManager(long period, java.util.concurrent.TimeUnit timeUnit, long blockingTimeoutPeriod, java.util.concurrent.TimeUnit blockingTimeoutUnit, NotificationCenter notificationCenter)
PollingProjectConfigManager(long period, java.util.concurrent.TimeUnit timeUnit, NotificationCenter notificationCenter)

Method Summary

Modifier and Type	Method and Description
void	close()
ProjectConfig	getCachedConfig() Access to current cached project configuration, This is to make sure that config returns without any wait, even if it is null.
ProjectConfig	getConfig() If the instance was never started, then call getConfig() directly from the inner ProjectConfigManager.
NotificationCenter	getNotificationCenter()
OptimizelyConfig	getOptimizelyConfig() Returns the cached OptimizelyConfig
java.lang.String	getSDKKey() Implementations of this method should return SDK key.
boolean	isRunning()
protected abstract ProjectConfig	poll()
protected void	setSdkKey(java.lang.String sdkKey)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

PollingProjectConfigManager

public PollingProjectConfigManager(long period,
                                   java.util.concurrent.TimeUnit timeUnit)

PollingProjectConfigManager

public PollingProjectConfigManager(long period,
                                   java.util.concurrent.TimeUnit timeUnit,
                                   NotificationCenter notificationCenter)

PollingProjectConfigManager

public PollingProjectConfigManager(long period,
                                   java.util.concurrent.TimeUnit timeUnit,
                                   long blockingTimeoutPeriod,
                                   java.util.concurrent.TimeUnit blockingTimeoutUnit,
                                   NotificationCenter notificationCenter)

Method Detail

poll

protected abstract ProjectConfig poll()

getCachedConfig

public ProjectConfig getCachedConfig()

Access to current cached project configuration, This is to make sure that config returns without any wait, even if it is null.

Specified by:

getCachedConfig in interface ProjectConfigManager

Returns:

ProjectConfig

getNotificationCenter

public NotificationCenter getNotificationCenter()

getConfig

public ProjectConfig getConfig()

If the instance was never started, then call getConfig() directly from the inner ProjectConfigManager. else, wait until the ProjectConfig is set or the timeout expires.

Specified by:

getConfig in interface ProjectConfigManager

Returns:

ProjectConfig

getOptimizelyConfig

public OptimizelyConfig getOptimizelyConfig()

Returns the cached OptimizelyConfig

Specified by:

getOptimizelyConfig in interface OptimizelyConfigManager

Returns:

OptimizelyConfig

getSDKKey

public java.lang.String getSDKKey()

Description copied from interface: ProjectConfigManager

Implementations of this method should return SDK key. If there is no SDKKey then it should return null. NOTE: To update ODP segments configuration via polling, it is required to return sdkKey.

Specified by:

getSDKKey in interface ProjectConfigManager

Returns:

String

start

public void start()

stop

public void stop()

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

setSdkKey

protected void setSdkKey(java.lang.String sdkKey)

isRunning

public boolean isRunning()