com.atlassian.confluence.test.usermanagement

Class CrowdUserManager

java.lang.Object

com.atlassian.confluence.test.usermanagement.CrowdUserManager

All Implemented Interfaces:

UserManager

@PublicApi
public class CrowdUserManager
extends Object
implements UserManager

Implementation of UserManager that talks to a Crowd server.

Since:

v4.2

Constructor Summary

Constructors

Constructor and Description
CrowdUserManager(com.atlassian.crowd.service.client.CrowdClient crowdClient, ConfluenceRpcClient rpcClient, ConfluenceRestClient restClient)

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 UserManager.removeUser(String))
void	removeUser(String username)
void	removeUserFromGroup(String user, String group)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CrowdUserManager

public CrowdUserManager(com.atlassian.crowd.service.client.CrowdClient crowdClient,
                        ConfluenceRpcClient rpcClient,
                        ConfluenceRestClient restClient)

Method Detail

createUser

public UserWithDetails createUser(UserWithDetails user)

Description copied from interface: UserManager

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

Specified by:

createUser in interface UserManager

addUserToGroup

public void addUserToGroup(String userName,
                           String groupName)

Specified by:

addUserToGroup in interface UserManager

addGroupToGroup

public void addGroupToGroup(Group childGroup,
                            Group parentGroup)

Description copied from interface: UserManager

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

Specified by:

addGroupToGroup in interface UserManager

getUserGroups

public Set<String> getUserGroups(User user)

Specified by:

getUserGroups in interface UserManager

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.

resetData

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

Description copied from interface: UserManager

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

Specified by:

resetData in interface UserManager

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

public boolean isExternal()

Description copied from interface: UserManager

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.

Specified by:

isExternal in interface UserManager

removeUser

public void removeUser(String username)

Specified by:

removeUser in interface UserManager

createGroup

public void createGroup(String groupName)

Specified by:

createGroup in interface UserManager

removeUserFromGroup

public void removeUserFromGroup(String user,
                                String group)

Specified by:

removeUserFromGroup in interface UserManager

removeGroup

public void removeGroup(String groupName)

Specified by:

removeGroup in interface UserManager

removeMultipleUsers

public void removeMultipleUsers(List<String> users)

Description copied from interface: UserManager

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

Specified by:

removeMultipleUsers in interface UserManager

Parameters:

users - the list of users to remove

removeUserUncleanly

public void removeUserUncleanly(String username)

Description copied from interface: UserManager

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

Specified by:

removeUserUncleanly in interface UserManager

Parameters:

username - the username of the user to remove

removeGroupUncleanly

public void removeGroupUncleanly(String group)

Description copied from interface: UserManager

Removes a group but do not remove their dependent permissions.

Specified by:

removeGroupUncleanly in interface UserManager

Parameters:

group - the group to remove

fixUser

public void fixUser(UserWithDetails user)

Description copied from interface: UserManager

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.

Specified by:

fixUser in interface UserManager

Parameters:

user - a user to set the details of

changePassword

public void changePassword(String username,
                           String newPassword)

Description copied from interface: UserManager

Change a user's password.

Specified by:

changePassword in interface UserManager

Parameters:

username - Username of the user whose password to change

newPassword - Password

setAutoSync

public void setAutoSync(boolean autoSync)

Specified by:

setAutoSync in interface UserManager

synchronise

public void synchronise()

Description copied from interface: UserManager

Force a synchronisation with an external user directory.

Specified by:

synchronise in interface UserManager

startBatch

public void startBatch()

Description copied from interface: UserManager

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.

Specified by:

startBatch in interface UserManager

endBatch

public void endBatch()

Description copied from interface: UserManager

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

Specified by:

endBatch in interface UserManager

renameUser

public void renameUser(String oldUsername,
                       String newUsername)

Specified by:

renameUser in interface UserManager

deactivateUser

public void deactivateUser(String username)

Specified by:

deactivateUser in interface UserManager

activateUser

public void activateUser(String username)

Specified by:

activateUser in interface UserManager

searchUsers

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

Description copied from interface: UserManager

Searches for users matching the following criteria.

Specified by:

searchUsers in interface UserManager

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

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

Description copied from interface: UserManager

Searches for usernames matching the searchRestriction criteria.

Specified by:

searchUserNames in interface UserManager

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

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

Description copied from interface: UserManager

Searches for groups matching the following criteria.

Specified by:

searchGroups in interface UserManager

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

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

Description copied from interface: UserManager

Searches for group names matching the searchRestriction criteria.

Specified by:

searchGroupNames in interface UserManager

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.