com.atlassian.user.impl.cache
Class CachingUserManager

java.lang.Object
  com.atlassian.user.impl.cache.CachingUserManager

All Implemented Interfaces:

EntityManager, UserManager

public class CachingUserManager
extends Object
implements UserManager

Field Summary

protected static User

NULL_USER

Constructor Summary

CachingUserManager(UserManager underlyingUserManager, com.atlassian.cache.CacheFactory cacheFactory)

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.
RepositoryIdentifier	getIdentifier()
RepositoryIdentifier	getRepository(Entity entity)
User	getUser(String username) Caches users retrieved. Will also cache the fact that a user could not be found (so that we don't incur the expense of another search when have previously determined that a user doesn't exist) Hence this method will also cache null results.
Pager<String>	getUserNames()
Pager<User>	getUsers()
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 group, if it is present.
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

Field Detail

NULL_USER

protected static User NULL_USER

Constructor Detail

CachingUserManager

public CachingUserManager(UserManager underlyingUserManager,
                          com.atlassian.cache.CacheFactory cacheFactory)

Method Detail

getUsers

public Pager<User> getUsers()
                     throws EntityException

Specified by:

getUsers in interface UserManager

Returns:

a Pager holding all users being managed.

Throws:

EntityException

getUserNames

public Pager<String> getUserNames()
                           throws EntityException

Specified by:

getUserNames in interface UserManager

Returns:

a Pager holding the names of all users being managed.

Throws:

EntityException

getUser

public User getUser(String username)
             throws EntityException

Caches users retrieved.
Will also cache the fact that a user could not be found (so that we don't incur the expense of another search when have previously determined that a user doesn't exist) Hence this method will also cache null results.

Specified by:

getUser in interface UserManager

Returns:

- an User if one could be found, otherwise null.

Throws:

EntityException - - representing the exception which prohibited looking for or retrieving the user.

createUser

public User createUser(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:

DuplicateEntityException - if a user with the username already exists.

EntityException

alterPassword

public void alterPassword(User user,
                          String plainTextPass)
                   throws EntityException

Encrypts the plain password, sets it on the user, and saves the user.

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

Removes the specified group, if it is present.

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

getIdentifier

public RepositoryIdentifier getIdentifier()

Specified by:

getIdentifier in interface EntityManager

Returns:

the RepositoryIdentifier for the repository which is managed by this instance.

getRepository

public RepositoryIdentifier getRepository(Entity entity)
                                   throws EntityException

Specified by:

getRepository in interface EntityManager

Returns:

the RepositoryIdentifier in which the entity is stored, otherwise null.

Throws:

EntityException - if the entity cannot be found, or trying to retrieve it results in an error

isCreative

public boolean isCreative()

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.