com.optimizely.ab.bucketing

Class DecisionService

java.lang.Object

com.optimizely.ab.bucketing.DecisionService

public class DecisionService
extends java.lang.Object

Optimizely's decision service that determines which variation of an experiment the user will be allocated to. The decision service contains all logic around how a user decision is made. This includes all of the following: 1. Checking experiment status 2. Checking whitelisting 3. Checking sticky bucketing 4. Checking audience targeting 5. Using Murmurhash3 to bucket the user.

Constructor Summary

Constructors

Constructor and Description
DecisionService(Bucketer bucketer, ErrorHandler errorHandler, UserProfileService userProfileService) Initialize a decision service for the Optimizely client.

Method Summary

Modifier and Type	Method and Description
DecisionResponse<Variation>	getForcedVariation(Experiment experiment, java.lang.String userId) Gets the forced variation for a given user and experiment.
java.util.concurrent.ConcurrentHashMap<java.lang.String,java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.String>>	getForcedVariationMapping()
DecisionResponse<Variation>	getVariation(Experiment experiment, OptimizelyUserContext user, ProjectConfig projectConfig)
DecisionResponse<Variation>	getVariation(Experiment experiment, OptimizelyUserContext user, ProjectConfig projectConfig, java.util.List<OptimizelyDecideOption> options) Get a Variation of an Experiment for a user to be allocated into.
DecisionResponse<FeatureDecision>	getVariationForFeature(FeatureFlag featureFlag, OptimizelyUserContext user, ProjectConfig projectConfig)
DecisionResponse<FeatureDecision>	getVariationForFeature(FeatureFlag featureFlag, OptimizelyUserContext user, ProjectConfig projectConfig, java.util.List<OptimizelyDecideOption> options) Get the variation the user is bucketed into for the FeatureFlag
DecisionResponse<Variation>	getVariationFromExperimentRule(ProjectConfig projectConfig, java.lang.String flagKey, Experiment rule, OptimizelyUserContext user, java.util.List<OptimizelyDecideOption> options)
boolean	setForcedVariation(Experiment experiment, java.lang.String userId, java.lang.String variationKey) Force a user into a variation for a given experiment.
DecisionResponse<Variation>	validatedForcedDecision(OptimizelyDecisionContext optimizelyDecisionContext, ProjectConfig projectConfig, OptimizelyUserContext user) Find a validated forced decision

Methods inherited from class java.lang.Object

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

Constructor Detail

DecisionService

public DecisionService(@Nonnull
                       Bucketer bucketer,
                       @Nonnull
                       ErrorHandler errorHandler,
                       @Nullable
                       UserProfileService userProfileService)

Initialize a decision service for the Optimizely client.

Parameters:

bucketer - Base bucketer to allocate new users to an experiment.

errorHandler - The error handler of the Optimizely client.

userProfileService - UserProfileService implementation for storing user info.

Method Detail

getVariation

@Nonnull
public DecisionResponse<Variation> getVariation(@Nonnull
                                                         Experiment experiment,
                                                         @Nonnull
                                                         OptimizelyUserContext user,
                                                         @Nonnull
                                                         ProjectConfig projectConfig,
                                                         @Nonnull
                                                         java.util.List<OptimizelyDecideOption> options)

Get a Variation of an Experiment for a user to be allocated into.

Parameters:

experiment - The Experiment the user will be bucketed into.

user - The current OptimizelyUserContext

projectConfig - The current projectConfig

options - An array of decision options

Returns:

A DecisionResponse including the Variation that user is bucketed into (or null) and the decision reasons

getVariation

@Nonnull
public DecisionResponse<Variation> getVariation(@Nonnull
                                                         Experiment experiment,
                                                         @Nonnull
                                                         OptimizelyUserContext user,
                                                         @Nonnull
                                                         ProjectConfig projectConfig)

getVariationForFeature

@Nonnull
public DecisionResponse<FeatureDecision> getVariationForFeature(@Nonnull
                                                                         FeatureFlag featureFlag,
                                                                         @Nonnull
                                                                         OptimizelyUserContext user,
                                                                         @Nonnull
                                                                         ProjectConfig projectConfig,
                                                                         @Nonnull
                                                                         java.util.List<OptimizelyDecideOption> options)

Get the variation the user is bucketed into for the FeatureFlag

Parameters:

featureFlag - The feature flag the user wants to access.

user - The current OptimizelyuserContext

projectConfig - The current projectConfig

options - An array of decision options

Returns:

A DecisionResponse including a FeatureDecision and the decision reasons

getVariationForFeature

@Nonnull
public DecisionResponse<FeatureDecision> getVariationForFeature(@Nonnull
                                                                         FeatureFlag featureFlag,
                                                                         @Nonnull
                                                                         OptimizelyUserContext user,
                                                                         @Nonnull
                                                                         ProjectConfig projectConfig)

validatedForcedDecision

public DecisionResponse<Variation> validatedForcedDecision(@Nonnull
                                                           OptimizelyDecisionContext optimizelyDecisionContext,
                                                           @Nonnull
                                                           ProjectConfig projectConfig,
                                                           @Nonnull
                                                           OptimizelyUserContext user)

Find a validated forced decision

Parameters:

optimizelyDecisionContext - The OptimizelyDecisionContext containing flagKey and ruleKey

projectConfig - The Project config

user - The OptimizelyUserContext

Returns:

Returns a DecisionResponse structure of type Variation, otherwise null result with reasons

getForcedVariationMapping

public java.util.concurrent.ConcurrentHashMap<java.lang.String,java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.String>> getForcedVariationMapping()

setForcedVariation

public boolean setForcedVariation(@Nonnull
                                  Experiment experiment,
                                  @Nonnull
                                  java.lang.String userId,
                                  @Nullable
                                  java.lang.String variationKey)

Force a user into a variation for a given experiment. The forced variation value does not persist across application launches. If the experiment key is not in the project file, this call fails and returns false.

Parameters:

experiment - The experiment to override.

userId - The user ID to be used for bucketing.

variationKey - The variation key to force the user into. If the variation key is null then the forcedVariation for that experiment is removed.

Returns:

boolean A boolean value that indicates if the set completed successfully.

getForcedVariation

@Nonnull
public DecisionResponse<Variation> getForcedVariation(@Nonnull
                                                               Experiment experiment,
                                                               @Nonnull
                                                               java.lang.String userId)

Gets the forced variation for a given user and experiment.

Parameters:

experiment - The experiment forced.

userId - The user ID to be used for bucketing.

Returns:

A DecisionResponse including the Variation that user is bucketed into (or null) and the decision reasons. The variation can be null if the forced variation fails.

getVariationFromExperimentRule

public DecisionResponse<Variation> getVariationFromExperimentRule(@Nonnull
                                                                  ProjectConfig projectConfig,
                                                                  @Nonnull
                                                                  java.lang.String flagKey,
                                                                  @Nonnull
                                                                  Experiment rule,
                                                                  @Nonnull
                                                                  OptimizelyUserContext user,
                                                                  @Nonnull
                                                                  java.util.List<OptimizelyDecideOption> options)