UserUtil (Atlassian JIRA - Code

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.atlassian.jira.user.util
Interface UserUtil

public interface UserUtil

This is a back end service level interface that defines an API for user level operations.

Nested Class Summary
`static interface`	`UserUtil.PasswordResetToken`
`static interface`	`UserUtil.PasswordResetTokenValidation`

Field Summary
`static String`	`META_PROPERTY_PREFIX`

Method Summary
`void`	`addToJiraUsePermission(User user)` Deprecated. Use `addToJiraUsePermission(com.atlassian.crowd.embedded.api.User)` instead. Since v4.3
`void`	`addToJiraUsePermission(com.atlassian.crowd.embedded.api.User user)` Takes the given user and adds him/her to all the groups that grant a user the global JIRA use permission.
`void`	`addUserToGroup(com.atlassian.crowd.embedded.api.Group group, com.atlassian.crowd.embedded.api.User userToAdd)` This is used to add a specified user to a specified group.
`void`	`addUserToGroup(Group group, User userToAdd)` Deprecated. Use `addUserToGroup(com.atlassian.crowd.embedded.api.Group, com.atlassian.crowd.embedded.api.User)` instead. Since v4.3
`void`	`addUserToGroups(Collection<Group> groups, User userToAdd)` Deprecated. Use `addUserToGroups(java.util.Collection, com.atlassian.crowd.embedded.api.User)` instead. Since v4.3
`void`	`addUserToGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups, com.atlassian.crowd.embedded.api.User userToAdd)` This is used to add a user to many groups at once.
`boolean`	`canActivateNumberOfUsers(int numUsers)` Returns true if, after adding the specified number of users, the number of active users in JIRA does not exceed the user limit allowed by the license.
`boolean`	`canActivateUsers(Collection<String> userNames)` Returns true if, after adding the specified users, the number of active users in JIRA does not exceed the user limit allowed by the license.
`void`	`changePassword(User user, String newPassword)` Deprecated. Use `changePassword(com.atlassian.crowd.embedded.api.User, String)` instead. Since v4.3
`void`	`changePassword(com.atlassian.crowd.embedded.api.User user, String newPassword)` Can be called to set the password for a user.
`void`	`clearActiveUserCount()` Clears the cache of the active user count so that it can be recalculated.
`User`	`createUserNoEvent(String username, String password, String email, String fullname)` Deprecated. Please use `createUserNoNotification(String, String, String, String)`. Since v4.3
`com.atlassian.crowd.embedded.api.User`	`createUserNoNotification(String username, String password, String emailAddress, String displayName)` Creates a User from supplied details.
`com.atlassian.crowd.embedded.api.User`	`createUserNoNotification(String username, String password, String emailAddress, String displayName, Long directoryId)` Creates a User from supplied details.
`User`	`createUserWithEvent(String username, String password, String email, String fullname, int userEventType)` Deprecated. Please use `createUserWithNotification(String, String, String, String, int)`. Since v4.3
`com.atlassian.crowd.embedded.api.User`	`createUserWithNotification(String username, String password, String email, String fullname, int userEventType)` Creates a User from supplied details.
`com.atlassian.crowd.embedded.api.User`	`createUserWithNotification(String username, String password, String email, String fullname, Long directoryId, int userEventType)` Creates a User from supplied details.
`UserUtil.PasswordResetToken`	`generatePasswordResetToken(com.atlassian.crowd.embedded.api.User user)` This is used to generate a reset password token that last a certain time and allows a person to access a page anonymously so they can reset their password.
`UserUtil.PasswordResetToken`	`generatePasswordResetToken(User user)` This is used to generate a reset password token that last a certain time and allows a person to access a page anonymously so they can reset their password.
`int`	`getActiveUserCount()` Returns the number of users that are currently 'active'.
`Collection<User>`	`getAdministrators()` Deprecated. Since v4.3. Use `getJiraAdministrators()`.
`Set<User>`	`getAllUsers()` Deprecated. Since v4.3. Use `getUsers()`.
`SortedSet<com.atlassian.crowd.embedded.api.User>`	`getAllUsersInGroupNames(Collection<String> groupNames)` Returns a collection of `User` objects that belong to any of the passed in collection of group names.
`SortedSet<com.atlassian.crowd.embedded.api.User>`	`getAllUsersInGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups)` Returns a collection of `User` objects that are found within the passed in collection of `Group` objects.
`Collection<ProjectComponent>`	`getComponentsUserLeads(User user)` Deprecated. Use `getComponentsUserLeads(com.atlassian.crowd.embedded.api.User)` instead. Since v4.3
`Collection<ProjectComponent>`	`getComponentsUserLeads(com.atlassian.crowd.embedded.api.User user)` Retrieve a collection of ProjectComponents - where the lead of each component is the specified user.
`String`	`getDisplayableNameSafely(com.atlassian.crowd.embedded.api.User user)` Takes the given user and returns a "displayable name" by cautiously checking the different edge cases for users.
`String`	`getDisplayableNameSafely(User user)` Deprecated. Use `getDisplayableNameSafely(com.atlassian.crowd.embedded.api.User)` instead. Since v4.3
`Group`	`getGroup(String groupName)` Deprecated. Since v4.3. Use `getGroupObject(String)`.
`SortedSet<String>`	`getGroupNamesForUser(String userName)` Returns a collection of the names of the groups that the user belongs to.
`com.atlassian.crowd.embedded.api.Group`	`getGroupObject(String groupName)` Returns a `Group` based on user name.
`SortedSet<com.atlassian.crowd.embedded.api.Group>`	`getGroupsForUser(String userName)` Returns a collection of `Group` objects that the user belongs to.
`Collection<com.atlassian.crowd.embedded.api.User>`	`getJiraAdministrators()` Returns a list of JIRA admin `User`s.
`Collection<com.atlassian.crowd.embedded.api.User>`	`getJiraSystemAdministrators()` Returns a list of JIRA system admin `User`s.
`long`	`getNumberOfAssignedIssuesIgnoreSecurity(com.atlassian.crowd.embedded.api.User loggedInUser, com.atlassian.crowd.embedded.api.User user)` Returns number of issues assigned to user
`long`	`getNumberOfAssignedIssuesIgnoreSecurity(User loggedInUser, User user)` Deprecated. Use `getNumberOfAssignedIssuesIgnoreSecurity(com.atlassian.crowd.embedded.api.User, com.atlassian.crowd.embedded.api.User)` instead. Since v4.3
`long`	`getNumberOfReportedIssuesIgnoreSecurity(com.atlassian.crowd.embedded.api.User loggedInUser, com.atlassian.crowd.embedded.api.User user)` Returns number of issues reported by user
`long`	`getNumberOfReportedIssuesIgnoreSecurity(User loggedInUser, User user)` Deprecated. Use `getNumberOfReportedIssuesIgnoreSecurity(com.atlassian.crowd.embedded.api.User, com.atlassian.crowd.embedded.api.User)` instead. Since v4.3
`Collection<Project>`	`getProjectsLeadBy(com.atlassian.crowd.embedded.api.User user)` Returns all the projects that leadUser is the project lead for.
`Collection<org.ofbiz.core.entity.GenericValue>`	`getProjectsUserLeads(User user)` Deprecated. Use `getProjectsLeadBy(com.atlassian.crowd.embedded.api.User)` instead. Since v4.3
`Collection<User>`	`getSystemAdministrators()` Deprecated. Since v4.3. Use `getJiraSystemAdministrators()` .
`int`	`getTotalUserCount()` Returns the total number of users defined in JIRA, regardless of whether they are active or not.
`User`	`getUser(String userName)` Deprecated. Since v4.3. Use `getUserObject(String)` .
`com.atlassian.crowd.embedded.api.User`	`getUserObject(String userName)` Returns a user based on user name.
`Collection<com.atlassian.crowd.embedded.api.User>`	`getUsers()` Returns the all users defined in JIRA, regardless of whether they are active or not.
`SortedSet<User>`	`getUsersInGroupNames(Collection<String> groupNames)` Deprecated. Use `getAllUsersInGroupNames(java.util.Collection)` instead. Since v4.3
`SortedSet<User>`	`getUsersInGroups(Collection<Group> groups)` Deprecated. Use `getAllUsersInGroups(java.util.Collection)` instead. Since v4.3
`boolean`	`hasExceededUserLimit()` Returns true if this JIRA instance has more active users, than allowed by the license.
`boolean`	`isNonSysAdminAttemptingToDeleteSysAdmin(User loggedInUser, User user)` Deprecated. Use `isNonSysAdminAttemptingToDeleteSysAdmin(com.atlassian.crowd.embedded.api.User, com.atlassian.crowd.embedded.api.User)` instead. Since v4.3
`boolean`	`isNonSysAdminAttemptingToDeleteSysAdmin(com.atlassian.crowd.embedded.api.User loggedInUser, com.atlassian.crowd.embedded.api.User user)` Checking if user without SYSTEM_ADMIN rights tries to remove user with SYSTEM_ADMIN rights.
`void`	`removeUser(com.atlassian.crowd.embedded.api.User loggedInUser, com.atlassian.crowd.embedded.api.User user)` This will remove the user and removes the user from all the groups.
`void`	`removeUser(User loggedInUser, User user, I18nHelper i18nBean)` Deprecated. Use `removeUser(com.atlassian.crowd.embedded.api.User, com.atlassian.crowd.embedded.api.User)` instead. Since v4.3
`void`	`removeUserFromGroup(Group group, User userToRemove)` Deprecated. Use `removeUserFromGroup(com.atlassian.crowd.embedded.api.Group, com.atlassian.crowd.embedded.api.User)` instead. Since v4.3
`void`	`removeUserFromGroup(com.atlassian.crowd.embedded.api.Group group, com.atlassian.crowd.embedded.api.User userToRemove)` This is used to remove a specified user from a specified group.
`void`	`removeUserFromGroups(Collection<Group> groups, User userToRemove)` Deprecated. Use `removeUserFromGroups(java.util.Collection, com.atlassian.crowd.embedded.api.User)` instead. Since v4.3
`void`	`removeUserFromGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups, com.atlassian.crowd.embedded.api.User userToRemove)` This is used to remove a user from many groups at once.
`boolean`	`userExists(String userName)` Returns true if the a user exists with the specified userName
`UserUtil.PasswordResetTokenValidation`	`validatePasswordResetToken(com.atlassian.crowd.embedded.api.User user, String token)` This can be called to validate a token against the user.

Field Detail

META_PROPERTY_PREFIX

static final String META_PROPERTY_PREFIX

See Also:: Constant Field Values

Method Detail

getTotalUserCount

int getTotalUserCount()

Returns the total number of users defined in JIRA, regardless of whether they are active or not.

Returns:: the total number of users defined in JIRA
Since:: v4.0

getAllUsers

@NotNull
Set<User> getAllUsers()

Deprecated. Since v4.3. Use getUsers().

Returns the all users defined in JIRA, regardless of whether they are active or not.

WARNING: This method will be changed in the future to return a set of Crowd User objects. Since v4.3.

Returns:: the set of all users defined in JIRA
Since:: v4.0

getUsers

@NotNull
Collection<com.atlassian.crowd.embedded.api.User> getUsers()

Returns the all users defined in JIRA, regardless of whether they are active or not.

WARNING: This method will be changed in the future to return a set of Crowd User objects. Since v4.3.

Returns:: the set of all users defined in JIRA
Since:: v4.3

getGroup

Group getGroup(@Nullable
               String groupName)

Deprecated. Since v4.3. Use getGroupObject(String).

Returns a Group based on user name.

WARNING: This method will be changed in the future to return a Crowd Group object. Since v4.3.

Parameters:: groupName - the user name of the group
Returns:: the Group object, or null if the user cannot be found including null groupName.
Since:: v4.0

getGroupObject

com.atlassian.crowd.embedded.api.Group getGroupObject(@Nullable
                                                      String groupName)

Returns a Group based on user name.

WARNING: This method will be changed in the future to return a Crowd Group object. Since v4.3.

Parameters:: groupName - the user name of the group
Returns:: the Group object, or null if the user cannot be found including null groupName.
Since:: v4.3

createUserWithEvent

User createUserWithEvent(String username,
                         String password,
                         String email,
                         String fullname,
                         int userEventType)
                         throws ImmutableException

Deprecated. Please use createUserWithNotification(String, String, String, String, int). Since v4.3