public class UserDAOHibernate extends HibernateDao implements InternalUserDao, UserDao
Modifier and Type | Field and Description |
---|---|
static String |
DIRECTORY_ID |
static String |
EXTERNAL_ID |
batchFinder, batchProcessor, logger, sessionFactory
Constructor and Description |
---|
UserDAOHibernate() |
Modifier and Type | Method and Description |
---|---|
InternalUser |
add(User user,
PasswordCredential credential)
Creates a new user with the given details and credentials.
|
BatchResultWithIdReferences<User> |
addAll(Collection<UserTemplateWithCredentialAndAttributes> users) |
BatchResult<User> |
addAll(Set<UserTemplateWithCredentialAndAttributes> users)
Bulk add users.
|
InternalUser |
findByExternalId(long directoryId,
String externalId)
Finds and returns the user with the given unique/external id and directory ID.
|
InternalUser |
findByName(long directoryId,
String username)
Finds and returns the user with the given name and directory ID.
|
Collection<InternalUser> |
findByNames(long directoryID,
Collection<String> usernames)
Bulk find of users using SQL disjunction.
|
InternalUserWithAttributes |
findByNameWithAttributes(long directoryId,
String username)
Finds and returns the user with attributes with the given name and directory ID.
|
Set<InternalUserAttribute> |
findUserAttributes(long userID) |
Set<String> |
getAllExternalIds(long directoryId)
Return all users externalId in the given directory.
|
PasswordCredential |
getCredential(long directoryId,
String username)
Returns the credential for the given user.
|
List<PasswordCredential> |
getCredentialHistory(long directoryId,
String username)
Returns the previous credentials for the given user, starting with the oldest.
|
Class |
getPersistentClass()
All subclasses of HibernateDao must implement this method for
HibernateDao.load(long) to work correctly. |
long |
getUserCount(long directoryId)
Return number of users in given directory.
|
void |
remove(User user)
Removes the user.
|
void |
removeAll(long directoryId) |
BatchResult<String> |
removeAllUsers(long directoryId,
Set<String> userNames)
Bulk remove all the given users from directory.
|
void |
removeAttribute(User user,
String attributeName)
Removes the attributes for the user with the given name.
|
InternalUser |
rename(User user,
String newUsername)
Changes the user's name to the provided new name.
|
<T> List<T> |
search(long directoryID,
EntityQuery<T> query)
Returns users matching the search query in the given directory, ordered by name.
|
void |
setAttributeForAllInDirectory(long directoryId,
String attrName,
String value)
Ensures that all users in the directory with the given ID have the attribute with the given name set
(only) to the single given attribute value.
|
void |
setAttributesHelper(InternalAttributesHelper attributesHelper) |
void |
setHqlQueryTranslater(HQLQueryTranslater hqlQueryTranslater) |
void |
setMembershipDao(InternalMembershipDao internalMembershipDao) |
void |
storeAttributes(User user,
Map<String,Set<String>> attributes)
Adds or updates a user's attributes with the new Map of attribute values.
|
InternalUser |
update(User user)
Updates all the user properties (except the username) of the user with the same directory and
case-insensitive name.
|
void |
updateCredential(User user,
PasswordCredential credential,
int maxPasswordHistory)
Updates the credential (password) of the user with the same directory and case-insensitive name.
|
createHibernateQuery, load, load, loadReference, loadReference, remove, save, saveOrUpdate, session, setBatchFinder, setBatchProcessor, setSessionFactory, update
public static final String EXTERNAL_ID
public static final String DIRECTORY_ID
public InternalUser add(User user, PasswordCredential credential) throws DirectoryNotFoundException, UserAlreadyExistsException
UserDao
add
in interface UserDao
user
- the user to createcredential
- the encrypted password for the user, which may be null if the user's password is not yet availableUserAlreadyExistsException
- if a user with the same directory and name (case-insensitive) already existsDirectoryNotFoundException
public BatchResult<User> addAll(Set<UserTemplateWithCredentialAndAttributes> users)
UserDao
public BatchResultWithIdReferences<User> addAll(Collection<UserTemplateWithCredentialAndAttributes> users)
addAll
in interface InternalUserDao
public InternalUser findByName(long directoryId, String username) throws UserNotFoundException
UserDao
findByName
in interface UserDao
UserNotFoundException
- if the user could not be foundpublic InternalUser findByExternalId(long directoryId, String externalId) throws UserNotFoundException
UserDao
findByExternalId
in interface UserDao
UserNotFoundException
- if the user could not be foundpublic InternalUserWithAttributes findByNameWithAttributes(long directoryId, String username) throws UserNotFoundException
UserDao
findByNameWithAttributes
in interface UserDao
UserNotFoundException
- if the user could not be foundpublic Collection<InternalUser> findByNames(long directoryID, Collection<String> usernames)
InternalUserDao
findByNames
in interface InternalUserDao
directoryID
- the directory to search for the users.usernames
- names of users to findpublic Set<InternalUserAttribute> findUserAttributes(long userID)
public PasswordCredential getCredential(long directoryId, String username) throws UserNotFoundException
UserDao
getCredential
in interface UserDao
UserNotFoundException
- if the user could not be foundpublic List<PasswordCredential> getCredentialHistory(long directoryId, String username) throws UserNotFoundException
UserDao
getCredentialHistory
in interface UserDao
UserNotFoundException
- if the user could not be foundpublic Class getPersistentClass()
HibernateDao
HibernateDao.load(long)
to work correctly.getPersistentClass
in class HibernateDao
public void remove(User user) throws UserNotFoundException
UserDao
remove
in interface UserDao
user
- the user to removeUserNotFoundException
- if the user does not existpublic void removeAll(long directoryId)
removeAll
in interface InternalUserDao
public BatchResult<String> removeAllUsers(long directoryId, Set<String> userNames)
UserDao
removeAllUsers
in interface UserDao
directoryId
- the ID of the directory to remove users fromuserNames
- set of users to be removed@Nonnull public Set<String> getAllExternalIds(long directoryId) throws DirectoryNotFoundException
UserDao
null
or an empty String it should not be included.getAllExternalIds
in interface UserDao
directoryId
- the ID of the directoryDirectoryNotFoundException
- when directory with given id does not existpublic long getUserCount(long directoryId) throws DirectoryNotFoundException
UserDao
getUserCount
in interface UserDao
directoryId
- the ID of the directoryDirectoryNotFoundException
- when directory with given id does not existpublic void removeAttribute(User user, String attributeName) throws UserNotFoundException
UserDao
removeAttribute
in interface UserDao
user
- the user whose attribute will be removedattributeName
- the name of the attribute to be removedUserNotFoundException
- if the user cannot be foundpublic InternalUser rename(User user, String newUsername) throws UserNotFoundException, UserAlreadyExistsException
UserDao
This method will be called for any change to a username including a case-only change (eg from "alice" to "Alice"). If there are changes to the username as well as to other user properties (eg email, display name) then callers must call the rename() method first followed by the update() method.
Implementations of this method will normally need to update the cwd_user table as well as cwd_membership, whereas the update() method implies a change to only the cwd_user table.
rename
in interface UserDao
user
- the user to renamenewUsername
- the new name of the userUserNotFoundException
- if the user cannot be foundUserAlreadyExistsException
- if the new name is already used by a different userUserDao.update(User)
public <T> List<T> search(long directoryID, EntityQuery<T> query)
UserDao
@Autowired public void setAttributesHelper(InternalAttributesHelper attributesHelper)
@Autowired public void setHqlQueryTranslater(HQLQueryTranslater hqlQueryTranslater)
@Autowired public void setMembershipDao(InternalMembershipDao internalMembershipDao)
public void storeAttributes(User user, Map<String,Set<String>> attributes) throws UserNotFoundException
UserDao
storeAttributes
in interface UserDao
user
- the user to store attributes forattributes
- new or updated attributes (attributes that don't need changing should not appear in this Map).UserNotFoundException
- user with supplied username does not exist.public InternalUser update(User user) throws UserNotFoundException
UserDao
If the username changes, then the UserDao.rename(User, String)
method must be called first, and this method
may be called afterwards if other details (eg email or display name) have also changed.
Even if the username is changed in case only (eg from "mary" to "Mary") then the rename() method will be called first. This implies that the implementation of this method should only need to change the cwd_user table.
update
in interface UserDao
user
- the user details, which should have the same name as the user to modifyUserNotFoundException
- if there is no user with the same name (case-insensitive) and directory as the
user providedUserDao.rename(User, String)
public void updateCredential(User user, PasswordCredential credential, int maxPasswordHistory) throws UserNotFoundException
UserDao
updateCredential
in interface UserDao
user
- the user whose password will be modifiedcredential
- the new credential for the usermaxPasswordHistory
- the number of old passwords for the user in which the new password must not matchUserNotFoundException
- if there is no user with the same name (case-insensitive) and directory as the user providedpublic void setAttributeForAllInDirectory(long directoryId, String attrName, String value)
UserDao
setAttributeForAllInDirectory
in interface UserDao
directoryId
- The directory to set the attributes in.attrName
- The attribute name to set.value
- The attribute value to set.Copyright © 2016 Atlassian. All rights reserved.