com.atlassian.confluence.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 token, java.lang.String userName, java.lang.String groupName)
void	cleanUpOldUsersAndGroups(java.lang.String token) Clean up any users and groups created by this user management helper or otherwise.
void	createGroup(java.lang.String token, java.lang.String groupName)
void	createUser(java.lang.String token, java.lang.String username, java.lang.String fullName, java.lang.String email, java.lang.String password)
void	createUser(java.lang.String token, User user)
void	removeGroup(java.lang.String token, java.lang.String groupName)
void	removeUser(java.lang.String token, java.lang.String username)
void	removeUserFromGroup(java.lang.String token, java.lang.String userName, java.lang.String groupName)
void	removeUserUncleanly(java.lang.String token, 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 token,
                    java.lang.String userName,
                    java.lang.String groupName)

createUser

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

createUser

void createUser(java.lang.String token,
                User user)

cleanUpOldUsersAndGroups

void cleanUpOldUsersAndGroups(java.lang.String token)

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

Parameters:

token - Must be the admin token

removeUser

void removeUser(java.lang.String token,
                java.lang.String username)

createGroup

void createGroup(java.lang.String token,
                 java.lang.String groupName)

removeUserFromGroup

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

removeGroup

void removeGroup(java.lang.String token,
                 java.lang.String groupName)

removeUserUncleanly

void removeUserUncleanly(java.lang.String token,
                         java.lang.String username)

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

Parameters:

token - the authentication token

username - the username of the user to remove

Throws:

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