|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserUtil
This is a backend service level interface that defines an api for user level operations.
Field Summary | |
---|---|
static String |
META_PROPERTY_PREFIX
|
Method Summary | |
---|---|
void |
addToJiraUsePermission(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(Group group,
User userToAdd)
This is used to add a specified user to a specified group. |
void |
addUserToGroups(Collection<Group> groups,
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 |
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)
Given a valid validation result, this will create the user using the details provided in the validation result. |
User |
createUserWithEvent(String username,
String password,
String email,
String fullname,
int userEventType)
Given a valid validation result, this will create the user using the details provided in the validation result. |
int |
getActiveUserCount()
Returns the number of users that are currently 'active'. |
Collection<User> |
getAdministrators()
Returns a list of JIRA admin User s. |
Set<User> |
getAllUsers()
Returns the all user-names defined in JIRA, regardless of whether they are active or not. |
Collection<ProjectComponent> |
getComponentsUserLeads(User user)
Retrieve a collection of ProjectComponents - where the lead of each component is the specified user. |
String |
getDisplayableNameSafely(User user)
Takes the given user and returns a "displayable name" by cautiously checking the different edge cases for users. |
Group |
getGroup(String groupName)
Returns a Group based on user name. |
long |
getNumberOfAssignedIssuesIgnoreSecurity(User loggedInUser,
User user)
Returns number of issues assigned to user |
long |
getNumberOfReportedIssuesIgnoreSecurity(User loggedInUser,
User user)
Returns number of issues reported by user |
Collection<org.ofbiz.core.entity.GenericValue> |
getProjectsUserLeads(User user)
Returns all the projects that leadUser is the project lead for. |
Collection<User> |
getSystemAdministrators()
Returns a list of JIRA system admin User s. |
int |
getTotalUserCount()
Returns the total number of users defined in JIRA, regardless of whether they are active or not. |
User |
getUser(String userName)
Returns a user based on user name. |
SortedSet<User> |
getUsersInGroupNames(Collection<String> groupNames)
Returns a collection of User objects that are found within the passed in collection of group names. |
SortedSet<User> |
getUsersInGroups(Collection<Group> groups)
Returns a collection of User objects that are found within the passed in collection of Group objects. |
boolean |
hasExceededUserLimit()
Returns true if this JIRA instance has more active users, than allowed by the license. |
boolean |
isNonSysAdminAttemptingToDeleteSysAdmin(User loggedInUser,
User user)
Checking if user without SYSTEM_ADMIN rights tries to remove user with SYSTEM_ADMIN rights. |
void |
removeUser(User loggedInUser,
User user,
I18nHelper i18nBean)
Given a valid validation result, this will remove the user and removes the user from all the groups. |
void |
removeUserFromGroup(Group group,
User userToRemove)
This is used to remove a specified user from a specified group. |
void |
removeUserFromGroups(Collection<Group> groups,
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 |
Field Detail |
---|
static final String META_PROPERTY_PREFIX
Method Detail |
---|
int getTotalUserCount()
@NotNull Set<User> getAllUsers()
Group getGroup(@Nullable String groupName)
Group
based on user name.
groupName
- the user name of the group
User createUserWithEvent(String username, String password, String email, String fullname, int userEventType) throws ImmutableException, DuplicateEntityException
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
ImmutableException
- Generic exception ocurred when creating the user
DuplicateEntityException
- User with this username alread existsUser createUserNoEvent(String username, String password, String email, String fullname) throws ImmutableException, DuplicateEntityException
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 user
ImmutableException
- Generic exception ocurred when creating the user
DuplicateEntityException
- User with this username alread existsvoid removeUser(User loggedInUser, User user, I18nHelper i18nBean)
loggedInUser
- username of the user performing operationuser
- the user to deletei18nBean
- unused may as well be nullvoid addUserToGroup(Group group, User userToAdd)
group
- the group to add the user to.userToAdd
- the user to add to the group.void addUserToGroups(Collection<Group> groups, User userToAdd)
groups
- a list containing the groups to add the user to.userToAdd
- the user to add to the group.void removeUserFromGroup(Group group, User userToRemove)
group
- the group to add the user to.userToRemove
- the user to add to the group.void removeUserFromGroups(Collection<Group> groups, User userToRemove)
groups
- a list containing the groups to add the user to.userToRemove
- the user to add to the group.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!
User getUser(String userName)
userName
- the user name of the user
boolean userExists(String userName)
userName
- the name of the user
Collection<User> getAdministrators()
User
s.
User
s.Collection<User> getSystemAdministrators()
User
s.
Group
's that are associated with the Permissions.SYSTEM_ADMIN
permission.void addToJiraUsePermission(User user)
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 permissionCollection<ProjectComponent> getComponentsUserLeads(User user)
user
- User leading components
Collection<org.ofbiz.core.entity.GenericValue> getProjectsUserLeads(User user)
user
-
GenericValue
sboolean isNonSysAdminAttemptingToDeleteSysAdmin(User loggedInUser, User user)
loggedInUser
- User performing operationuser
- User for remove
long getNumberOfReportedIssuesIgnoreSecurity(User loggedInUser, User user) throws SearchException
user
- User
SearchException
long getNumberOfAssignedIssuesIgnoreSecurity(User loggedInUser, User user) throws SearchException
user
-
SearchException
String getDisplayableNameSafely(User user)
user
- the user. May be null.
SortedSet<User> getUsersInGroupNames(Collection<String> groupNames)
User
objects that are found within the passed in collection of group names.
groupNames
- a collection of group name strings
BestNameComparator
orderSortedSet<User> getUsersInGroups(Collection<Group> groups)
User
objects that are found within the passed in collection of Group
objects.
groups
- a collection of Group
objects
BestNameComparator
order
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |