|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserManager
Simple user utilities that do not require an implementation with too many dependencies.
Method Summary | |
---|---|
boolean |
canDirectoryUpdateUserPassword(com.atlassian.crowd.embedded.api.Directory directory)
Checks if the given directory is able to update user passwords. |
boolean |
canUpdateGroupMembershipForUser(com.atlassian.crowd.embedded.api.User user)
Test if this user's group membership can be updated, i.e. |
boolean |
canUpdateUser(com.atlassian.crowd.embedded.api.User user)
Test if this user can be updated, i.e. |
boolean |
canUpdateUserPassword(com.atlassian.crowd.embedded.api.User user)
Test if this user's password can be updated, i.e. |
com.atlassian.crowd.embedded.api.User |
findUserInDirectory(String userName,
Long directoryId)
Returns a User based on user name and directoryId |
Set<Group> |
getAllGroups()
Deprecated. Use getGroups() . Since v4.3 |
Set<User> |
getAllUsers()
Deprecated. Use getUsers() . Since v4.3 |
com.atlassian.crowd.embedded.api.Directory |
getDirectory(Long directoryId)
|
Group |
getGroup(String groupName)
Deprecated. Since v4.3. Use getGroupObject(String) . |
com.atlassian.crowd.embedded.api.Group |
getGroupObject(String groupName)
Returns a Group based on user name. |
Collection<com.atlassian.crowd.embedded.api.Group> |
getGroups()
Returns all groups defined in JIRA. |
int |
getTotalUserCount()
Returns the total number of users defined in JIRA, regardless of whether they are active or not. |
User |
getUser(String userName)
Deprecated. Since v4.3. Use getUserObject(String) . |
com.atlassian.crowd.embedded.api.User |
getUserEvenWhenUnknown(String userName)
Returns a User based on user name. |
com.atlassian.crowd.embedded.api.User |
getUserObject(String userName)
Returns a User based on user name. |
Collection<com.atlassian.crowd.embedded.api.User> |
getUsers()
Returns all users defined in JIRA, regardless of whether they are active or not. |
List<com.atlassian.crowd.embedded.api.Directory> |
getWritableDirectories()
Returns an ordered list of directories that have "read-write" permission. |
boolean |
hasPasswordWritableDirectory()
Returns true if any of the directories have permission to update user passwords, false if otherwise. |
Method Detail |
---|
int getTotalUserCount()
@NotNull Set<User> getAllUsers()
getUsers()
. Since v4.3
@NotNull Collection<com.atlassian.crowd.embedded.api.User> getUsers()
User getUser(@Nullable String userName)
getUserObject(String)
.
User
based on user name.
userName
- the user name of the user
com.atlassian.crowd.embedded.api.User getUserObject(@Nullable String userName)
User
based on user name.
userName
- the user name of the user
com.atlassian.crowd.embedded.api.User findUserInDirectory(String userName, Long directoryId)
User
based on user name and directoryId
userName
- the user name of the userdirectoryId
- the Directory to look in
com.atlassian.crowd.embedded.api.User getUserEvenWhenUnknown(String userName)
User
based on user name.
If a null username is passed, then a null User object is returned, but it is guaranteed to return a non-null User in all other cases.
If the username is not null, but the User is not found then a proxy unknown immutable User object is returned.
userName
- the user name of the user
boolean canUpdateUser(com.atlassian.crowd.embedded.api.User user)
If the "External user management" setting is on, then you cannot update the user.
user
- The user to update.
boolean canUpdateUserPassword(com.atlassian.crowd.embedded.api.User user)
If the "External user management", or "External password management" setting is on, then you cannot update the password.
user
- The user to update.
boolean canUpdateGroupMembershipForUser(com.atlassian.crowd.embedded.api.User user)
user
- The user to update.
Set<Group> getAllGroups()
getGroups()
. Since v4.3
Collection<com.atlassian.crowd.embedded.api.Group> getGroups()
Group getGroup(@Nullable String groupName)
getGroupObject(String)
.
Group
based on user name.
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 to return a Group
. Since v4.3
groupName
- the user name of the group
List<com.atlassian.crowd.embedded.api.Directory> getWritableDirectories()
boolean hasPasswordWritableDirectory()
boolean canDirectoryUpdateUserPassword(com.atlassian.crowd.embedded.api.Directory directory)
directory
-
com.atlassian.crowd.embedded.api.Directory getDirectory(Long directoryId)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |