com.atlassian.jira.user.util

Class UserUtilImpl

java.lang.Object

com.atlassian.jira.user.util.UserUtilImpl

All Implemented Interfaces:

UserUtil

public class UserUtilImpl
extends Object
implements UserUtil

This is the default implementation of the UserUtil interface.

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.user.util.UserUtil

UserUtil.PasswordResetToken, UserUtil.PasswordResetTokenValidation

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIRECTORY_ID
static String	DIRECTORY_NAME
static String	DISPLAY_NAME
static String	EMAIL
static String	PASSWORD_HOURS
static String	PASSWORD_TOKEN
static String	SEND_EMAIL
static String	USERNAME

Fields inherited from interface com.atlassian.jira.user.util.UserUtil

META_PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor and Description

UserUtilImpl(IssueSecurityLevelManager issueSecurityLevelManager, GlobalPermissionManager globalPermissionManager, com.atlassian.crowd.embedded.api.CrowdService crowdService, PermissionManager permissionManager, ApplicationProperties applicationProperties, SearchService searchService, ProjectManager projectManager, ProjectRoleService projectRoleService, ProjectComponentManager componentManager, SubscriptionManager subscriptionManager, NotificationSchemeManager notificationSchemeManager, UserHistoryManager userHistoryManager, UserManager userManager, ApplicationRoleManager applicationRoleManager, JsonEntityPropertyManager jsonEntityPropertyManager, SharePermissionDeleteUtils sharePermissionDeleteUtils)

Method Summary

Modifier and Type	Method and Description
void	addUserToGroup(com.atlassian.crowd.embedded.api.Group group, ApplicationUser userToAdd) This is used to add a specified user to a specified group.
void	addUserToGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups, ApplicationUser userToAdd) This is used to add a user to many groups at once.
void	changePassword(ApplicationUser user, String newPassword) Can be called to set the password for a user.
UserUtil.PasswordResetToken	generatePasswordResetToken(ApplicationUser 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.
SortedSet<ApplicationUser>	getAllUsersInGroupNames(Collection<String> groupNames) Returns a collection of User objects that belong to any of the passed in collection of group names.
Set<ApplicationUser>	getAllUsersInGroupNamesUnsorted(Collection<String> groupNames) Returns a collection of User objects that belong to any of the passed in collection of group names.
SortedSet<ApplicationUser>	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(ApplicationUser user) Retrieve a collection of ProjectComponents - where the lead of each component is the specified user.
String	getDisplayableNameSafely(ApplicationUser user) Takes the given user and returns a "displayable name" by cautiously checking the different edge cases for users.
SortedSet<String>	getGroupNamesForUser(String userName) Returns a collection of the names of the groups that the user belongs to.
SortedSet<com.atlassian.crowd.embedded.api.Group>	getGroupsForUser(String userName) Returns a collection of Group objects that the user belongs to.
Collection<ApplicationUser>	getJiraAdministrators() Returns a list of JIRA admin Users.
Collection<ApplicationUser>	getJiraSystemAdministrators() Returns a list of JIRA system admin Users.
long	getNumberOfAssignedIssuesIgnoreSecurity(ApplicationUser loggedInUser, ApplicationUser user) Returns number of issues assigned to user
long	getNumberOfReportedIssuesIgnoreSecurity(ApplicationUser loggedInUser, ApplicationUser user) Returns number of issues reported by user
protected PortalPageService	getPortalPageService() A Factory method to get the PortalPageService.
Collection<Project>	getProjectsLeadBy(ApplicationUser user) Returns all the projects that leadUser is the project lead for.
protected SearchRequestService	getSearchRequestService() A Factory method to get the SearchRequestService.
protected JiraServiceContext	getServiceContext(ApplicationUser user) Protected level factory method to allow for better test integration
SortedSet<ApplicationUser>	getUsersInGroupNames(Collection<String> groupNames)
boolean	isNonSysAdminAttemptingToDeleteSysAdmin(ApplicationUser loggedInUser, ApplicationUser user) Checking if user without SYSTEM_ADMIN rights tries to remove user with SYSTEM_ADMIN rights.
void	removeUser(ApplicationUser loggedInUser, ApplicationUser user) This will remove the user and removes the user from all the groups.
void	removeUserFromGroup(com.atlassian.crowd.embedded.api.Group group, ApplicationUser userToRemove) This is used to remove a specified user from a specified group.
void	removeUserFromGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups, ApplicationUser 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(ApplicationUser user, String token) This can be called to validate a token against the user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USERNAME

public static final String USERNAME

See Also:

Constant Field Values

EMAIL

public static final String EMAIL

See Also:

Constant Field Values

DISPLAY_NAME

public static final String DISPLAY_NAME

See Also:

Constant Field Values

DIRECTORY_NAME

public static final String DIRECTORY_NAME

See Also:

Constant Field Values

DIRECTORY_ID

public static final String DIRECTORY_ID

See Also:

Constant Field Values

PASSWORD_TOKEN

public static final String PASSWORD_TOKEN

See Also:

Constant Field Values

PASSWORD_HOURS

public static final String PASSWORD_HOURS

See Also:

Constant Field Values

SEND_EMAIL

public static final String SEND_EMAIL

See Also:

Constant Field Values

Constructor Detail

UserUtilImpl

public UserUtilImpl(IssueSecurityLevelManager issueSecurityLevelManager,
                    GlobalPermissionManager globalPermissionManager,
                    com.atlassian.crowd.embedded.api.CrowdService crowdService,
                    PermissionManager permissionManager,
                    ApplicationProperties applicationProperties,
                    SearchService searchService,
                    ProjectManager projectManager,
                    ProjectRoleService projectRoleService,
                    ProjectComponentManager componentManager,
                    SubscriptionManager subscriptionManager,
                    NotificationSchemeManager notificationSchemeManager,
                    UserHistoryManager userHistoryManager,
                    UserManager userManager,
                    ApplicationRoleManager applicationRoleManager,
                    JsonEntityPropertyManager jsonEntityPropertyManager,
                    SharePermissionDeleteUtils sharePermissionDeleteUtils)

Method Detail

getSearchRequestService

protected SearchRequestService getSearchRequestService()

A Factory method to get the SearchRequestService. This helps break the cyclic dependency of SearchRequestService to UserUtils AND allows test to override the value used.

Returns:

a SearchRequestService

getPortalPageService

protected PortalPageService getPortalPageService()

A Factory method to get the PortalPageService. This helps break the cyclic dependency of PortalPageService to UserUtils AND allows test to override the value used.

Returns:

a PortalPageService

getServiceContext

protected JiraServiceContext getServiceContext(ApplicationUser user)

Protected level factory method to allow for better test integration

Parameters:

user - the user in action

Returns:

a new JiraServiceContext

removeUser

public void removeUser(ApplicationUser loggedInUser,
                       ApplicationUser user)

Description copied from interface: UserUtil

This will remove the user and removes the user from all the groups. All components lead by user will have lead cleared.

Specified by:

removeUser in interface UserUtil

Parameters:

loggedInUser - the user performing operation

user - the user to delete

getNumberOfReportedIssuesIgnoreSecurity

public long getNumberOfReportedIssuesIgnoreSecurity(ApplicationUser loggedInUser,
                                                    ApplicationUser user)
                                             throws SearchException

Description copied from interface: UserUtil

Returns number of issues reported by user

Specified by:

getNumberOfReportedIssuesIgnoreSecurity in interface UserUtil

Parameters:

loggedInUser - the logged in user

user - the user to find the issue count for

Returns:

number of issues reported by user

Throws:

SearchException - if something goes wrong

getNumberOfAssignedIssuesIgnoreSecurity

public long getNumberOfAssignedIssuesIgnoreSecurity(ApplicationUser loggedInUser,
                                                    ApplicationUser user)
                                             throws SearchException

Description copied from interface: UserUtil

Returns number of issues assigned to user

Specified by:

getNumberOfAssignedIssuesIgnoreSecurity in interface UserUtil

Parameters:

loggedInUser - the logged in user

user - the user to find the issue count for

Returns:

number of issues assigned to user

Throws:

SearchException - if something goes wrong

getComponentsUserLeads

public Collection<ProjectComponent> getComponentsUserLeads(ApplicationUser user)

Description copied from interface: UserUtil

Retrieve a collection of ProjectComponents - where the lead of each component is the specified user.

Specified by:

getComponentsUserLeads in interface UserUtil

Parameters:

user - User leading components

Returns:

Collection of project components

getProjectsLeadBy

public Collection<Project> getProjectsLeadBy(ApplicationUser user)

Description copied from interface: UserUtil

Returns all the projects that leadUser is the project lead for.

Specified by:

getProjectsLeadBy in interface UserUtil

Parameters:

user - the user in play

Returns:

A collection of project GenericValues

isNonSysAdminAttemptingToDeleteSysAdmin

public boolean isNonSysAdminAttemptingToDeleteSysAdmin(ApplicationUser loggedInUser,
                                                       ApplicationUser user)

Description copied from interface: UserUtil

Checking if user without SYSTEM_ADMIN rights tries to remove user with SYSTEM_ADMIN rights.

Specified by:

isNonSysAdminAttemptingToDeleteSysAdmin in interface UserUtil

Parameters:

loggedInUser - User performing operation

user - User for remove

Returns:

true if user without SYSTEM_ADMIN rights tries to remove user with SYSTEM_ADMIN rights

addUserToGroup

public void addUserToGroup(com.atlassian.crowd.embedded.api.Group group,
                           ApplicationUser userToAdd)
                    throws PermissionException,
                           AddException

Description copied from interface: UserUtil

This is used to add a specified user to a specified group. The user will be added to the group if the user is not already a member of the group.

Specified by:

addUserToGroup in interface UserUtil

Parameters:

group - the group to add the user to.

userToAdd - the user to add to the group.

Throws:

PermissionException

AddException

addUserToGroups

public void addUserToGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups,
                            ApplicationUser userToAdd)
                     throws PermissionException,
                            AddException

Description copied from interface: UserUtil

This is used to add a user to many groups at once.

Specified by:

addUserToGroups in interface UserUtil

Parameters:

groups - a list containing the groups to add the user to.

userToAdd - the user to add to the group.

Throws:

PermissionException

AddException

removeUserFromGroup

public void removeUserFromGroup(com.atlassian.crowd.embedded.api.Group group,
                                ApplicationUser userToRemove)
                         throws PermissionException,
                                RemoveException

Description copied from interface: UserUtil

This is used to remove a specified user from a specified group. The user will be removed from the group only if the user is already a member of the group.

Specified by:

removeUserFromGroup in interface UserUtil

Parameters:

group - the group to add the user to.

userToRemove - the user to add to the group.

Throws:

PermissionException

RemoveException

removeUserFromGroups

public void removeUserFromGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups,
                                 ApplicationUser userToRemove)
                          throws PermissionException,
                                 RemoveException

Description copied from interface: UserUtil

This is used to remove a user from many groups at once.

Specified by:

removeUserFromGroups in interface UserUtil

Parameters:

groups - a list containing the groups to add the user to.

userToRemove - the user to add to the group.

Throws:

PermissionException

RemoveException

generatePasswordResetToken

public UserUtil.PasswordResetToken generatePasswordResetToken(ApplicationUser user)

Description copied from interface: UserUtil

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.

The generated token will be associated with the named user so that that this information can be verified at a later time.

Specified by:

generatePasswordResetToken in interface UserUtil

Parameters:

user - the user in question. This MUST not be null

Returns:

a newly generated token that will live for a certain time

validatePasswordResetToken

public UserUtil.PasswordResetTokenValidation validatePasswordResetToken(ApplicationUser user,
                                                                        String token)

Description copied from interface: UserUtil

This can be called to validate a token against the user.

Specified by:

validatePasswordResetToken in interface UserUtil

Parameters:

user - the user in play

token - the token they provided

Returns:

a Validation object that describes how the option went

changePassword

public void changePassword(ApplicationUser user,
                           String newPassword)
                    throws PermissionException,
                           com.atlassian.crowd.exception.InvalidCredentialException

Description copied from interface: UserUtil

Can be called to set the password for a user. This will delete any password request tokens associated with that user

Specified by:

changePassword in interface UserUtil

Parameters:

user - the user in play

newPassword - their new password

Throws:

com.atlassian.crowd.exception.InvalidCredentialException - if the password is invalid

PermissionException

userExists

public boolean userExists(String userName)

Description copied from interface: UserUtil

Returns true if the a user exists with the specified userName

Specified by:

userExists in interface UserUtil

Parameters:

userName - the name of the user

Returns:

true if t a user exists with the specified name or false if not

getJiraAdministrators

public Collection<ApplicationUser> getJiraAdministrators()

Description copied from interface: UserUtil

Returns a list of JIRA admin Users.

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

Specified by:

getJiraAdministrators in interface UserUtil

Returns:

a list of JIRA admin Users.

getJiraSystemAdministrators

public Collection<ApplicationUser> getJiraSystemAdministrators()

Description copied from interface: UserUtil

Returns a list of JIRA system admin Users.

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

Specified by:

getJiraSystemAdministrators in interface UserUtil

Returns:

a collection of User's that are associated with the Permissions.SYSTEM_ADMIN permission.

getDisplayableNameSafely

public String getDisplayableNameSafely(ApplicationUser user)

Description copied from interface: UserUtil

Takes the given user and returns a "displayable name" by cautiously checking the different edge cases for users.

Specified by:

getDisplayableNameSafely in interface UserUtil

Parameters:

user - the user. May be null.

Returns:

The user's full name if present and not blank, the username if present, or null otherwise.

getAllUsersInGroups

public SortedSet<ApplicationUser> getAllUsersInGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups)

Description copied from interface: UserUtil

Returns a collection of User objects that are found within the passed in collection of Group objects.

Specified by:

getAllUsersInGroups in interface UserUtil

Parameters:

groups - a collection of Group objects

Returns:

the set of users that are in the groups, sorted in UserCachingComparator order

getAllUsersInGroupNames

public SortedSet<ApplicationUser> getAllUsersInGroupNames(Collection<String> groupNames)

Description copied from interface: UserUtil

Returns a collection of User objects that belong to any of the passed in collection of group names. Prefer using UserUtil.getAllUsersInGroupNamesUnsorted(java.util.Collection) and sorting the list of users only if absolutely necessary rather than relying on this method to perform the sort.

Specified by:

getAllUsersInGroupNames in interface UserUtil

Parameters:

groupNames - a collection of group name strings

Returns:

the set of users that are in the named groups, sorted in UserCachingComparator order

getAllUsersInGroupNamesUnsorted

public Set<ApplicationUser> getAllUsersInGroupNamesUnsorted(Collection<String> groupNames)

Description copied from interface: UserUtil

Returns a collection of User objects that belong to any of the passed in collection of group names.

Specified by:

getAllUsersInGroupNamesUnsorted in interface UserUtil

Parameters:

groupNames - a collection of group name strings

Returns:

the set of users that are in the named groups

getUsersInGroupNames

public SortedSet<ApplicationUser> getUsersInGroupNames(Collection<String> groupNames)

getGroupsForUser

public SortedSet<com.atlassian.crowd.embedded.api.Group> getGroupsForUser(String userName)

Description copied from interface: UserUtil

Returns a collection of Group objects that the user belongs to.

Specified by:

getGroupsForUser in interface UserUtil

Parameters:

userName - A User name

Returns:

the set of groups that the user belongs to

getGroupNamesForUser

public SortedSet<String> getGroupNamesForUser(String userName)

Description copied from interface: UserUtil

Returns a collection of the names of the groups that the user belongs to.

Specified by:

getGroupNamesForUser in interface UserUtil

Parameters:

userName - A User name

Returns:

the set of groups that the user belongs to