com.atlassian.jira.user.util
Interface UserManager

All Known Implementing Classes:

DefaultUserManager

public interface UserManager

Simple user utilities that do not require an implementation with too many dependencies. An injectible wrapper over the osuser UserManager.

Since:

v4.0

Method Summary

java.util.Set<com.opensymphony.user.Group>	getAllGroups() Returns all groups defined in JIRA.
java.util.Set<com.opensymphony.user.User>	getAllUsers() Returns all users defined in JIRA, regardless of whether they are active or not.
com.opensymphony.user.Group	getGroup(java.lang.String groupName) Returns a Group based on user name.
int	getTotalUserCount() Returns the total number of users defined in JIRA, regardless of whether they are active or not.
com.opensymphony.user.User	getUser(java.lang.String userName) Returns a User based on user name.

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
java.util.Set<com.opensymphony.user.User> getAllUsers()

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

Returns:

the set of all users

Since:

v4.0

getUser

com.opensymphony.user.User getUser(@Nullable
                                   java.lang.String userName)

Returns a User based on user name.

Parameters:

userName - the user name of the user

Returns:

the User object, or null if the user cannot be found including null userName.

Since:

v4.0

getAllGroups

java.util.Set<com.opensymphony.user.Group> getAllGroups()

Returns all groups defined in JIRA.

Returns:

the set of all groups

Since:

v4.0

getGroup

com.opensymphony.user.Group getGroup(@Nullable
                                     java.lang.String groupName)

Returns a Group based on user name.

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