com.launchdarkly.client

Class LDUser

java.lang.Object

com.launchdarkly.client.LDUser

public class LDUser
extends java.lang.Object

A LDUser object contains specific attributes of a user browsing your site. The only mandatory property property is the key, which must uniquely identify each user. For authenticated users, this may be a username or e-mail address. For anonymous users, this could be an IP address or session ID.

Besides the mandatory key, LDUser supports two kinds of optional attributes: interpreted attributes (e.g. ip and country) and custom attributes. LaunchDarkly can parse interpreted attributes and attach meaning to them. For example, from an ip address, LaunchDarkly can do a geo IP lookup and determine the user's country.

Custom attributes are not parsed by LaunchDarkly. They can be used in custom rules-- for example, a custom attribute such as "customer_ranking" can be used to launch a feature to the top 10% of users on a site.

If you want to pass an LDUser object to the front end to be used with the JavaScript SDK, simply call Gson.toJson() or Gson.toJsonTree() on it.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LDUser.Builder A builder that helps construct LDUser objects.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LDUser(LDUser.Builder builder)
	LDUser(java.lang.String key) Create a user with the given key

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
protected LDValue	getValueForEvaluation(java.lang.String attribute)
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

LDUser

protected LDUser(LDUser.Builder builder)

LDUser

public LDUser(java.lang.String key)

Create a user with the given key

Parameters:

key - a String that uniquely identifies a user

Method Detail

getValueForEvaluation

protected LDValue getValueForEvaluation(java.lang.String attribute)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object