public interface

User

implements Comparable<T> Principal
com.atlassian.crowd.embedded.api.User
Known Indirect Subclasses

Class Overview

Represents a user.

Summary

Public Methods
int compareTo(User user)
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 getEmailAddress()
int hashCode()
Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().
boolean isActive()
[Expand]
Inherited Methods
From interface java.lang.Comparable
From interface java.security.Principal

Public Methods

public int compareTo (User user)

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

public boolean equals (Object o)

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

Parameters
o object to compare to.
Returns
  • true if and only if the directoryId and name.toLowerCase() of the directory entities match.

public long getDirectoryId ()

Returns
  • id of the directory in which the User is stored.

public String getDisplayName ()

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

public String getEmailAddress ()

Returns
  • email address of the user.

public int hashCode ()

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

Returns
  • hashcode.

public boolean isActive ()

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