com.optimizely.ab

Class OptimizelyUserContext

java.lang.Object

com.optimizely.ab.OptimizelyUserContext

public class OptimizelyUserContext
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
OptimizelyUserContext(Optimizely optimizely, java.lang.String userId)
OptimizelyUserContext(Optimizely optimizely, java.lang.String userId, java.util.Map<java.lang.String,?> attributes)
OptimizelyUserContext(Optimizely optimizely, java.lang.String userId, java.util.Map<java.lang.String,?> attributes, java.util.Map<java.lang.String,OptimizelyForcedDecision> forcedDecisionsMap, java.util.List<java.lang.String> qualifiedSegments)
OptimizelyUserContext(Optimizely optimizely, java.lang.String userId, java.util.Map<java.lang.String,?> attributes, java.util.Map<java.lang.String,OptimizelyForcedDecision> forcedDecisionsMap, java.util.List<java.lang.String> qualifiedSegments, java.lang.Boolean shouldIdentifyUser)

Method Summary

Modifier and Type	Method and Description
OptimizelyUserContext	copy()
OptimizelyDecision	decide(java.lang.String key) Returns a decision result (OptimizelyDecision) for a given flag key and a user context, which contains all data required to deliver the flag.
OptimizelyDecision	decide(java.lang.String key, java.util.List<OptimizelyDecideOption> options) Returns a decision result (OptimizelyDecision) for a given flag key and a user context, which contains all data required to deliver the flag.
java.util.Map<java.lang.String,OptimizelyDecision>	decideAll() Returns a key-map of decision results (OptimizelyDecision) for all active flag keys.
java.util.Map<java.lang.String,OptimizelyDecision>	decideAll(java.util.List<OptimizelyDecideOption> options) Returns a key-map of decision results (OptimizelyDecision) for all active flag keys.
java.util.Map<java.lang.String,OptimizelyDecision>	decideForKeys(java.util.List<java.lang.String> keys) Returns a key-map of decision results for multiple flag keys and a user context.
java.util.Map<java.lang.String,OptimizelyDecision>	decideForKeys(java.util.List<java.lang.String> keys, java.util.List<OptimizelyDecideOption> options) Returns a key-map of decision results (OptimizelyDecision) for multiple flag keys and a user context.
boolean	equals(java.lang.Object obj)
java.lang.Boolean	fetchQualifiedSegments() Fetch all qualified segments for the user context.
java.lang.Boolean	fetchQualifiedSegments(java.util.List<ODPSegmentOption> segmentOptions) Fetch all qualified segments for the user context.
void	fetchQualifiedSegments(ODPSegmentCallback callback) Fetch all qualified segments for the user context in a non-blocking manner.
void	fetchQualifiedSegments(ODPSegmentCallback callback, java.util.List<ODPSegmentOption> segmentOptions) Fetch all qualified segments for the user context in a non-blocking manner.
OptimizelyForcedDecision	findForcedDecision(OptimizelyDecisionContext optimizelyDecisionContext) Finds a forced decision
java.util.Map<java.lang.String,java.lang.Object>	getAttributes()
OptimizelyForcedDecision	getForcedDecision(OptimizelyDecisionContext optimizelyDecisionContext) Get a forced decision
Optimizely	getOptimizely()
java.util.List<java.lang.String>	getQualifiedSegments()
java.lang.String	getUserId()
int	hashCode()
boolean	isQualifiedFor(java.lang.String segment) Returns true if the user is qualified for the given segment name
boolean	removeAllForcedDecisions() Remove all forced decisions
boolean	removeForcedDecision(OptimizelyDecisionContext optimizelyDecisionContext) Remove a forced decision
void	setAttribute(java.lang.String key, java.lang.Object value) Set an attribute for a given key.
java.lang.Boolean	setForcedDecision(OptimizelyDecisionContext optimizelyDecisionContext, OptimizelyForcedDecision optimizelyForcedDecision) Set a forced decision
void	setQualifiedSegments(java.util.List<java.lang.String> qualifiedSegments)
java.lang.String	toString()
void	trackEvent(java.lang.String eventName) Track an event.
void	trackEvent(java.lang.String eventName, java.util.Map<java.lang.String,?> eventTags) Track an event.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OptimizelyUserContext

public OptimizelyUserContext(@Nonnull
                             Optimizely optimizely,
                             @Nonnull
                             java.lang.String userId,
                             @Nonnull
                             java.util.Map<java.lang.String,?> attributes)

OptimizelyUserContext

public OptimizelyUserContext(@Nonnull
                             Optimizely optimizely,
                             @Nonnull
                             java.lang.String userId,
                             @Nonnull
                             java.util.Map<java.lang.String,?> attributes,
                             @Nullable
                             java.util.Map<java.lang.String,OptimizelyForcedDecision> forcedDecisionsMap,
                             @Nullable
                             java.util.List<java.lang.String> qualifiedSegments)

OptimizelyUserContext

public OptimizelyUserContext(@Nonnull
                             Optimizely optimizely,
                             @Nonnull
                             java.lang.String userId,
                             @Nonnull
                             java.util.Map<java.lang.String,?> attributes,
                             @Nullable
                             java.util.Map<java.lang.String,OptimizelyForcedDecision> forcedDecisionsMap,
                             @Nullable
                             java.util.List<java.lang.String> qualifiedSegments,
                             @Nullable
                             java.lang.Boolean shouldIdentifyUser)

OptimizelyUserContext

public OptimizelyUserContext(@Nonnull
                             Optimizely optimizely,
                             @Nonnull
                             java.lang.String userId)

Method Detail

getUserId

public java.lang.String getUserId()

getAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAttributes()

getOptimizely

public Optimizely getOptimizely()

copy

public OptimizelyUserContext copy()

isQualifiedFor

public boolean isQualifiedFor(@Nonnull
                              java.lang.String segment)

Returns true if the user is qualified for the given segment name

Parameters:

segment - A String segment key which will be checked in the qualified segments list that if it exists then user is qualified.

Returns:

boolean Is user qualified for a segment.

setAttribute

public void setAttribute(@Nonnull
                         java.lang.String key,
                         @Nullable
                         java.lang.Object value)

Set an attribute for a given key.

Parameters:

key - An attribute key

value - An attribute value

decide

public OptimizelyDecision decide(@Nonnull
                                 java.lang.String key,
                                 @Nonnull
                                 java.util.List<OptimizelyDecideOption> options)

Returns a decision result (OptimizelyDecision) for a given flag key and a user context, which contains all data required to deliver the flag.

• If the SDK finds an error, it’ll return a decision with null for variationKey. The decision will include an error message in reasons.

Parameters:

key - A flag key for which a decision will be made.

options - A list of options for decision-making.

Returns:

A decision result.

decide

public OptimizelyDecision decide(@Nonnull
                                 java.lang.String key)

Returns a decision result (OptimizelyDecision) for a given flag key and a user context, which contains all data required to deliver the flag.

Parameters:

key - A flag key for which a decision will be made.

Returns:

A decision result.

decideForKeys

public java.util.Map<java.lang.String,OptimizelyDecision> decideForKeys(@Nonnull
                                                                        java.util.List<java.lang.String> keys,
                                                                        @Nonnull
                                                                        java.util.List<OptimizelyDecideOption> options)

Returns a key-map of decision results (OptimizelyDecision) for multiple flag keys and a user context.

• If the SDK finds an error for a key, the response will include a decision for the key showing reasons for the error.
• The SDK will always return key-mapped decisions. When it can not process requests, it’ll return an empty map after logging the errors.

Parameters:

keys - A list of flag keys for which decisions will be made.

options - A list of options for decision-making.

Returns:

All decision results mapped by flag keys.

decideForKeys

public java.util.Map<java.lang.String,OptimizelyDecision> decideForKeys(@Nonnull
                                                                        java.util.List<java.lang.String> keys)

Returns a key-map of decision results for multiple flag keys and a user context.

Parameters:

keys - A list of flag keys for which decisions will be made.

Returns:

All decision results mapped by flag keys.

decideAll

public java.util.Map<java.lang.String,OptimizelyDecision> decideAll(@Nonnull
                                                                    java.util.List<OptimizelyDecideOption> options)

Returns a key-map of decision results (OptimizelyDecision) for all active flag keys.

Parameters:

options - A list of options for decision-making.

Returns:

All decision results mapped by flag keys.

decideAll

public java.util.Map<java.lang.String,OptimizelyDecision> decideAll()

Returns a key-map of decision results (OptimizelyDecision) for all active flag keys.

Returns:

A dictionary of all decision results, mapped by flag keys.

trackEvent

public void trackEvent(@Nonnull
                       java.lang.String eventName,
                       @Nonnull
                       java.util.Map<java.lang.String,?> eventTags)
                throws UnknownEventTypeException

Track an event.

Parameters:

eventName - The event name.

eventTags - A map of event tag names to event tag values.

Throws:

UnknownEventTypeException - when event type is unknown

trackEvent

public void trackEvent(@Nonnull
                       java.lang.String eventName)
                throws UnknownEventTypeException

Track an event.

Parameters:

eventName - The event name.

Throws:

UnknownEventTypeException - when event type is unknown

setForcedDecision

public java.lang.Boolean setForcedDecision(@Nonnull
                                           OptimizelyDecisionContext optimizelyDecisionContext,
                                           @Nonnull
                                           OptimizelyForcedDecision optimizelyForcedDecision)

Set a forced decision

Parameters:

optimizelyDecisionContext - The OptimizelyDecisionContext containing flagKey and ruleKey

optimizelyForcedDecision - The OptimizelyForcedDecision containing the variationKey

Returns:

Returns a boolean, Ture if successfully set, otherwise false

getForcedDecision

@Nullable
public OptimizelyForcedDecision getForcedDecision(@Nonnull
                                                            OptimizelyDecisionContext optimizelyDecisionContext)

Get a forced decision

Parameters:

optimizelyDecisionContext - The OptimizelyDecisionContext containing flagKey and ruleKey

Returns:

Returns a variationKey for a given forced decision

findForcedDecision

@Nullable
public OptimizelyForcedDecision findForcedDecision(@Nonnull
                                                             OptimizelyDecisionContext optimizelyDecisionContext)

Finds a forced decision

Parameters:

optimizelyDecisionContext - The OptimizelyDecisionContext containing flagKey and ruleKey

Returns:

Returns a variationKey relating to the found forced decision, otherwise null

removeForcedDecision

public boolean removeForcedDecision(@Nonnull
                                    OptimizelyDecisionContext optimizelyDecisionContext)

Remove a forced decision

Parameters:

optimizelyDecisionContext - The OptimizelyDecisionContext containing flagKey and ruleKey

Returns:

Returns a boolean, true if successfully removed, otherwise false

removeAllForcedDecisions

public boolean removeAllForcedDecisions()

Remove all forced decisions

Returns:

Returns a boolean, True if successfully, otherwise false

getQualifiedSegments

public java.util.List<java.lang.String> getQualifiedSegments()

setQualifiedSegments

public void setQualifiedSegments(java.util.List<java.lang.String> qualifiedSegments)

fetchQualifiedSegments

public java.lang.Boolean fetchQualifiedSegments()

Fetch all qualified segments for the user context.

The segments fetched will be saved and can be accessed at any time by calling getQualifiedSegments().

Returns:

a boolean value for fetch success or failure.

fetchQualifiedSegments

public java.lang.Boolean fetchQualifiedSegments(@Nonnull
                                                java.util.List<ODPSegmentOption> segmentOptions)

Fetch all qualified segments for the user context.

The segments fetched will be saved and can be accessed at any time by calling getQualifiedSegments().

Parameters:

segmentOptions - A set of options for fetching qualified segments.

Returns:

a boolean value for fetch success or failure.

fetchQualifiedSegments

public void fetchQualifiedSegments(ODPSegmentCallback callback,
                                   java.util.List<ODPSegmentOption> segmentOptions)

Fetch all qualified segments for the user context in a non-blocking manner. This method will fetch segments in a separate thread and invoke the provided callback when results are available.

The segments fetched will be saved and can be accessed at any time by calling getQualifiedSegments().

Parameters:

callback - A callback to invoke when results are available.

segmentOptions - A set of options for fetching qualified segments.

fetchQualifiedSegments

public void fetchQualifiedSegments(ODPSegmentCallback callback)

Fetch all qualified segments for the user context in a non-blocking manner. This method will fetch segments in a separate thread and invoke the provided callback when results are available.

The segments fetched will be saved and can be accessed at any time by calling getQualifiedSegments().

Parameters:

callback - A callback to invoke when results are available.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object