com.atlassian.confluence.test.usermanagement

Interface UserManager

All Known Implementing Classes:

CrowdUserManager, DefaultUserManager

@PublicApi
public interface UserManager

Abstracts the process of creating/removing/updating users and groups so that we can use external user management in test cases.

Method Summary

Modifier and Type	Method and Description
void	activateUser(String username)
void	addGroupToGroup(Group childGroup, Group parentGroup) Add childGroup to parentGroup.
void	addUserToGroup(String userName, String groupName)
void	changePassword(String username, String newPassword) Change a user's password.
void	createGroup(String groupName)
UserWithDetails	createUser(UserWithDetails user) Creates the user, adds it to the default users group, and ensures the user profile is created (to work around CONF-6404).
void	deactivateUser(String username)
void	endBatch() Flag that the batch transactions are complete, that a sync should be performed immediately, and that syncing should be re-enabled for future requests.
void	fixUser(UserWithDetails user) Ensure that the user's details in the system match those in user.
Set<String>	getUserGroups(User user)
boolean	isExternal() Return true if this helper modifies Users, Groups and Group Memberships via RPC.
void	removeGroup(String groupName)
void	removeGroupUncleanly(String group) Removes a group but do not remove their dependent permissions.
void	removeMultipleUsers(List<String> users) Removes the list of users (calls removeUser(String))
void	removeUser(String username)
void	removeUserFromGroup(String userName, String groupName)
void	removeUserUncleanly(String username) Removes a user with the given username but do not remove their dependent permissions or pages.
void	renameUser(String oldUsername, String newUsername)
void	resetData(Set<User> usersToKeep, Set<Group> groupsToKeep, Map<Group,HashSet<User>> userGroupMembershipsToKeep) Return the User/Group/Membership data to a clean state.
List<String>	searchGroupNames(com.atlassian.crowd.embedded.api.SearchRestriction searchRestriction, int startIndex, int maxResults) Searches for group names matching the searchRestriction criteria.
List<Group>	searchGroups(com.atlassian.crowd.embedded.api.SearchRestriction searchRestriction, int startIndex, int maxResults) Searches for groups matching the following criteria.
List<String>	searchUserNames(com.atlassian.crowd.embedded.api.SearchRestriction searchRestriction, int startIndex, int maxResults) Searches for usernames matching the searchRestriction criteria.
List<UserWithDetails>	searchUsers(com.atlassian.crowd.embedded.api.SearchRestriction searchRestriction, int startIndex, int maxResults) Searches for users matching the following criteria.
void	setAutoSync(boolean autoSync)
void	startBatch() Flag that a number of user/group transactions are about to be performed in a block, and any syncing should pause until the batch is finished.
void	synchronise() Force a synchronisation with an external user directory.

Method Detail

createUser

UserWithDetails createUser(UserWithDetails user)

Creates the user, adds it to the default users group, and ensures the user profile is created (to work around CONF-6404).

addUserToGroup

void addUserToGroup(String userName,
                    String groupName)

getUserGroups

Set<String> getUserGroups(User user)

Parameters:

user - the user who's group membership is to be checked.

Returns:

the set of groups the user belongs to or an empty Set if none.

addGroupToGroup

void addGroupToGroup(Group childGroup,
                     Group parentGroup)

Add childGroup to parentGroup. Does nothing if the membership already exists.

removeUser

void removeUser(String username)

createGroup

void createGroup(String groupName)

removeUserFromGroup

void removeUserFromGroup(String userName,
                         String groupName)

removeGroup

void removeGroup(String groupName)

removeMultipleUsers

void removeMultipleUsers(List<String> users)

Removes the list of users (calls removeUser(String))

Parameters:

users - the list of users to remove

removeUserUncleanly

void removeUserUncleanly(String username)

Removes a user with the given username but do not remove their dependent permissions or pages.

Parameters:

username - the username of the user to remove

removeGroupUncleanly

void removeGroupUncleanly(String group)

Removes a group but do not remove their dependent permissions.

Parameters:

group - the group to remove

fixUser

void fixUser(UserWithDetails user)

Ensure that the user's details in the system match those in user. That is, it finds the user in the system by its username, and sets the full name and email address.

Parameters:

user - a user to set the details of

changePassword

void changePassword(String username,
                    String newPassword)

Change a user's password.

Parameters:

username - Username of the user whose password to change

newPassword - Password

setAutoSync

void setAutoSync(boolean autoSync)

resetData

void resetData(Set<User> usersToKeep,
               Set<Group> groupsToKeep,
               Map<Group,HashSet<User>> userGroupMembershipsToKeep)

Return the User/Group/Membership data to a clean state.

Parameters:

usersToKeep - the set of users to keep when resetting

groupsToKeep - the set of groups to keep when resetting

userGroupMembershipsToKeep - the memberships to keep

isExternal

boolean isExternal()

Return true if this helper modifies Users, Groups and Group Memberships via RPC. Return false if this helper makes calls to different server, e.g. LDAP or Crowd.

synchronise

void synchronise()

Force a synchronisation with an external user directory.

startBatch

void startBatch()

Flag that a number of user/group transactions are about to be performed in a block, and any syncing should pause until the batch is finished.

endBatch

void endBatch()

Flag that the batch transactions are complete, that a sync should be performed immediately, and that syncing should be re-enabled for future requests.

renameUser

void renameUser(String oldUsername,
                String newUsername)

deactivateUser

void deactivateUser(String username)

activateUser

void activateUser(String username)

searchUsers

List<UserWithDetails> searchUsers(com.atlassian.crowd.embedded.api.SearchRestriction searchRestriction,
                                  int startIndex,
                                  int maxResults)

Searches for users matching the following criteria.

Parameters:

searchRestriction - restriction on the search

startIndex - starting index of the search results

maxResults - maximum number of results returned from the search

Returns:

List of users satisfying the search restriction.

searchUserNames

List<String> searchUserNames(com.atlassian.crowd.embedded.api.SearchRestriction searchRestriction,
                             int startIndex,
                             int maxResults)

Searches for usernames matching the searchRestriction criteria.

Parameters:

searchRestriction - restriction on the search

startIndex - starting index of the search results

maxResults - maximum number of results returned from the search

Returns:

List of usernames satisfying the search restriction.

searchGroups

List<Group> searchGroups(com.atlassian.crowd.embedded.api.SearchRestriction searchRestriction,
                         int startIndex,
                         int maxResults)

Searches for groups matching the following criteria.

Parameters:

searchRestriction - restriction on the search

startIndex - starting index of the search results

maxResults - maximum number of results returned from the search

Returns:

List of groups satisfying the search restriction.

searchGroupNames

List<String> searchGroupNames(com.atlassian.crowd.embedded.api.SearchRestriction searchRestriction,
                              int startIndex,
                              int maxResults)

Searches for group names matching the searchRestriction criteria.

Parameters:

searchRestriction - restriction on the search

startIndex - starting index of the search results

maxResults - maximum number of results returned from the search

Returns:

List of group names satisfying the search restriction.