com.atlassian.crowd.embedded.api

Interface User

All Superinterfaces:

Comparable<User>, Principal

All Known Subinterfaces:

UserWithAttributes

All Known Implementing Classes:

DelegatingUserWithAttributes

public interface User
extends Comparable<User>, Principal

Represents a user.

Method Summary

Modifier and Type	Method and Description
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().
default String	getAccountId() Returns the Atlassian Account ID for this user.
long	getDirectoryId()
String	getDisplayName()
String	getEmailAddress()
int	hashCode() Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().
boolean	isActive()
boolean	isLocalServiceDeskUser() Local user support for Service Desk Customers.

Methods inherited from interface java.security.Principal

getName, implies, toString

Method Detail

getDirectoryId

long getDirectoryId()

Returns:

id of the directory in which the User is stored.

getAccountId

@Nullable
default String getAccountId()

Returns the Atlassian Account ID for this user.

Note that an AtlassianAccountID for a user can change under certain circumstances.

This can return null under a number of circumstances:

• This User is a "local" Service Desk user (customer)
• This JIRA Cloud instance is not migrated to Atlassian Account yet
• This JIRA Cloud instance is still connected to Horde - we don't have access to the Atlassian Account ID

Furthermore in the future there may be other "User Account" types that have no Atlassian Account.

Note for implementors: you probably don't need to override the default behaviour of this method: it is derived from other values. In fact doing so could produce errors: especially while Horde still exists because it keeps values in the "externalId" column that are NOT the Atlassian Account.

Returns:

the Atlassian Account ID

See Also:

isLocalServiceDeskUser(), CrowdService.isIdentityPlatformEnabled()

isActive

boolean isActive()

Returns:

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

getEmailAddress

String getEmailAddress()

Returns:

email address of the user.

getDisplayName

String getDisplayName()

Returns:

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

isLocalServiceDeskUser

boolean isLocalServiceDeskUser()

Local user support for Service Desk Customers. If true, this designates that this user is managed locally by the Service Desk instance and is not managed by the Identity platform.

equals

boolean equals(Object o)

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

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 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 Principal

Overrides:

hashCode in class Object

Returns:

hashcode.

compareTo

int compareTo(User user)

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

Specified by:

compareTo in interface Comparable<User>