com.atlassian.user.impl.osuser
Class OSUUserManager
java.lang.Object
com.atlassian.user.impl.osuser.OSUEntityManager
com.atlassian.user.impl.osuser.OSUUserManager
- All Implemented Interfaces:
- EntityManager, UserManager
- public class OSUUserManager
- extends OSUEntityManager
- implements UserManager
An adaptor class for CredentialsProvider
and some of the higher level operations of UserManager
The rule is to use the credentialsProvider and/or profileProvider (for propertySets) for most things. Store() operations
must be called on the entity itself.
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
OSUUserManager
public OSUUserManager(RepositoryIdentifier repository,
OSUAccessor accessor)
getUsers
public Pager getUsers()
- Specified by:
getUsers
in interface UserManager
- Returns:
- a
Pager
holding all users being managed.
getUserNames
public Pager 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(java.lang.String username)
- Specified by:
getUser
in interface UserManager
- Returns:
- a
null
or a User
if one could be found.
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
- Encrypts the plain password, sets it on the user, and saves the user.
- Specified by:
alterPassword
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)
- 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
.
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
getRepository
public RepositoryIdentifier getRepository(Entity entity)
throws EntityException
- Specified by:
getRepository
in interface EntityManager
- Returns:
- the
RepositoryIdentifier
of the repository in which the entity is stored, or null
if the entity cannot be found.
- Throws:
EntityException
- if the entity cannot be found, or trying to retrieve it results in an error
getAccessor
public OSUAccessor getAccessor()
Copyright © 2005-2008 Atlassian Software Systems Pty Ltd. All Rights Reserved.