com.atlassian.confluence.it.usermanagement
Class LdapUserManagementHelper

java.lang.Object
  com.atlassian.confluence.it.usermanagement.LdapUserManagementHelper

All Implemented Interfaces:

UserManagementHelper

public class LdapUserManagementHelper
extends java.lang.Object
implements UserManagementHelper

Manages Users and Groups in LDAP. User.ADMIN, Group.USERS and Group.ADMINISTRATORS are expected to be in the local user repository and are explicitly handled where appropriate. Other users and groups will be added to and removed from the LDAP repository.

Field Summary

protected org.apache.log4j.Logger

log

Constructor Summary

LdapUserManagementHelper(ConfluenceRpc xmlrpc)

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) This method is not currently supported for users stored in the LDAP repository.
void	removegroup(java.lang.String groupName)
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.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final transient org.apache.log4j.Logger log

Constructor Detail

LdapUserManagementHelper

public LdapUserManagementHelper(ConfluenceRpc xmlrpc)

Method Detail

addUserToGroup

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

Specified by:

addUserToGroup in interface UserManagementHelper

createUser

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

Specified by:

createUser in interface UserManagementHelper

createUser

public void createUser(User user)

Specified by:

createUser in interface UserManagementHelper

cleanUpOldUsersAndGroups

public void cleanUpOldUsersAndGroups()

Description copied from interface: UserManagementHelper

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

Specified by:

cleanUpOldUsersAndGroups in interface UserManagementHelper

removeUser

public void removeUser(java.lang.String username)

Specified by:

removeUser in interface UserManagementHelper

editUser

public void editUser(User user)

Description copied from interface: UserManagementHelper

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

Specified by:

editUser in interface UserManagementHelper

Parameters:

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

removegroup

public void removegroup(java.lang.String groupName)

createGroup

public void createGroup(java.lang.String groupName)

Specified by:

createGroup in interface UserManagementHelper

removeUserFromGroup

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

Specified by:

removeUserFromGroup in interface UserManagementHelper

removeGroup

public void removeGroup(java.lang.String groupName)

Specified by:

removeGroup in interface UserManagementHelper

removeUserUncleanly

public void removeUserUncleanly(java.lang.String username)

Description copied from interface: UserManagementHelper

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

Specified by:

removeUserUncleanly in interface UserManagementHelper

Parameters:

username - the username of the user to remove

fixUser

public void fixUser(User user)

This method is not currently supported for users stored in the LDAP repository. However, it explicitly recognises that User.ADMIN is not stored in ldap and uses rpc to fix it.

Specified by:

fixUser in interface UserManagementHelper

Parameters:

user - a user to set the details of

Throws:

java.lang.UnsupportedOperationException - when called on this implementation with users other than User.ADMIN.