com.optimizely.ab.config

Class DatafileProjectConfig

java.lang.Object

com.optimizely.ab.config.DatafileProjectConfig

All Implemented Interfaces:

ProjectConfig

public class DatafileProjectConfig
extends java.lang.Object
implements ProjectConfig

DatafileProjectConfig is an implementation of ProjectConfig that is backed by a JSON data file. Optimizely automatically publishes new versions of the data file to it's CDN whenever changes are made within the Optimizely Application. Optimizely provides custom JSON parsers to extract objects from the JSON payload to populate the members of this class. DefaultConfigParser for details.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatafileProjectConfig.Builder

Nested classes/interfaces inherited from interface com.optimizely.ab.config.ProjectConfig

ProjectConfig.Version

Field Summary

Fields inherited from interface com.optimizely.ab.config.ProjectConfig

RESERVED_ATTRIBUTE_PREFIX

Constructor Summary

Constructors

Constructor and Description
DatafileProjectConfig(java.lang.String accountId, boolean anonymizeIP, boolean sendFlagDecisions, java.lang.Boolean botFiltering, java.lang.String projectId, java.lang.String revision, java.lang.String sdkKey, java.lang.String environmentKey, java.lang.String version, java.util.List<Attribute> attributes, java.util.List<Audience> audiences, java.util.List<Audience> typedAudiences, java.util.List<EventType> events, java.util.List<Experiment> experiments, java.util.List<FeatureFlag> featureFlags, java.util.List<Group> groups, java.util.List<Rollout> rollouts, java.util.List<Integration> integrations)
DatafileProjectConfig(java.lang.String accountId, java.lang.String projectId, java.lang.String version, java.lang.String revision, java.util.List<Group> groups, java.util.List<Experiment> experiments, java.util.List<Attribute> attributes, java.util.List<EventType> eventType, java.util.List<Audience> audiences)
DatafileProjectConfig(java.lang.String accountId, java.lang.String projectId, java.lang.String version, java.lang.String revision, java.util.List<Group> groups, java.util.List<Experiment> experiments, java.util.List<Attribute> attributes, java.util.List<EventType> eventType, java.util.List<Audience> audiences, boolean anonymizeIP)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccountId()
java.util.Set<java.lang.String>	getAllSegments()
boolean	getAnonymizeIP()
java.lang.String	getAttributeId(ProjectConfig projectConfig, java.lang.String attributeKey) Checks is attributeKey is reserved or not and if it exist in attributeKeyMapping
java.util.Map<java.lang.String,Attribute>	getAttributeKeyMapping()
java.util.List<Attribute>	getAttributes()
Audience	getAudience(java.lang.String audienceId)
java.util.Map<java.lang.String,Audience>	getAudienceIdMapping()
java.util.List<Audience>	getAudiences()
java.lang.Boolean	getBotFiltering()
java.lang.String	getEnvironmentKey()
java.util.Map<java.lang.String,EventType>	getEventNameMapping()
EventType	getEventTypeForName(java.lang.String eventName, ErrorHandler errorHandler) Helper method to retrieve the EventType for the given event name.
java.util.List<EventType>	getEventTypes()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getExperimentFeatureKeyMapping()
Experiment	getExperimentForKey(java.lang.String experimentKey, ErrorHandler errorHandler) Helper method to retrieve the Experiment for the given experiment key.
Experiment	getExperimentForVariationId(java.lang.String variationId)
java.util.Map<java.lang.String,Experiment>	getExperimentIdMapping()
java.util.Map<java.lang.String,Experiment>	getExperimentKeyMapping()
java.util.List<Experiment>	getExperiments()
java.util.List<Experiment>	getExperimentsForEventKey(java.lang.String eventKey)
java.util.List<FeatureFlag>	getFeatureFlags()
java.util.Map<java.lang.String,FeatureFlag>	getFeatureKeyMapping()
Variation	getFlagVariationByKey(java.lang.String flagKey, java.lang.String variationKey) Gets a variation based on flagKey and variationKey
java.util.Map<java.lang.String,java.util.List<Variation>>	getFlagVariationsMap()
java.util.Map<java.lang.String,Group>	getGroupIdMapping()
java.util.List<Group>	getGroups()
java.lang.String	getHostForODP()
java.util.List<Integration>	getIntegrations()
java.lang.String	getProjectId()
java.lang.String	getPublicKeyForODP()
java.lang.String	getRevision()
java.util.Map<java.lang.String,Rollout>	getRolloutIdMapping()
java.util.List<Rollout>	getRollouts()
java.lang.String	getSdkKey()
boolean	getSendFlagDecisions()
java.util.List<Audience>	getTypedAudiences()
java.lang.String	getVersion()
java.lang.String	toDatafile()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DatafileProjectConfig

public DatafileProjectConfig(java.lang.String accountId,
                             java.lang.String projectId,
                             java.lang.String version,
                             java.lang.String revision,
                             java.util.List<Group> groups,
                             java.util.List<Experiment> experiments,
                             java.util.List<Attribute> attributes,
                             java.util.List<EventType> eventType,
                             java.util.List<Audience> audiences)

DatafileProjectConfig

public DatafileProjectConfig(java.lang.String accountId,
                             java.lang.String projectId,
                             java.lang.String version,
                             java.lang.String revision,
                             java.util.List<Group> groups,
                             java.util.List<Experiment> experiments,
                             java.util.List<Attribute> attributes,
                             java.util.List<EventType> eventType,
                             java.util.List<Audience> audiences,
                             boolean anonymizeIP)

DatafileProjectConfig

public DatafileProjectConfig(java.lang.String accountId,
                             boolean anonymizeIP,
                             boolean sendFlagDecisions,
                             java.lang.Boolean botFiltering,
                             java.lang.String projectId,
                             java.lang.String revision,
                             java.lang.String sdkKey,
                             java.lang.String environmentKey,
                             java.lang.String version,
                             java.util.List<Attribute> attributes,
                             java.util.List<Audience> audiences,
                             java.util.List<Audience> typedAudiences,
                             java.util.List<EventType> events,
                             java.util.List<Experiment> experiments,
                             java.util.List<FeatureFlag> featureFlags,
                             java.util.List<Group> groups,
                             java.util.List<Rollout> rollouts,
                             java.util.List<Integration> integrations)

Method Detail

getExperimentForKey

@CheckForNull
public Experiment getExperimentForKey(@Nonnull
                                                    java.lang.String experimentKey,
                                                    @Nonnull
                                                    ErrorHandler errorHandler)

Helper method to retrieve the Experiment for the given experiment key. If RaiseExceptionErrorHandler is provided, either an experiment is returned, or an exception is sent to the error handler if there are no experiments in the project config with the given experiment key. If NoOpErrorHandler is used, either an experiment or null is returned.

Specified by:

getExperimentForKey in interface ProjectConfig

Parameters:

experimentKey - the experiment to retrieve from the current project config

errorHandler - the error handler to send exceptions to

Returns:

the experiment for given experiment key

getEventTypeForName

@CheckForNull
public EventType getEventTypeForName(java.lang.String eventName,
                                                   ErrorHandler errorHandler)

Helper method to retrieve the EventType for the given event name. If RaiseExceptionErrorHandler is provided, either an event type is returned, or an exception is sent to the error handler if there are no event types in the project config with the given name. If NoOpErrorHandler is used, either an event type or null is returned.

Specified by:

getEventTypeForName in interface ProjectConfig

Parameters:

eventName - the event type to retrieve from the current project config

errorHandler - the error handler to send exceptions to

Returns:

the event type for the given event name

getExperimentForVariationId

@Nullable
public Experiment getExperimentForVariationId(java.lang.String variationId)

Specified by:

getExperimentForVariationId in interface ProjectConfig

getAttributeId

public java.lang.String getAttributeId(ProjectConfig projectConfig,
                                       java.lang.String attributeKey)

Checks is attributeKey is reserved or not and if it exist in attributeKeyMapping

Specified by:

getAttributeId in interface ProjectConfig

Parameters:

attributeKey - The attribute key

Returns:

AttributeId corresponding to AttributeKeyMapping, AttributeKey when it's a reserved attribute and null when attributeKey is equal to BOT_FILTERING_ATTRIBUTE key.

getAccountId

public java.lang.String getAccountId()

Specified by:

getAccountId in interface ProjectConfig

toDatafile

public java.lang.String toDatafile()

Specified by:

toDatafile in interface ProjectConfig

getProjectId

public java.lang.String getProjectId()

Specified by:

getProjectId in interface ProjectConfig

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface ProjectConfig

getRevision

public java.lang.String getRevision()

Specified by:

getRevision in interface ProjectConfig

getSdkKey

public java.lang.String getSdkKey()

Specified by:

getSdkKey in interface ProjectConfig

getEnvironmentKey

public java.lang.String getEnvironmentKey()

Specified by:

getEnvironmentKey in interface ProjectConfig

getSendFlagDecisions

public boolean getSendFlagDecisions()

Specified by:

getSendFlagDecisions in interface ProjectConfig

getAnonymizeIP

public boolean getAnonymizeIP()

Specified by:

getAnonymizeIP in interface ProjectConfig

getBotFiltering

public java.lang.Boolean getBotFiltering()

Specified by:

getBotFiltering in interface ProjectConfig

getGroups

public java.util.List<Group> getGroups()

Specified by:

getGroups in interface ProjectConfig

getExperiments

public java.util.List<Experiment> getExperiments()

Specified by:

getExperiments in interface ProjectConfig

getAllSegments

public java.util.Set<java.lang.String> getAllSegments()

Specified by:

getAllSegments in interface ProjectConfig

getExperimentsForEventKey

public java.util.List<Experiment> getExperimentsForEventKey(java.lang.String eventKey)

Specified by:

getExperimentsForEventKey in interface ProjectConfig

getFeatureFlags

public java.util.List<FeatureFlag> getFeatureFlags()

Specified by:

getFeatureFlags in interface ProjectConfig

getRollouts

public java.util.List<Rollout> getRollouts()

Specified by:

getRollouts in interface ProjectConfig

getAttributes

public java.util.List<Attribute> getAttributes()

Specified by:

getAttributes in interface ProjectConfig

getEventTypes

public java.util.List<EventType> getEventTypes()

Specified by:

getEventTypes in interface ProjectConfig

getAudiences

public java.util.List<Audience> getAudiences()

Specified by:

getAudiences in interface ProjectConfig

getTypedAudiences

public java.util.List<Audience> getTypedAudiences()

Specified by:

getTypedAudiences in interface ProjectConfig

getIntegrations

public java.util.List<Integration> getIntegrations()

Specified by:

getIntegrations in interface ProjectConfig

getAudience

public Audience getAudience(java.lang.String audienceId)

Specified by:

getAudience in interface ProjectConfig

getExperimentKeyMapping

public java.util.Map<java.lang.String,Experiment> getExperimentKeyMapping()

Specified by:

getExperimentKeyMapping in interface ProjectConfig

getAttributeKeyMapping

public java.util.Map<java.lang.String,Attribute> getAttributeKeyMapping()

Specified by:

getAttributeKeyMapping in interface ProjectConfig

getEventNameMapping

public java.util.Map<java.lang.String,EventType> getEventNameMapping()

Specified by:

getEventNameMapping in interface ProjectConfig

getAudienceIdMapping

public java.util.Map<java.lang.String,Audience> getAudienceIdMapping()

Specified by:

getAudienceIdMapping in interface ProjectConfig

getExperimentIdMapping

public java.util.Map<java.lang.String,Experiment> getExperimentIdMapping()

Specified by:

getExperimentIdMapping in interface ProjectConfig

getGroupIdMapping

public java.util.Map<java.lang.String,Group> getGroupIdMapping()

Specified by:

getGroupIdMapping in interface ProjectConfig

getRolloutIdMapping

public java.util.Map<java.lang.String,Rollout> getRolloutIdMapping()

Specified by:

getRolloutIdMapping in interface ProjectConfig

getFeatureKeyMapping

public java.util.Map<java.lang.String,FeatureFlag> getFeatureKeyMapping()

Specified by:

getFeatureKeyMapping in interface ProjectConfig

getExperimentFeatureKeyMapping

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getExperimentFeatureKeyMapping()

Specified by:

getExperimentFeatureKeyMapping in interface ProjectConfig

getFlagVariationsMap

public java.util.Map<java.lang.String,java.util.List<Variation>> getFlagVariationsMap()

Specified by:

getFlagVariationsMap in interface ProjectConfig

getFlagVariationByKey

public Variation getFlagVariationByKey(java.lang.String flagKey,
                                       java.lang.String variationKey)

Gets a variation based on flagKey and variationKey

Specified by:

getFlagVariationByKey in interface ProjectConfig

Parameters:

flagKey - The flag key for the variation

variationKey - The variation key for the variation

Returns:

Returns a variation based on flagKey and variationKey, otherwise null

getHostForODP

public java.lang.String getHostForODP()

Specified by:

getHostForODP in interface ProjectConfig

getPublicKeyForODP

public java.lang.String getPublicKeyForODP()

Specified by:

getPublicKeyForODP in interface ProjectConfig

toString

public java.lang.String toString()

Specified by:

toString in interface ProjectConfig

Overrides:

toString in class java.lang.Object