com.atlassian.jira.user.util
Interface UserManager

All Known Implementing Classes:

DefaultUserManager, MockUserManager

public interface UserManager

Simple user utilities that do not require an implementation with too many dependencies.

Since:

v4.0

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<com.atlassian.crowd.embedded.api.Group>	getAllGroups() Returns all groups defined in JIRA.
Set<com.atlassian.crowd.embedded.api.User>	getAllUsers() Returns all users defined in JIRA, regardless of whether they are active or not.
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() 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.
com.atlassian.crowd.embedded.api.User	getUser(String userName) Returns a User based on user name.
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	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.
void	updateUser(com.atlassian.crowd.embedded.api.User user) Updates the User.

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
@IncompatibleReturnType(since="5.0",
                        was="java.util.Set")
Set<com.atlassian.crowd.embedded.api.User> getAllUsers()

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

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 users

Since:

v4.0

getUsers

@NotNull
Collection<com.atlassian.crowd.embedded.api.User> getUsers()

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()

getUser

@IncompatibleReturnType(since="5.0",
                        was="com.opensymphony.user.User")
com.atlassian.crowd.embedded.api.User getUser(@Nullable
                                                                             String userName)

Returns a User 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:

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

com.atlassian.crowd.embedded.api.User getUserObject(@Nullable
                                                    String userName)

Returns a User based on user name.

Legacy synonym for getUser(String).

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

See Also:

getUser(String)

findUserInDirectory

com.atlassian.crowd.embedded.api.User findUserInDirectory(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

com.atlassian.crowd.embedded.api.User getUserEvenWhenUnknown(String userName)

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(com.atlassian.crowd.embedded.api.User 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.

If the "External user management" setting is on, then you cannot update the user.

Parameters:

user - The user to update.

Returns:

true if the user can be updated.

updateUser

void updateUser(com.atlassian.crowd.embedded.api.User user)

Updates the User. The user must have non-null names and email address.

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.

Since:

v5.0

canUpdateUserPassword

boolean canUpdateUserPassword(com.atlassian.crowd.embedded.api.User 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's password can be updated.

canUpdateGroupMembershipForUser

boolean canUpdateGroupMembershipForUser(com.atlassian.crowd.embedded.api.User 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 can be updated.

getAllGroups

@IncompatibleReturnType(since="5.0",
                        was="java.util.Set")
Set<com.atlassian.crowd.embedded.api.Group> getAllGroups()

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

Collection<com.atlassian.crowd.embedded.api.Group> getGroups()

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 user 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 user cannot be found including null groupName.

Since:

v4.3

See Also:

getGroup(String)

getWritableDirectories

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()

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(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)