com.atlassian.crowd.embedded.api
Interface User

All Superinterfaces:

java.lang.Comparable<User>, java.security.Principal

All Known Subinterfaces:

TimestampedUser, User, UserWithAttributes, UserWithAttributes

All Known Implementing Classes:

DelegatingUserWithAttributes, DelegatingUserWithAttributes, DemoUser, ImmutableTimestampedUser, ImmutableUser, ImmutableUser, InternalUser, InternalUserWithAttributes, LDAPUserWithAttributes, UserEntity, UserTemplate, UserTemplateWithAttributes, UserTemplateWithCredentialAndAttributes

public interface User
extends java.lang.Comparable<User>, java.security.Principal

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().
long	getDirectoryId()
java.lang.String	getDisplayName()
java.lang.String	getEmailAddress()
int	hashCode() Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().
boolean	isActive()

Methods inherited from interface java.security.Principal

getName, toString

Method Detail

getDirectoryId

long getDirectoryId()

Returns:

id of the directory in which the User is stored.

isActive

boolean isActive()

Returns:

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

getEmailAddress

java.lang.String getEmailAddress()

Returns:

email address of the user.

getDisplayName

java.lang.String getDisplayName()

Returns:

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

equals

boolean equals(java.lang.Object o)

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

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

int hashCode()

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

Specified by:

hashCode in interface java.security.Principal

Overrides:

hashCode in class java.lang.Object

Returns:

hashcode.

compareTo

int compareTo(User user)

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

Specified by:

compareTo in interface java.lang.Comparable<User>