|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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(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 |
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(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. |
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. |
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. |
int |
getActiveUserCount()
Returns the number of users that are currently 'active'. |
Collection<com.atlassian.crowd.embedded.api.User> |
getAdministrators()
Deprecated. Since v4.3. Use getJiraAdministrators() . |
Collection<ApplicationUser> |
getAllApplicationUsers()
Returns the all users defined in JIRA, regardless of whether they are active or not. |
Set<com.atlassian.crowd.embedded.api.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. |
Set<com.atlassian.crowd.embedded.api.User> |
getAllUsersInGroupNamesUnsorted(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(ApplicationUser user)
Retrieve a collection of ProjectComponents - where the lead of each component is the specified user. |
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(ApplicationUser user)
Takes the given user and returns a "displayable name" by cautiously checking the different edge cases for users. |
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. |
com.atlassian.crowd.embedded.api.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(ApplicationUser loggedInUser,
ApplicationUser user)
Returns number of issues assigned to user |
long |
getNumberOfAssignedIssuesIgnoreSecurity(com.atlassian.crowd.embedded.api.User loggedInUser,
com.atlassian.crowd.embedded.api.User user)
Returns number of issues assigned to user |
long |
getNumberOfReportedIssuesIgnoreSecurity(ApplicationUser loggedInUser,
ApplicationUser user)
Returns number of issues reported by user |
long |
getNumberOfReportedIssuesIgnoreSecurity(com.atlassian.crowd.embedded.api.User loggedInUser,
com.atlassian.crowd.embedded.api.User user)
Returns number of issues reported by user |
Collection<Project> |
getProjectsLeadBy(ApplicationUser user)
Returns all the projects that leadUser is the project lead for. |
Collection<Project> |
getProjectsLeadBy(com.atlassian.crowd.embedded.api.User user)
Returns all the projects that leadUser is the project lead for. |
Collection<com.atlassian.crowd.embedded.api.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. |
com.atlassian.crowd.embedded.api.User |
getUser(String userName)
Deprecated. Use getUserByKey(String) or getUserByName(String) instead. Since v6.0. |
ApplicationUser |
getUserByKey(String userkey)
Returns a user based on key. |
ApplicationUser |
getUserByName(String username)
Returns a user based on user name. |
com.atlassian.crowd.embedded.api.User |
getUserObject(String userName)
Deprecated. Use getUserByKey(String) or getUserByName(String) instead. Since v6.0. |
Collection<com.atlassian.crowd.embedded.api.User> |
getUsers()
Returns the all users defined in JIRA, regardless of whether they are active or not. |
SortedSet<com.atlassian.crowd.embedded.api.User> |
getUsersInGroupNames(Collection<String> groupNames)
Deprecated. Use getAllUsersInGroupNames(java.util.Collection) instead. Since v4.3 |
SortedSet<com.atlassian.crowd.embedded.api.User> |
getUsersInGroups(Collection<com.atlassian.crowd.embedded.api.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(ApplicationUser loggedInUser,
ApplicationUser user)
Checking if user without SYSTEM_ADMIN rights tries to remove user with SYSTEM_ADMIN rights. |
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(ApplicationUser loggedInUser,
ApplicationUser user)
This will remove the user and removes the user from all the groups. |
void |
removeUser(com.atlassian.crowd.embedded.api.User loggedInUser,
com.atlassian.crowd.embedded.api.User user)
Deprecated. Use removeUser(ApplicationUser, ApplicationUser) instead. Since v6.0. |
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<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 |
---|
static final String META_PROPERTY_PREFIX
Method Detail |
---|
int getTotalUserCount()
@Nonnull Set<com.atlassian.crowd.embedded.api.User> getAllUsers()
getUsers()
.
@Nonnull Collection<com.atlassian.crowd.embedded.api.User> getUsers()
@Nonnull Collection<ApplicationUser> getAllApplicationUsers()
com.atlassian.crowd.embedded.api.Group getGroup(@Nullable String groupName)
getGroupObject(String)
.
Group
based on user name.
WARNING: This method will be changed in the future to return a Crowd Group
object. Since v4.3.
groupName
- the user name of the group
com.atlassian.crowd.embedded.api.Group getGroupObject(@Nullable String groupName)
Group
based on user name.
WARNING: This method will be changed in the future to return a Crowd Group
object. Since v4.3.
groupName
- the user name of the group
com.atlassian.crowd.embedded.api.User createUserWithNotification(String username, String password, String email, String fullname, int userEventType) throws PermissionException, CreateException
Email notification will be send to created user.
username
- The username of the new user. Needs to be lowercase and unique.password
- The password for the new user.email
- The email for the new user. Needs to be a valid email address.fullname
- The full name for the new useruserEventType
- The event type dispatched on user creation
PermissionException
- If the operation was not permitted.
CreateException
com.atlassian.crowd.embedded.api.User createUserWithNotification(String username, String password, String email, String fullname, Long directoryId, int userEventType) throws PermissionException, CreateException
Email notification will be send to created user.
username
- The username of the new user. Needs to be lowercase and unique.password
- The password for the new user.email
- The email for the new user. Needs to be a valid email address.fullname
- The full name for the new userdirectoryId
- The directory to create the user in. Null means "first writable directory".userEventType
- The event type dispatched on user creation
PermissionException
- If the operation was not permitted.
CreateException
com.atlassian.crowd.embedded.api.User createUserNoNotification(String username, String password, String emailAddress, String displayName) throws PermissionException, CreateException
No email notification will be send to created user.
username
- The username of the new user. Needs to be lowercase and unique.password
- The password for the new user.emailAddress
- The email for the new user. Needs to be a valid email address.displayName
- The display name for the new user
PermissionException
- If the operation was not permitted.
CreateException
com.atlassian.crowd.embedded.api.User createUserNoNotification(String username, String password, String emailAddress, String displayName, Long directoryId) throws PermissionException, CreateException
No email notification will be send to created user.
username
- The username of the new user. Needs to be lowercase and unique.password
- The password for the new user.emailAddress
- The email for the new user. Needs to be a valid email address.displayName
- The display name for the new userdirectoryId
- The directory to create the user in. Null means "first writable directory".
PermissionException
- If the operation was not permitted.
CreateException
void removeUser(com.atlassian.crowd.embedded.api.User loggedInUser, com.atlassian.crowd.embedded.api.User user)
removeUser(ApplicationUser, ApplicationUser)
instead. Since v6.0.
loggedInUser
- the user performing operationuser
- the user to deletevoid removeUser(ApplicationUser loggedInUser, ApplicationUser user)
loggedInUser
- the user performing operationuser
- the user to deletevoid addUserToGroup(com.atlassian.crowd.embedded.api.Group group, com.atlassian.crowd.embedded.api.User userToAdd) throws PermissionException, AddException
group
- the group to add the user to.userToAdd
- the user to add to the group.
PermissionException
AddException
void addUserToGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups, com.atlassian.crowd.embedded.api.User userToAdd) throws PermissionException, AddException
groups
- a list containing the groups to add the user to.userToAdd
- the user to add to the group.
PermissionException
AddException
void removeUserFromGroup(com.atlassian.crowd.embedded.api.Group group, com.atlassian.crowd.embedded.api.User userToRemove) throws PermissionException, RemoveException
group
- the group to add the user to.userToRemove
- the user to add to the group.
PermissionException
RemoveException
void removeUserFromGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups, com.atlassian.crowd.embedded.api.User userToRemove) throws PermissionException, RemoveException
groups
- a list containing the groups to add the user to.userToRemove
- the user to add to the group.
PermissionException
RemoveException
UserUtil.PasswordResetToken generatePasswordResetToken(com.atlassian.crowd.embedded.api.User user)
user
- the user in question. This MUST not be null
UserUtil.PasswordResetTokenValidation validatePasswordResetToken(com.atlassian.crowd.embedded.api.User user, String token)
user
- the user in playtoken
- the token they provided
void changePassword(com.atlassian.crowd.embedded.api.User user, String newPassword) throws com.atlassian.crowd.exception.UserNotFoundException, com.atlassian.crowd.exception.InvalidCredentialException, com.atlassian.crowd.exception.OperationNotPermittedException, PermissionException
user
- the user in playnewPassword
- their new password
com.atlassian.crowd.exception.UserNotFoundException
- if the user does not exist
com.atlassian.crowd.exception.InvalidCredentialException
- if the password is invalid
com.atlassian.crowd.exception.OperationNotPermittedException
- if the underlying User Directory is read-only
PermissionException
int getActiveUserCount()
clearActiveUserCount()
to clear the cache.
Please note that the calculation will be run if the license does not specify a user limit.
Permissions
void clearActiveUserCount()
boolean hasExceededUserLimit()
boolean canActivateNumberOfUsers(int numUsers)
numUsers
- the number of users to add to the JIRA instance. If 0, all things being equal, this method will
return true. Must not be negative!
boolean canActivateUsers(Collection<String> userNames)
userNames
- the names of the users to add to the JIRA instance. Must not be null!
com.atlassian.crowd.embedded.api.User getUser(String userName)
getUserByKey(String)
or getUserByName(String)
instead. Since v6.0.
userName
- the user name of the user
ApplicationUser getUserByKey(String userkey)
userkey
- the key of the user
ApplicationUser getUserByName(String username)
username
- the user name of the user
com.atlassian.crowd.embedded.api.User getUserObject(String userName)
getUserByKey(String)
or getUserByName(String)
instead. Since v6.0.
userName
- the user name of the user
boolean userExists(String userName)
userName
- the name of the user
Collection<com.atlassian.crowd.embedded.api.User> getAdministrators()
getJiraAdministrators()
.
User
s.
WARNING: This method will be changed in the future to return a Collection of Crowd User
objects. Since v4.3.
User
s.Collection<com.atlassian.crowd.embedded.api.User> getJiraAdministrators()
User
s.
WARNING: This method will be changed in the future to return a Collection of Crowd User
objects. Since v4.3.
User
s.Collection<com.atlassian.crowd.embedded.api.User> getSystemAdministrators()
getJiraSystemAdministrators()
.
User
s.
WARNING: This method will be changed in the future to return a Collection of Crowd User
objects. Since v4.3.
User
's that are associated with the Permissions.SYSTEM_ADMIN
permission.Collection<com.atlassian.crowd.embedded.api.User> getJiraSystemAdministrators()
User
s.
WARNING: This method will be changed in the future to return a Collection of Crowd User
objects. Since v4.3.
User
's that are associated with the Permissions.SYSTEM_ADMIN
permission.void addToJiraUsePermission(com.atlassian.crowd.embedded.api.User user) throws PermissionException
Permissions.USE
) Note: operation is only performed if by doing so we will not
exceed the user limit (if the current license happens to specify a limit)
user
- The user to be added to the USE permission
PermissionException
Collection<ProjectComponent> getComponentsUserLeads(com.atlassian.crowd.embedded.api.User user)
user
- User leading components
Collection<ProjectComponent> getComponentsUserLeads(ApplicationUser user)
user
- User leading components
Collection<Project> getProjectsLeadBy(com.atlassian.crowd.embedded.api.User user)
user
- the user in play
GenericValue
sCollection<Project> getProjectsLeadBy(ApplicationUser user)
user
- the user in play
GenericValue
sboolean isNonSysAdminAttemptingToDeleteSysAdmin(com.atlassian.crowd.embedded.api.User loggedInUser, com.atlassian.crowd.embedded.api.User user)
loggedInUser
- User performing operationuser
- User for remove
boolean isNonSysAdminAttemptingToDeleteSysAdmin(ApplicationUser loggedInUser, ApplicationUser user)
loggedInUser
- User performing operationuser
- User for remove
long getNumberOfReportedIssuesIgnoreSecurity(com.atlassian.crowd.embedded.api.User loggedInUser, com.atlassian.crowd.embedded.api.User user) throws SearchException
loggedInUser
- the logged in useruser
- the user to find the issue count for
SearchException
- if something goes wronglong getNumberOfReportedIssuesIgnoreSecurity(ApplicationUser loggedInUser, ApplicationUser user) throws SearchException
loggedInUser
- the logged in useruser
- the user to find the issue count for
SearchException
- if something goes wronglong getNumberOfAssignedIssuesIgnoreSecurity(com.atlassian.crowd.embedded.api.User loggedInUser, com.atlassian.crowd.embedded.api.User user) throws SearchException
loggedInUser
- the logged in useruser
- the user to find the issue count for
SearchException
- if something goes wronglong getNumberOfAssignedIssuesIgnoreSecurity(ApplicationUser loggedInUser, ApplicationUser user) throws SearchException
loggedInUser
- the logged in useruser
- the user to find the issue count for
SearchException
- if something goes wrongString getDisplayableNameSafely(com.atlassian.crowd.embedded.api.User user)
user
- the user. May be null.
String getDisplayableNameSafely(ApplicationUser user)
user
- the user. May be null.
SortedSet<com.atlassian.crowd.embedded.api.Group> getGroupsForUser(String userName)
Group
objects that the user belongs to.
userName
- A User name
SortedSet<String> getGroupNamesForUser(String userName)
userName
- A User name
SortedSet<com.atlassian.crowd.embedded.api.User> getAllUsersInGroupNames(Collection<String> groupNames)
User
objects that belong to any of the passed in collection of group names.
Prefer using getAllUsersInGroupNamesUnsorted(java.util.Collection)
and sorting the list of users only
if absolutely necessary rather than relying on this method to perform the sort.
groupNames
- a collection of group name strings
UserBestNameComparator
orderSet<com.atlassian.crowd.embedded.api.User> getAllUsersInGroupNamesUnsorted(Collection<String> groupNames)
User
objects that belong to any of the passed in collection of group names.
groupNames
- a collection of group name strings
SortedSet<com.atlassian.crowd.embedded.api.User> getUsersInGroupNames(Collection<String> groupNames)
getAllUsersInGroupNames(java.util.Collection)
instead. Since v4.3
User
objects that are found within the passed in collection
of group names. Null users are excluded even if they exist in the underlying data.
groupNames
- a collection of group name strings
SortedSet<com.atlassian.crowd.embedded.api.User> getAllUsersInGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups)
User
objects that are found within the passed in collection of Group
objects.
groups
- a collection of Group
objects
UserBestNameComparator
orderSortedSet<com.atlassian.crowd.embedded.api.User> getUsersInGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups)
getAllUsersInGroups(java.util.Collection)
instead. Since v4.3
User
objects that are found within the passed in collection
of Group
objects. Null users are excluded even if they exist in the underlying data.
groups
- a collection of Group
objects
UserBestNameComparator
order
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |