Forced Decision methods

Methods to force users into a specific variation.

These methods will help test and debug various flows of your client applications by forcing users into a specific variation.

The Java SDK will check forced decisions before making any decisions. If a matching item is found for the requested flag, the Java SDK will return the forced decision immediately (audience conditions and traffic allocations are ignored) before making normal decisions.

The following describes specific scenarios the Java SDK will follow:

Flag-to-Decision

  • SDK will look up at the beginning of any decide call for the given flag. If a matching Flag-to-Decision forced decision is found for the flag, it returns the decision.

Experiment-Rule-to-Decision

  • SDK will look up at the beginning of the decision for the given experiment rule (of the flag key). If a matching Experiment-Rule-to-Decision forced decision is found for the flag, it returns the decision.

Delivery-Rule-to-Decision

  • SDK will look up at the beginning of the decision for the given delivery rule (of the flag key). If a matching Delivery-Rule-to-Decision forced decision is found, it returns the decision.

❗️

Warning

You must associate your variation(s) to a flag rule before calling any Forced Decision methods.

On forced decisions, the Java SDK will fire impression events and notifications just like other normal decisions (unless disabled by the disableDecisionEvent option).

📘

These forced decisions are not persistent and will be cleared when the OptimizelyUserContext is re-initialized.

For more information about each method click on the method name below:

OptimizelyDecisionContext

public class OptimizelyDecisionContext {
   public OptimizelyDecisionContext(@Nonnull String flagKey, @Nullable String ruleKey);
  
   public String getFlagKey();
  
   public String getRuleKey();
}

OptimizelyForcedDecision

public class OptimizelyForcedDecision {
   public OptimizelyForcedDecision(@Nonnull String variationKey);
  
   public String getVariationKey();
}

Set Forced Decision Method - setForcedDecision()

Version

3.10.0

Description

Sets a forced decision (variationKey) for a given OptimizelyDecisionContext.

Parameters

This table lists the required and optional parameters for the Java SDK.

Parameter

Type

Description

context
required

Struct

An instance of OptimizelyDecisionContext with the required flagKey and optional ruleKey for the forced decision you want to set.

decision
required

Struct

An instance of OptimizelyForcedDecision with the required variationKey for the forced decision you want to set.

Returns

A boolean value that indicates if setting the forced decision (variationKey) was completed successfully.

Example

See the full Java SDK example here.

Get Forced Decision Method - getForcedDecision()

Version

3.10.0

Description

Returns the forced decision (variationKey) for a given OptimizelyDecisionContext. Returns the OptimizelyForcedDecision instance or null if there is no matching item.

Parameters

This table lists the required and optional parameters for the Java SDK.

Parameter

Type

Description

context
required

struct

An instance of OptimizelyDecisionContext with the required flagKey and optional ruleKey for the forced decision you want to get.

Returns

A forced decision OptimizelyForcedDecision instance for the context or null if there is no matching item.

Example

See the full Java SDK example here.

Remove Forced Decision Method - removeForcedDecision()

Version

3.10.0

Description

Removes the forced decision (variationKey) for a given OptimizelyDecisionContext.

Parameters

This table lists the required and optional parameters for the Java SDK.

Parameters

Type

Description

context
required

struct

An instance of OptimizelyDecisionContext with the required flagKey and optional ruleKey for the forced decision you want to remove.

Returns

A success/failure boolean status if the forced decision (variationKey) was removed.

Example

See the full Java SDK example here.

Remove All Forced Decisions Method - removeAllForcedDecisions()

Version

3.10.0

Description

Removes all forced decisions (variationKey) for the user context.

Parameters

This table lists the required and optional parameters for the Java SDK.

Parameters

Type

Description

None

N/A

N/A

Returns

A success/failure boolean status.

Example

See the full Java SDK example here.

Full Code Example

/* Create the Optimizely instance and provide the sdk-key */
Optimizely optimizely = OptimizelyFactory.newDefaultInstance("sdk-key");
/* Create the OptimizelyUserContext, passing in the UserId and Attributes */
OptimizelyUserContext user = optimizely.createUserContext("user-id", Collections.emptyMap());

OptimizelyDecisionContext flagContext = new OptimizelyDecisionContext("flag-1");
OptimizelyDecisionContext flagAndABTestContext = new OptimizelyDecisionContext("flag-1", "ab-test-1");
OptimizelyDecisionContext flagAndDeliveryRuleContext = new OptimizelyDecisionContext("flag-1", "delivery-1");
OptimizelyForcedDecision variationAForcedDecision = new OptimizelyForcedDecision("variation-a");
OptimizelyForcedDecision variationBForcedDecision = new OptimizelyForcedDecision("variation-b");
OptimizelyForcedDecision variationOnForcedDecision = new OptimizelyForcedDecision("on");
        
// set a forced decision for a flag
Boolean success = user.setForcedDecision(flagContext, variationAForcedDecision);
OptimizelyDecision decision = user.decide("flag-1");

// set a forced decision for an ab-test rule
success = user.setForcedDecision(flagAndABTestContext, variationBForcedDecision);
decision = user.decide("flag-1");

// set a forced variation for a delivery rule
success = user.setForcedDecision(flagAndDeliveryRuleContext, variationOnForcedDecision);
decision = user.decide("flag-1");

// get forced variations
OptimizelyForcedDecision forcedDecision = user.getForcedDecision(flagContext);
System.out.println("[ForcedDecision] variationKey = " + forcedDecision.getVariationKey()); 

// remove forced variations
success = user.removeForcedDecision(flagAndABTestContext);
success = user.removeAllForcedDecisions();

See Also

OptimizelyUserContext