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
 Set<Group> getAllGroups()
          Returns all groups defined in JIRA.
 Set<User> getAllUsers()
          Returns all users defined in JIRA, regardless of whether they are active or not.
 Group getGroup(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.
 User getUser(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
Set<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

User getUser(@Nullable
             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

Set<Group> getAllGroups()
Returns all groups defined in JIRA.

Returns:
the set of all groups
Since:
v4.0

getGroup

Group getGroup(@Nullable
               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


Copyright © 2002-2009 Atlassian. All Rights Reserved.