com.atlassian.confluence.it.usermanagement
Interface UserManagementHelper

All Known Implementing Classes:

DefaultUserManagementHelper, LdapUserManagementHelper

public interface UserManagementHelper

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

Method Summary

void	addUserToGroup(java.lang.String userName, java.lang.String groupName)
void	cleanUpOldUsersAndGroups() Clean up any users and groups created by this user management helper or otherwise.
void	createGroup(java.lang.String groupName)
void	createUser(java.lang.String username, java.lang.String fullName, java.lang.String email, java.lang.String password)
void	createUser(User user)
void	editUser(User user) Update the full name or e-mail address of the user.
void	fixUser(User user) Ensure that the user's details in the system match those in user.
void	removeGroup(java.lang.String groupName)
void	removeUser(java.lang.String username)
void	removeUserFromGroup(java.lang.String userName, java.lang.String groupName)
void	removeUserUncleanly(java.lang.String username) Removes a user with the given username but do not remove their dependent permissions or pages.

Method Detail

addUserToGroup

void addUserToGroup(java.lang.String userName,
                    java.lang.String groupName)

createUser

void createUser(java.lang.String username,
                java.lang.String fullName,
                java.lang.String email,
                java.lang.String password)

createUser

void createUser(User user)

cleanUpOldUsersAndGroups

void cleanUpOldUsersAndGroups()

Clean up any users and groups created by this user management helper or otherwise.

removeUser

void removeUser(java.lang.String username)

editUser

void editUser(User user)

Update the full name or e-mail address of the user.

Parameters:

user - the user containing new full name or e-mail address details.

createGroup

void createGroup(java.lang.String groupName)

removeUserFromGroup

void removeUserFromGroup(java.lang.String userName,
                         java.lang.String groupName)

removeGroup

void removeGroup(java.lang.String groupName)

removeUserUncleanly

void removeUserUncleanly(java.lang.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

Throws:

org.apache.xmlrpc.XmlRpcException - if there were problems removing the user

fixUser

void fixUser(User 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