com.atlassian.user.impl
Class ReadOnlyUserManager

java.lang.Object
  extended bycom.atlassian.user.impl.ReadOnlyUserManager
All Implemented Interfaces:
EntityManager, UserManager
Direct Known Subclasses:
LDAPUserManagerReadOnly, MemoryUserManagerReadOnly

public abstract class ReadOnlyUserManager
extends java.lang.Object
implements UserManager


Constructor Summary
ReadOnlyUserManager()
           
 
Method Summary
 void alterPassword(User user, java.lang.String plainTextPass)
          Encrypts the plain password, sets it on the user, and saves the user.
 User createUser(java.lang.String username)
          Creates a new user with the username provided.
 boolean isCreative()
          Used to detemine whether an entity can be created (eg, can call UserManager.createUser(String) or GroupManager#createGroup(String).
 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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.atlassian.user.UserManager
getUser, getUserNames, getUsers
 
Methods inherited from interface com.atlassian.user.EntityManager
getIdentifier, getRepository
 

Constructor Detail

ReadOnlyUserManager

public ReadOnlyUserManager()
Method Detail

createUser

public User createUser(java.lang.String username)
                throws EntityException
Description copied from interface: UserManager
Creates a new user with the username provided. Returns the newly created user.

Specified by:
createUser in interface UserManager
Returns:
a User object representing the new user.
Throws:
EntityException

alterPassword

public void alterPassword(User user,
                          java.lang.String plainTextPass)
                   throws EntityException
Description copied from interface: UserManager
Encrypts the plain password, sets it on the user, and saves the user. Implementations supporting this will usually have an internal PasswordEncryptor.

Specified by:
alterPassword in interface UserManager
Throws:
EntityException

saveUser

public void saveUser(User user)
              throws EntityException
Description copied from interface: UserManager
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).

Specified by:
saveUser in interface UserManager
Throws:
EntityException

removeUser

public void removeUser(User user)
                throws EntityException
Description copied from interface: UserManager
Removes the specified user from the repository.

Specified by:
removeUser in interface UserManager
Throws:
EntityException

isReadOnly

public boolean isReadOnly(User user)
                   throws EntityException
Specified by:
isReadOnly in interface UserManager
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

isCreative

public boolean isCreative()
Description copied from interface: EntityManager
Used to detemine whether an entity can be created (eg, can call UserManager.createUser(String) or GroupManager.createGroup(String).

Specified by:
isCreative in interface EntityManager
Returns:
true to indicate that Entity objects can be created by this manager, or false to indicate not.


Copyright © 2005-2008 Atlassian Software Systems Pty Ltd. All Rights Reserved.