public interface

ApplicationUser

implements Principal
com.atlassian.jira.user.ApplicationUser
Known Indirect Subclasses

Class Overview

Represents a person who uses JIRA. This differs from a User, which represents a user in a user directory. An ApplicationUser encompasses all users with the same username (ignoring case) across all directories.

Note that the v6.0 version of this interface differs from the v5.x experimental version in one important regard: the v5.x version extended the User interface. Unfortunately, the two interfaces have incompatible contracts for equals, so they have been divided.

This incompatibility could lead, for example, to duplicate members in a Set if you were to mix the two implementations. Developers writing plugins that target JIRA 5.x should be careful not to mix ApplicationUser objects with other implementations of User; otherwise, unexpected results can occur (and it won't be compatible with 6.0).

ApplicationUsers is a utility class that allows you to easily switch between ApplicationUser and User. If you want to access the mapping between user keys and usernames directly, use the UserKeyService.

See Also

Summary

Public Methods
boolean equals(Object obj)
Implementations must ensure equality based on getKey().
long getDirectoryId()
User getDirectoryUser()
String getDisplayName()
Returns the display name of the user.
String getEmailAddress()
String getKey()
Returns the key which distinguishes the ApplicationUser as unique.
String getName()
Synonym for getUsername() and implementation of getName().
String getUsername()
int hashCode()
Implementations must produce a hashcode based on getKey().
boolean isActive()
[Expand]
Inherited Methods
From interface java.security.Principal

Public Methods

public boolean equals (Object obj)

Implementations must ensure equality based on getKey().

Parameters
obj object to compare to.
Returns
  • true if and only if the key matches.

public long getDirectoryId ()

Returns
  • the ID of the user directory that this user comes from.

public User getDirectoryUser ()

Returns
  • the user as seen by the particular user directory that this User is defined in.

public String getDisplayName ()

Returns the display name of the user. This is sometimes referred to as "full name".

Returns
  • display name of the user, must never be null.

public String getEmailAddress ()

Returns
  • email address of the user.

public String getKey ()

Returns the key which distinguishes the ApplicationUser as unique. The same key is shared by all Users with the same username (ignoring case) across all user directories.

Returns
  • the key which distinguishes the ApplicationUser as unique

public String getName ()

Synonym for getUsername() and implementation of getName().

Returns
  • the username (login) of the user; must never be null.
See Also

public String getUsername ()

Returns
  • the username (login) of the user; must never be null.
See Also

public int hashCode ()

Implementations must produce a hashcode based on getKey().

Returns
  • hashcode.

public boolean isActive ()

Returns
  • true if this user is active.