com.atlassian.crowd.integration.rest.entity
Class UserEntity

java.lang.Object
  com.atlassian.crowd.integration.rest.entity.UserEntity

All Implemented Interfaces:

Attributes, User, UserWithAttributes, DirectoryEntity, java.lang.Comparable<User>, java.security.Principal

public class UserEntity
extends java.lang.Object
implements UserWithAttributes

Represents a User entity.

Since:

v2.1

Constructor Summary

UserEntity(java.lang.String name, java.lang.String firstName, java.lang.String lastName, java.lang.String displayName, java.lang.String emailAddress, PasswordEntity password, boolean active)

Method Summary

int	compareTo(User user) CompareTo must be compatible with the equals() and hashCode() methods
boolean	equals(java.lang.Object o) Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().
MultiValuedAttributeEntityList	getAttributes()
long	getDirectoryId()
java.lang.String	getDisplayName()
java.lang.String	getEmailAddress()
java.lang.String	getFirstName()
java.util.Set<java.lang.String>	getKeys() Gets all the keys of the attributes.
java.lang.String	getLastName()
java.lang.String	getName()
PasswordEntity	getPassword()
java.lang.String	getValue(java.lang.String key) Returns any value associated with the given key, returns null if there is no value.
java.util.Set<java.lang.String>	getValues(java.lang.String key) Get all the values associated with a given key.
int	hashCode() Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().
boolean	isActive()
boolean	isEmpty()
static UserEntity	newMinimalInstance(java.lang.String username) Creates a new minimal user instance.
void	setAttributes(MultiValuedAttributeEntityList attributes)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserEntity

public UserEntity(java.lang.String name,
                  java.lang.String firstName,
                  java.lang.String lastName,
                  java.lang.String displayName,
                  java.lang.String emailAddress,
                  PasswordEntity password,
                  boolean active)

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface User

Returns:

display name (eg. full name) of the user, must never be null.

getFirstName

public java.lang.String getFirstName()

getLastName

public java.lang.String getLastName()

getEmailAddress

public java.lang.String getEmailAddress()

Specified by:

getEmailAddress in interface User

Returns:

email address of the user.

getPassword

public PasswordEntity getPassword()

isActive

public boolean isActive()

Specified by:

isActive in interface User

Returns:

true if and only if the user is allowed to authenticate.

getName

public java.lang.String getName()

Specified by:

getName in interface DirectoryEntity

Specified by:

getName in interface java.security.Principal

Returns:

name of the entity.

setAttributes

public void setAttributes(MultiValuedAttributeEntityList attributes)

getAttributes

public MultiValuedAttributeEntityList getAttributes()

getValues

public java.util.Set<java.lang.String> getValues(java.lang.String key)

Description copied from interface: Attributes

Get all the values associated with a given key. Duplicate values are not allowed, and this should be enforced case-insensitively to match the behaviour of LDAP servers. Will return null if the key does not exist.

Specified by:

getValues in interface Attributes

Parameters:

key - the key to retrieve the values for

Returns:

the values associated with the given key, or null if the key does not exist.

getValue

public java.lang.String getValue(java.lang.String key)

Description copied from interface: Attributes

Returns any value associated with the given key, returns null if there is no value.

Specified by:

getValue in interface Attributes

Parameters:

key - the key to retrieve the value for

Returns:

any value associated with the given key, or null if there is no value

getKeys

public java.util.Set<java.lang.String> getKeys()

Description copied from interface: Attributes

Gets all the keys of the attributes. Warning: case-insensitive keys are currently no enforced, however this is the case for LDAP, so this may be implemented in the future.

Specified by:

getKeys in interface Attributes

Returns:

a set of all the keys.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Attributes

Returns:

true if there are no attributes

getDirectoryId

public long getDirectoryId()

Specified by:

getDirectoryId in interface User

Specified by:

getDirectoryId in interface DirectoryEntity

Returns:

id of the directory in which the User is stored.

compareTo

public int compareTo(User user)

Description copied from interface: User

CompareTo must be compatible with the equals() and hashCode() methods

Specified by:

compareTo in interface User

Specified by:

compareTo in interface java.lang.Comparable<User>

equals

public boolean equals(java.lang.Object o)

Description copied from interface: User

Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().

Specified by:

equals in interface User

Specified by:

equals in interface DirectoryEntity

Specified by:

equals in interface java.security.Principal

Overrides:

equals in class java.lang.Object

Parameters:

o - object to compare to.

Returns:

true if and only if the directoryId and name.toLowerCase() of the directory entities match.

hashCode

public int hashCode()

Description copied from interface: User

Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().

Specified by:

hashCode in interface User

Specified by:

hashCode in interface DirectoryEntity

Specified by:

hashCode in interface java.security.Principal

Overrides:

hashCode in class java.lang.Object

Returns:

hashcode.

toString

public java.lang.String toString()

Specified by:

toString in interface java.security.Principal

Overrides:

toString in class java.lang.Object

newMinimalInstance

public static UserEntity newMinimalInstance(java.lang.String username)

Creates a new minimal user instance.

Parameters:

username - username for the user

Returns:

minimal user instance