UserManager (Atlassian JIRA 7.8.1 API)

All Known Implementing Classes:

DefaultUserManager, MockUserManager
```
@PublicApi
public interface UserManager
```
Simple user utilities that do not require an implementation with too many dependencies.

Since:

v4.0

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`UserManager.UserState` The current state of a user with regard to the same username existing in other user directories.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`canDirectoryUpdateUserPassword(com.atlassian.crowd.embedded.api.Directory directory)` Checks if the given directory is able to update user passwords.
`boolean`	`canRenameUser(ApplicationUser user)` Test if this user can be renamed.
`boolean`	`canUpdateGroupMembershipForUser(ApplicationUser user)` Test if this user's group membership can be updated, i.e.
`boolean`	`canUpdateUser(ApplicationUser user)` Test if this user can be updated, i.e.
`boolean`	`canUpdateUserPassword(ApplicationUser user)` Test if this user's password can be updated, i.e.
`ApplicationUser`	`createUser(UserDetails userData)` Creates a user in the specified directory (userDirectoryId).
`ApplicationUser`	`findUserInDirectory(String userName, Long directoryId)` Returns a `User` based on user name and directoryId
`String`	`generateRandomPassword()` Generates a random password that can be used when the admin has entered a blank password.
`Collection<ApplicationUser>`	`getAllApplicationUsers()` Deprecated. Since v7.0. Only retrieve the users you really need. See `UserSearchService`
`Set<com.atlassian.crowd.embedded.api.Group>`	`getAllGroups()` Deprecated. Since v7.0. Only retrieve the groups you really need. See `GroupPickerSearchService`
`Set<ApplicationUser>`	`getAllUsers()` Deprecated. Since v7.0. Only retrieve the users you really need. See `UserSearchService`
`Optional<com.atlassian.crowd.embedded.api.Directory>`	`getDefaultCreateDirectory()` Get the `Directory` in which users will be created by default
`com.atlassian.crowd.embedded.api.Directory`	`getDirectory(Long directoryId)`
`com.atlassian.crowd.embedded.api.Group`	`getGroup(String groupName)` Returns a `Group` based on user name.
`com.atlassian.crowd.embedded.api.Group`	`getGroupObject(String groupName)` Returns a `Group` based on user name.
`Collection<com.atlassian.crowd.embedded.api.Group>`	`getGroups()` Deprecated. Since v7.0. Only retrieve the users you really need. See `GroupPickerSearchService`
`int`	`getTotalUserCount()` Returns the total number of users defined in JIRA, regardless of whether they are active or not.
`ApplicationUser`	`getUser(String userName)` Deprecated. Use `getUserByKey(String)` or `getUserByName(String)` instead. Since v6.0.
`Optional<ApplicationUser>`	`getUserById(Long id)` Returns a user based in id.
`ApplicationUser`	`getUserByKey(String userKey)` Returns an `ApplicationUser` based on user key.
`ApplicationUser`	`getUserByKeyEvenWhenUnknown(String userKey)` Returns an `ApplicationUser` based on user key.
`ApplicationUser`	`getUserByName(String userName)` Returns an `ApplicationUser` based on user name.
`ApplicationUser`	`getUserByNameEvenWhenUnknown(String userName)` Returns an `ApplicationUser` based on user name.
`ApplicationUser`	`getUserEvenWhenUnknown(String userName)` Deprecated. Use `getUserByKeyEvenWhenUnknown(String)` or `getUserByNameEvenWhenUnknown(String)` instead. Since v6.0.
`Optional<UserIdentity>`	`getUserIdentityById(Long id)` Returns an identity of the user with the specified id.
`Optional<UserIdentity>`	`getUserIdentityByKey(String key)` Returns an identity of the user with the specified key.
`Optional<UserIdentity>`	`getUserIdentityByUsername(String username)` Returns an identity of the user with the specified username.
`ApplicationUser`	`getUserObject(String userName)` Deprecated. Use `getUserByKey(String)` or `getUserByName(String)` instead. Since v6.0.
`Collection<ApplicationUser>`	`getUsers()` Deprecated. Since v7.0. Only retrieve the users you really need. See `UserSearchService`
`UserManager.UserState`	`getUserState(ApplicationUser user)` This convenience method is equivalent to `getUserState(user.getUsername(), user.getDirectoryId())` except that a `null` user is permitted and returns `UserManager.UserState.INVALID_USER`.
`UserManager.UserState`	`getUserState(String username, long directoryId)` Checks for the existence of this user across all directories to determine whether or not the user exists in the specified directory and whether or not it is shadowing or shadowed by a user with the same username in another active user directory.
`List<com.atlassian.crowd.embedded.api.Directory>`	`getWritableDirectories()` Returns an ordered list of directories that have "read-write" permission.
`boolean`	`hasGroupWritableDirectory()` Returns true if any of the directories have permission to update groups.
`boolean`	`hasPasswordWritableDirectory()` Returns true if any of the directories have permission to update user passwords, false if otherwise.
`boolean`	`hasWritableDirectory()` Returns true if at least one User Directory has "read-write" permission.
`boolean`	`isUserExisting(ApplicationUser user)` Checks if given user is existing user
`void`	`updateUser(ApplicationUser user)` Updates the `ApplicationUser`.
`boolean`	`userCanUpdateOwnDetails(ApplicationUser user)` Check if this user is allowed to update their own user details.

- 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
```
@Nonnull
 @Deprecated
Set<ApplicationUser> getAllUsers()
```
    Deprecated. Since v7.0. Only retrieve the users you really need. See UserSearchService
    
    Returns all users defined in JIRA, regardless of whether they are active or not.
    
    Returns:
    
    the set of all users
    
    Since:
    
    v4.0
  - getUsers
```
@Nonnull
 @Deprecated
Collection<ApplicationUser> getUsers()
```
    Deprecated. Since v7.0. Only retrieve the users you really need. See UserSearchService
    
    Returns all users defined in JIRA, regardless of whether they are active or not.
    Legacy synonym for getAllUsers().
    
    Returns:
    
    the collection of all users
    
    Since:
    
    v4.3
    
    See Also:
    
    getAllUsers()
  - getAllApplicationUsers
```
@Nonnull
 @Deprecated
Collection<ApplicationUser> getAllApplicationUsers()
```
    Deprecated. Since v7.0. Only retrieve the users you really need. See UserSearchService
    
    Returns all users defined in JIRA, regardless of whether they are active or not.
    
    Returns:
    
    the set of all users
    
    Since:
    
    v6.0
  - getUser
```
ApplicationUser getUser(@Nullable
                        String userName)
```
    Deprecated. Use getUserByKey(String) or getUserByName(String) instead. Since v6.0.
    
    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
  - getUserObject
```
ApplicationUser getUserObject(@Nullable
                              String userName)
```
    Deprecated. Use getUserByKey(String) or getUserByName(String) instead. Since v6.0.
    
    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.3
  - getUserById
```
Optional<ApplicationUser> getUserById(Long id)
```
    Returns a user based in id.
    
    Parameters:
    
    id - user id
    
    Returns:
    
    user if found or none
  - getUserByKey
```
@Nullable
ApplicationUser getUserByKey(@Nullable
                                       String userKey)
```
    Returns an ApplicationUser based on user key.
    
    Parameters:
    
    userKey - the key of the user
    
    Returns:
    
    the ApplicationUser object
    
    Since:
    
    v5.1.1
  - getUserByName
```
@Nullable
ApplicationUser getUserByName(@Nullable
                                        String userName)
```
    Returns an ApplicationUser based on user name.
    
    Parameters:
    
    userName - the user name of the user
    
    Returns:
    
    the ApplicationUser object
    
    Throws:
    
    IllegalStateException - if the CrowdService is able to resolve userName to a User, but the UserKeyService does not have a key mapped for it. This is not a valid configuration.
    
    Since:
    
    v5.1.1
  - getUserByKeyEvenWhenUnknown
```
@Nullable
ApplicationUser getUserByKeyEvenWhenUnknown(@Nullable
                                                      String userKey)
```
    Returns an ApplicationUser based on user key.
    If you want to check if given user is known user - please use isUserExisting(com.atlassian.jira.user.ApplicationUser)
    
    Parameters:
    
    userKey - the key of the user
    
    Returns:
    
    the ApplicationUser object, or proxy unknown immutable ApplicationUser object (null iff the key is null).
    
    Since:
    
    v6.0
  - getUserByNameEvenWhenUnknown
```
@Nullable
ApplicationUser getUserByNameEvenWhenUnknown(@Nullable
                                                       String userName)
```
    Returns an ApplicationUser based on user name.
    If you want to check if given user is known user - please use isUserExisting(com.atlassian.jira.user.ApplicationUser)
    
    Parameters:
    
    userName - the user name of the user
    
    Returns:
    
    the ApplicationUser object, or proxy unknown immutable ApplicationUser object (null iff the username is null).
    
    Throws:
    
    IllegalStateException - if the CrowdService is able to resolve userName to a User, but the UserKeyService does not have a key mapped for it. This is not a valid configuration.
    
    Since:
    
    v6.0
  - findUserInDirectory
```
@Nullable
ApplicationUser findUserInDirectory(@Nullable
                                              String userName,
                                              Long directoryId)
```
    Returns a User based on user name and directoryId
    
    Parameters:
    
    userName - the user name of the user
    
    directoryId - the Directory to look in
    
    Returns:
    
    the User object, or null if the user cannot be found including null userName.
    
    Since:
    
    v4.3.2
  - getUserEvenWhenUnknown
```
@Nullable
ApplicationUser getUserEvenWhenUnknown(@Nullable
                                                 String userName)
```
    Deprecated. Use getUserByKeyEvenWhenUnknown(String) or getUserByNameEvenWhenUnknown(String) instead. Since v6.0.
    
    Returns a 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.
    
    Parameters:
    
    userName - the user name of the user
    
    Returns:
    
    the User object, or proxy unknown immutable User object (null iff the username is null).
    
    Since:
    
    v4.3
  - canUpdateUser
```
boolean canUpdateUser(@Nonnull
                      ApplicationUser user)
```
    Test if this user can be updated, i.e. is in a writable directory. This relies upon the local directory configuration and does not guarantee that the actual remote directory, e.g. the remote LDAP directory, will actually allow the user to be updated.
    
    Parameters:
    
    user - The user to update.
    
    Returns:
    
    true if the user can be updated.
  - userCanUpdateOwnDetails
```
@ExperimentalApi
boolean userCanUpdateOwnDetails(@Nonnull
                                                 ApplicationUser user)
```
    Check if this user is allowed to update their own user details.
    Returns true if the given user is in a read-write directory AND the "External user management" setting is off.
    
    Parameters:
    
    user - The user
    
    Returns:
    
    true if the given user is in a read-write directory AND the "External user management" setting is off.
    
    Since:
    
    6.4
  - canRenameUser
```
boolean canRenameUser(@Nullable
                      ApplicationUser user)
```
    Test if this user can be renamed. In addition to the constraints of canUpdateUser(ApplicationUser), renaming a user is only allowed when:
    1. The user is in either an INTERNAL or DELEGATING user directory; AND
    2. Either JIRA is not configured as a crowd server, or APKeys.JIRA_OPTION_USER_CROWD_ALLOW_RENAME is enabled to bypass this check.
    Parameters:
    
    user - The user to rename.
    
    Returns:
    
    true if the user is not null and can be renamed.
    
    Since:
    
    v6.0
  - updateUser
```
void updateUser(ApplicationUser user)
```
    Updates the ApplicationUser. The user must have non-null names and email address. If the user's name does not match the name that is currently associated with the key, then this is implicitly treated as a request to rename the user.
    
    Parameters:
    
    user - The user to update.
    
    Throws:
    
    com.atlassian.crowd.exception.runtime.UserNotFoundException - If the supplied user does not exist in the directory.
    
    com.atlassian.crowd.exception.runtime.OperationFailedException - If the underlying directory implementation failed to execute the operation.
    
    IllegalArgumentException - If something is wrong with the provided user object
    
    Since:
    
    v6.0
  - canUpdateUserPassword
```
boolean canUpdateUserPassword(@Nullable
                              ApplicationUser user)
```
    Test if this user's password can be updated, i.e. is in a writable directory which is not a Delegated LDAP directory. This relies upon the local directory configuration and does not guarantee that the actual remote directory, e.g. the remote LDAP directory, will actually allow the user to be updated.
    If the "External user management", or "External password management" setting is on, then you cannot update the password.
    
    Parameters:
    
    user - The user to update.
    
    Returns:
    
    true if the user is not null and the user's password can be updated.
  - canUpdateGroupMembershipForUser
```
boolean canUpdateGroupMembershipForUser(ApplicationUser user)
```
    Test if this user's group membership can be updated, i.e. is in a writable directory or a directory with Local Group support. This relies upon the local directory configuration and does not guarantee that the actual remote directory, e.g. the remote LDAP directory, will actually allow the user membership to be updated.
    
    Parameters:
    
    user - The user to update.
    
    Returns:
    
    true if the user is not null and can be updated.
  - getAllGroups
```
@IncompatibleReturnType(since="5.0",
                        was="java.util.Set<com.opensymphony.user.Group>")
 @Deprecated
Set<com.atlassian.crowd.embedded.api.Group> getAllGroups()
```
    Deprecated. Since v7.0. Only retrieve the groups you really need. See GroupPickerSearchService
    
    Returns all groups defined in JIRA.
    Warning: previous incarnations of this method returned com.opensymphony.user.User. This class has now been removed from the JIRA API, meaning that the 5.0 version is not binary or source compatible with earlier versions.
    
    Returns:
    
    the set of all groups
    
    Since:
    
    v4.0
  - getGroups
```
@Deprecated
Collection<com.atlassian.crowd.embedded.api.Group> getGroups()
```
    Deprecated. Since v7.0. Only retrieve the users you really need. See GroupPickerSearchService
    
    Returns all groups defined in JIRA.
    Legacy synonym for getAllGroups().
    
    Returns:
    
    the set of all groups
    
    Since:
    
    v4.3
    
    See Also:
    
    getAllGroups()
  - getGroup
```
@IncompatibleReturnType(since="5.0",
                        was="com.opensymphony.user.User")
com.atlassian.crowd.embedded.api.Group getGroup(@Nullable
                                                                                                                                               String groupName)
```
    Returns a Group based on user name.
    Warning: previous incarnations of this method returned com.opensymphony.user.User. This class has now been removed from the JIRA API, meaning that the 5.0 version is not binary or source compatible with earlier versions.
    
    Parameters:
    
    groupName - the user name of the group
    
    Returns:
    
    the Group object, or null if the group cannot be found including null groupName.
    
    Since:
    
    v4.0
  - getGroupObject
```
com.atlassian.crowd.embedded.api.Group getGroupObject(@Nullable
                                                      String groupName)
```
    Returns a Group based on user name.
    Legacy synonym for getGroup(String).
    
    Parameters:
    
    groupName - the user name of the group
    
    Returns:
    
    the Group object, or null if the group cannot be found including null groupName.
    
    Since:
    
    v4.3
    
    See Also:
    
    getGroup(String)
  - getWritableDirectories
```
@Nonnull
List<com.atlassian.crowd.embedded.api.Directory> getWritableDirectories()
```
    Returns an ordered list of directories that have "read-write" permission. ie those directories that we can add a user to.
    
    Returns:
    
    an ordered list of directories that have "read-write" permission.
    
    See Also:
    
    hasWritableDirectory()
  - getDefaultCreateDirectory
```
@Nonnull
Optional<com.atlassian.crowd.embedded.api.Directory> getDefaultCreateDirectory()
```
    Get the Directory in which users will be created by default
    
    Returns:
    
    Directory or Option.none() in case there is no writable directories
  - hasWritableDirectory
```
boolean hasWritableDirectory()
```
    Returns true if at least one User Directory has "read-write" permission.
    This is equivalent to:
    getWritableDirectories().size() > 0
    
    Returns:
    
    true if at least one User Directory has "read-write" permission.
    
    See Also:
    
    getWritableDirectories(), hasPasswordWritableDirectory(), hasGroupWritableDirectory()
  - hasPasswordWritableDirectory
```
boolean hasPasswordWritableDirectory()
```
    Returns true if any of the directories have permission to update user passwords, false if otherwise.
    Note that this is not quite the same as hasWritableDirectory() because of "Internal with LDAP Authentication" directories. These directories are generally read-write but passwords are read-only.
    
    Returns:
    
    true if any of the directories have permission to update user passwords, false if otherwise.
    
    See Also:
    
    hasWritableDirectory()
  - hasGroupWritableDirectory
```
boolean hasGroupWritableDirectory()
```
    Returns true if any of the directories have permission to update groups.
    Note that this will not always return the same results as hasWritableDirectory() because you can set "Read-Only with Local Groups" to LDAP directories. These directories are generally read-only but you can create local gropus and assign users to them.
    
    Returns:
    
    true if any of the directories have permission to update groups, false if otherwise.
    
    See Also:
    
    hasWritableDirectory()
  - canDirectoryUpdateUserPassword
```
boolean canDirectoryUpdateUserPassword(@Nullable
                                       com.atlassian.crowd.embedded.api.Directory directory)
```
    Checks if the given directory is able to update user passwords.
    
    Parameters:
    
    directory - the Directory
    
    Returns:
    
    true if the directory can update user passwords, false if otherwise.
  - getDirectory
```
com.atlassian.crowd.embedded.api.Directory getDirectory(Long directoryId)
```
  - isUserExisting
```
boolean isUserExisting(@Nullable
                       ApplicationUser user)
```
    Checks if given user is existing user
    
    Parameters:
    
    user - possible existing user object - i.e. recieved from getUserByKeyEvenWhenUnknown(String) or getUserByNameEvenWhenUnknown(String)
    
    Returns:
    
    true if given user is real user, false otherwise (also when given object is null)
    
    See Also:
    
    getUserByKeyEvenWhenUnknown(String), getUserByNameEvenWhenUnknown(String)
  - generateRandomPassword
```
@Nonnull
String generateRandomPassword()
```
    Generates a random password that can be used when the admin has entered a blank password.
    The password is guaranteed to contain at least one upper-case letter, lower-case letter and number in case the backend user Directory has password restrictions.
    
    Returns:
    
    a random password.
    
    Since:
    
    6.4
  - getUserState
```
@ExperimentalApi
 @Nonnull
UserManager.UserState getUserState(@Nonnull
                                                              String username,
                                                              long directoryId)
```
    Checks for the existence of this user across all directories to determine whether or not the user exists in the specified directory and whether or not it is shadowing or shadowed by a user with the same username in another active user directory.
    
    Parameters:
    
    username - the username to check
    
    directoryId - the directory ID of the user directory that the user came from
    
    Returns:
    
    the shadowing state of the specified user
  - getUserState
```
@ExperimentalApi
 @Nonnull
UserManager.UserState getUserState(@Nullable
                                                              ApplicationUser user)
```
    This convenience method is equivalent to getUserState(user.getUsername(), user.getDirectoryId()) except that a null user is permitted and returns UserManager.UserState.INVALID_USER.
    
    Parameters:
    
    user - the user to check
    
    Returns:
    
    the shadowing state of the specified user
  - createUser
```
@Nonnull
 @ExperimentalApi
ApplicationUser createUser(@Nonnull
                                                      UserDetails userData)
                                               throws CreateException,
                                                      PermissionException
```
    Creates a user in the specified directory (userDirectoryId). If the directory is Option.none(), the user is created in the default directory (usually an Embedded Crowd internal directory).
    
    Parameters:
    
    userData - the user request containing user details.
    
    Returns:
    
    the newly created user.
    
    Throws:
    
    CreateException - unable to create user.
    
    PermissionException - unable to create user due to permission error.
    
    Since:
    
    v7.0
  - getUserIdentityById
```
Optional<UserIdentity> getUserIdentityById(Long id)
```
    Returns an identity of the user with the specified id.
    
    Parameters:
    
    id - user id
    
    Returns:
    
    user identity or none if no user with the specified key exists.
  - getUserIdentityByKey
```
Optional<UserIdentity> getUserIdentityByKey(String key)
```
    Returns an identity of the user with the specified key.
    
    Parameters:
    
    key - user key
    
    Returns:
    
    user identity or none if no user with the specified key exists.
  - getUserIdentityByUsername
```
Optional<UserIdentity> getUserIdentityByUsername(String username)
```
    Returns an identity of the user with the specified username.
    
    Parameters:
    
    username - user name
    
    Returns:
    
    user identity or none if no user with the specified username exists.

Interface UserManager

Nested Class Summary

Method Summary

Method Detail

getTotalUserCount

getAllUsers

getUsers

getAllApplicationUsers

getUser

getUserObject

getUserById

getUserByKey

getUserByName

getUserByKeyEvenWhenUnknown

getUserByNameEvenWhenUnknown

findUserInDirectory

getUserEvenWhenUnknown

canUpdateUser

userCanUpdateOwnDetails

canRenameUser

updateUser

canUpdateUserPassword

canUpdateGroupMembershipForUser

getAllGroups

getGroups

getGroup

getGroupObject

getWritableDirectories

getDefaultCreateDirectory

hasWritableDirectory

hasPasswordWritableDirectory

hasGroupWritableDirectory

canDirectoryUpdateUserPassword

getDirectory

isUserExisting

generateRandomPassword

getUserState

getUserState

createUser

getUserIdentityById

getUserIdentityByKey

getUserIdentityByUsername