com.atlassian.user
Interface UserManager

All Superinterfaces:

EntityManager

All Known Implementing Classes:

CachingUserManager, DelegatingListUserManager, DelegatingUserManager, HibernateUserManager, LDAPUserManagerReadOnly, MemoryUserManager, MemoryUserManagerReadOnly, OSUUserManager, ReadOnlyUserManager

public interface UserManager
extends EntityManager

Method Summary

void	alterPassword(User user, String plainTextPass) Encrypts the plain password, sets it on the user, and saves the user.
User	createUser(String username) Creates a new user with the username provided.
User	getUser(String username)
Pager<String>	getUserNames()
Pager<User>	getUsers()
boolean	isReadOnly(User user)
void	removeUser(User user) Removes the specified user from the repository.
void	saveUser(User user) Persists any changes made to the user to the storage system used by this user manager.

Methods inherited from interface com.atlassian.user.EntityManager

getIdentifier, getRepository, isCreative

Method Detail

getUsers

Pager<User> getUsers()
                     throws EntityException

Returns:

a Pager holding all users being managed.

Throws:

EntityException

getUserNames

Pager<String> getUserNames()
                           throws EntityException

Returns:

a Pager holding the names of all users being managed.

Throws:

EntityException

getUser

User getUser(String username)
             throws EntityException

Returns:

a null or a User if one could be found.

Throws:

EntityException

createUser

User createUser(String username)
                throws EntityException

Creates a new user with the username provided. Returns the newly created user.

Returns:

a User object representing the new user.

Throws:

DuplicateEntityException - if a user with the username already exists.

UnsupportedOperationException - - if EntityManager.isCreative() returns false.

EntityException

alterPassword

void alterPassword(User user,
                   String plainTextPass)
                   throws EntityException

Encrypts the plain password, sets it on the user, and saves the user. Implementations supporting this will usually have an internal PasswordEncryptor.

Throws:

UnsupportedOperationException - - if EntityManager.isCreative() returns false.

EntityException

saveUser

void saveUser(User user)
              throws EntityException,
                     IllegalArgumentException

Persists any changes made to the user to the storage system used by this user manager.

To ensure consistent behaviour across all repository types, clients must call this method after using User.setEmail(String), User.setFullName(String) or User.setPassword(String).

Throws:

UnsupportedOperationException - - if EntityManager.isCreative() returns false

IllegalArgumentException - if the user is null or not managed by this repository

EntityException

removeUser

void removeUser(User user)
                throws EntityException,
                       IllegalArgumentException

Removes the specified user from the repository.

Throws:

UnsupportedOperationException - if isReadOnly(User) returns true.

IllegalArgumentException - if the user is null or not managed by this repository

EntityException

isReadOnly

boolean isReadOnly(User user)
                   throws EntityException

Returns:

true indicates that information on the user object cannot be altered in the storage system (see RepositoryIdentifier), false indicates that the storage system will save changes or that this UserManager does not know about the User.

Throws:

EntityException