com.atlassian.crowd.model.user

Class LDAPUserWithAttributes

java.lang.Object

com.atlassian.crowd.model.user.LDAPUserWithAttributes

All Implemented Interfaces:

Attributes, User, UserWithAttributes, DirectoryEntity, LDAPDirectoryEntity, Serializable, Comparable<User>, Principal

public class LDAPUserWithAttributes
extends Object
implements UserWithAttributes, LDAPDirectoryEntity

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LDAPUserWithAttributes(String dn, UserTemplateWithAttributes user)

Method Summary

Modifier and Type	Method and Description
int	compareTo(User other) CompareTo must be compatible with the equals() and hashCode() methods
boolean	equals(Object o) Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().
long	getDirectoryId()
String	getDisplayName()
String	getDn() Gets the standardised distinguished name for the LDAP entity.
String	getEmailAddress()
String	getExternalId()
String	getFirstName()
Set<String>	getKeys() Gets all the keys of the attributes.
String	getLastName()
String	getName()
String	getValue(String name) Returns any value associated with the given key, returns null if there is no value.
Set<String>	getValues(String name) 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()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies

Methods inherited from interface com.atlassian.crowd.model.LDAPDirectoryEntity

getLdapName

Constructor Detail

LDAPUserWithAttributes

public LDAPUserWithAttributes(String dn,
                              UserTemplateWithAttributes user)

Method Detail

getDn

public String getDn()

Description copied from interface: LDAPDirectoryEntity

Gets the standardised distinguished name for the LDAP entity.

Specified by:

getDn in interface LDAPDirectoryEntity

Returns:

distinguished name.

getDirectoryId

public long getDirectoryId()

Specified by:

getDirectoryId in interface User

Specified by:

getDirectoryId in interface DirectoryEntity

Returns:

id of the directory in which the DirectoryEntity is stored.

getName

public String getName()

Specified by:

getName in interface DirectoryEntity

Specified by:

getName in interface Principal

Returns:

name of the entity.

isActive

public boolean isActive()

Specified by:

isActive in interface User

Returns:

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

getEmailAddress

public String getEmailAddress()

Specified by:

getEmailAddress in interface User

Returns:

email address of the user.

getFirstName

public String getFirstName()

getLastName

public String getLastName()

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface User

Returns:

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

getValues

public Set<String> getValues(String name)

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:

name - the key to retrieve the values for

Returns:

the values associated with the given key. It may return null or empty set if the key does not exist.

getValue

public String getValue(String name)

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:

name - the key to retrieve the value for

Returns:

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

getKeys

public Set<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

getExternalId

public String getExternalId()

equals

public boolean equals(Object o)

Description copied from interface: DirectoryEntity

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 Principal

Overrides:

equals in class Object

Parameters:

o - object to compare to.

Returns:

true if and only if the directoryId and the lowercase names of the directory entities match.

hashCode

public int hashCode()

Description copied from interface: DirectoryEntity

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 Principal

Overrides:

hashCode in class Object

Returns:

hashcode.

compareTo

public int compareTo(User other)

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 Comparable<User>

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object