com.optimizely.ab.bucketing

Interface UserProfileService

public interface UserProfileService

Class encapsulating user profile service functionality. Override with your own implementation for storing and retrieving the user profile.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	experimentBucketMapKey The key for the decisions Map.
static java.lang.String	userIdKey The key for the user ID.
static java.lang.String	variationIdKey The key for the variation Id within a decision Map.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	lookup(java.lang.String userId) Fetch the user profile map for the user ID.
void	save(java.util.Map<java.lang.String,java.lang.Object> userProfile) Save the user profile Map sent to this method.

Field Detail

userIdKey

static final java.lang.String userIdKey

The key for the user ID. Returns a String.

See Also:

Constant Field Values

experimentBucketMapKey

static final java.lang.String experimentBucketMapKey

The key for the decisions Map. Returns a Map<String, Map<String, String>>.

See Also:

Constant Field Values

variationIdKey

static final java.lang.String variationIdKey

The key for the variation Id within a decision Map.

See Also:

Constant Field Values

Method Detail

lookup

java.util.Map<java.lang.String,java.lang.Object> lookup(java.lang.String userId)
                                                 throws java.lang.Exception

Fetch the user profile map for the user ID.

Parameters:

userId - The ID of the user whose profile will be retrieved.

Returns:

a Map representing the user's profile. The returned Map<String, Object> of the user profile will have the following structure. { userIdKey : String userId, decisionsKey : Map<String, Map<String, String>> decisions { String experimentId : Map<String, String> decision { variationIdKey : String variationId } } }

Throws:

java.lang.Exception - Passes on whatever exceptions the implementation may throw.

save

void save(java.util.Map<java.lang.String,java.lang.Object> userProfile)
   throws java.lang.Exception

Save the user profile Map sent to this method.

Parameters:

userProfile - The Map representing the user's profile.

Throws:

java.lang.Exception - Can throw an exception if the user profile was not saved properly.