UserServiceImpl (OpenMRS 2.7.0-SNAPSHOT API)

java.lang.Object
- org.openmrs.api.impl.BaseOpenmrsService
- - org.openmrs.api.impl.UserServiceImpl

All Implemented Interfaces:

OpenmrsService, UserService
```
@Transactional
public class UserServiceImpl
extends BaseOpenmrsService
implements UserService
```
Default implementation of the user service. This class should not be used on its own. The current OpenMRS implementation should be fetched from the Context

See Also:

UserService, Context

Field Summary

Fields
Modifier and Type Field and Description

protected UserDAO dao
- Fields inherited from interface org.openmrs.api.UserService
  ADMIN_PASSWORD_LOCKED_PROPERTY

Fields
Modifier and Type	Field and Description
`protected UserDAO`	`dao`

Constructor Summary

Constructors
Constructor and Description

UserServiceImpl()

Constructors
Constructor and Description
`UserServiceImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changeHashedPassword(User user, String hashedPassword, String salt)` Changes the current user's password directly.
`void`	`changePassword(String oldPassword, String newPassword)` Changes the current user's password.
`void`	`changePassword(User user, String newPassword)` Changes password of `User` passed in
`void`	`changePassword(User user, String oldPassword, String newPassword)` Change user password.
`void`	`changePasswordUsingActivationKey(String activationKey, String newPassword)` Change user password given the activation key
`void`	`changePasswordUsingSecretAnswer(String secretAnswer, String pw)` Change user password given the answer to the secret question
`void`	`changeQuestionAnswer(String pw, String q, String a)` Changes the current user's secret question and answer.
`void`	`changeQuestionAnswer(User u, String question, String answer)` Changes the passed user's secret question and answer.
`User`	`createUser(User user, String password)` Create user with given password.
`String`	`generateSystemId()` Generates system ids based on the following algorithm scheme: user_id-check digit
`List<Privilege>`	`getAllPrivileges()` Returns all privileges currently possible for any User
`List<Role>`	`getAllRoles()` Returns all roles currently possible for any User
`List<User>`	`getAllUsers()` Returns all users in the system
`Integer`	`getCountOfUsers(String name, List<Role> roles, boolean includeRetired)` Return the number of users with a matching name or system id and have at least one of the given roles assigned to them
`Locale`	`getDefaultLocaleForUser(User user)`
`String`	`getLastLoginTime(User user)` Retrieves the last login time of the user in Unix Timestamp
`Privilege`	`getPrivilege(String p)` Returns Privilege in the system with given String privilege
`Privilege`	`getPrivilegeByUuid(String uuid)` Get Privilege by its UUID
`Role`	`getRole(String r)` Returns role object with given string role
`Role`	`getRoleByUuid(String uuid)` Get Role by its UUID
`String`	`getSecretQuestion(User user)` Returns secret question for the given user.
`User`	`getUser(Integer userId)` Get user by internal user identifier.
`User`	`getUserByActivationKey(String activationKey)` Gets a user with the specified activation key
`User`	`getUserByUsername(String username)` Get user by username (user's login identifier)
`User`	`getUserByUsernameOrEmail(String usernameOrEmail)` Gets a user by username or email
`User`	`getUserByUuid(String uuid)` Get user by the given uuid.
`List<User>`	`getUsers(String nameSearch, List<Role> roles, boolean includeVoided)` Return a list of users sorted by personName (see `PersonByNameComparator`) if any part of the search matches first/last/system id and the user has one at least one of the given `roles` assigned to them
`List<User>`	`getUsers(String name, List<Role> roles, boolean includeRetired, Integer start, Integer length)` Return a batch of users of a specific size sorted by personName (see `PersonByNameComparator`) if any part of the search matches first/last/system id and the user has one at least one of the given `roles` assigned to them.
`List<User>`	`getUsersByName(String givenName, String familyName, boolean includeVoided)` Search for a list of users by exact first name and last name.
`List<User>`	`getUsersByPerson(Person person, boolean includeRetired)` Get all user accounts that belong to a given person.
`List<User>`	`getUsersByRole(Role role)` Get users by role granted
`boolean`	`hasDuplicateUsername(User user)` true/false if username or systemId is already in db in username or system_id columns
`boolean`	`isSecretAnswer(User u, String answer)` Compares `answer` against the `user`'s secret answer.
`void`	`purgePrivilege(Privilege privilege)` Completely remove a privilege from the database
`void`	`purgeRole(Role role)` Complete remove a role from the database
`void`	`purgeUser(User user)` Completely remove a location from the database (not reversible).
`void`	`purgeUser(User user, boolean cascade)` Completely remove a user from the database (not reversible).
`User`	`removeUserProperty(User user, String key)` Removes the property denoted by `key` from the `user`'s properties.
`User`	`retireUser(User user, String reason)` Deactivate a user account so that it can no longer log in.
`Privilege`	`savePrivilege(Privilege privilege)` Save the given privilege in the database
`Role`	`saveRole(Role role)` Save the given role in the database
`User`	`saveUser(User user)` Updates a given `user` in the database.
`User`	`saveUserProperties(Map<String,String> properties)` Replaces all user properties with the given map of properties for the current user
`User`	`saveUserProperty(String key, String value)` Saves the current key/value as a user property for the current user.
`User`	`setUserActivationKey(User user)` Sets a user's activation key
`void`	`setUserDAO(UserDAO dao)`
`User`	`setUserProperty(User user, String key, String value)` Adds the `key`/`value` pair to the given `user`.
`User`	`unretireUser(User user)` Clears retired flag for a user.
`User`	`unvoidUser(User user)`
`User`	`voidUser(User user, String reason)`

Methods inherited from class org.openmrs.api.impl.BaseOpenmrsService
onShutdown, onStartup

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openmrs.api.OpenmrsService
onShutdown, onStartup

- Field Detail
  - dao
```
protected UserDAO dao
```
- Constructor Detail
  - UserServiceImpl
```
public UserServiceImpl()
```
- Method Detail
  - setUserDAO
```
public void setUserDAO(UserDAO dao)
```
  - createUser
```
public User createUser(User user,
                       String password)
                throws APIException
```
    Description copied from interface: UserService
    
    Create user with given password.
    
    Specified by:
    
    createUser in interface UserService
    
    Parameters:
    
    user - the user to create
    
    password - the password for created user
    
    Returns:
    
    created user
    
    Throws:
    
    APIException
    
    See Also:
    
    UserService.createUser(org.openmrs.User, java.lang.String)
  - getUser
```
@Transactional(readOnly=true)
public User getUser(Integer userId)
                                           throws APIException
```
    Description copied from interface: UserService
    
    Get user by internal user identifier.
    
    Specified by:
    
    getUser in interface UserService
    
    Parameters:
    
    userId - internal identifier
    
    Returns:
    
    requested user
    
    Throws:
    
    APIException - Should fetch user with given userId
    
    See Also:
    
    UserService.getUser(java.lang.Integer)
  - getUserByUsername
```
@Transactional(readOnly=true)
public User getUserByUsername(String username)
                                                     throws APIException
```
    Description copied from interface: UserService
    
    Get user by username (user's login identifier)
    
    Specified by:
    
    getUserByUsername in interface UserService
    
    Parameters:
    
    username - User's identifier used for authentication
    
    Returns:
    
    requested user Should get user by username
    
    Throws:
    
    APIException
    
    See Also:
    
    UserService.getUserByUsername(java.lang.String)
  - hasDuplicateUsername
```
@Transactional(readOnly=true)
public boolean hasDuplicateUsername(User user)
                                                           throws APIException
```
    Description copied from interface: UserService
    
    true/false if username or systemId is already in db in username or system_id columns
    
    Specified by:
    
    hasDuplicateUsername in interface UserService
    
    Parameters:
    
    user - User to compare
    
    Returns:
    
    boolean
    
    Throws:
    
    APIException - Should verify that username and system id is unique
    
    See Also:
    
    UserService.hasDuplicateUsername(org.openmrs.User)
  - getUsersByRole
```
@Transactional(readOnly=true)
public List<User> getUsersByRole(Role role)
                                                        throws APIException
```
    Description copied from interface: UserService
    
    Get users by role granted
    
    Specified by:
    
    getUsersByRole in interface UserService
    
    Parameters:
    
    role - Role that the Users must have to be returned
    
    Returns:
    
    users with requested role
    
    Throws:
    
    APIException - Should fetch users assigned given role Should not fetch user that does not belong to given role
    
    See Also:
    
    UserService.getUsersByRole(org.openmrs.Role)
  - saveUser
```
@CacheEvict(value="userSearchLocales",
            allEntries=true)
public User saveUser(User user)
                                                                                  throws APIException
```
    Description copied from interface: UserService
    
    Updates a given user in the database.
    
    Specified by:
    
    saveUser in interface UserService
    
    Returns:
    
    the saved user
    
    Throws:
    
    APIException
    
    See Also:
    
    UserService.saveUser(org.openmrs.User)
  - voidUser
```
public User voidUser(User user,
                     String reason)
              throws APIException
```
    Throws:
    
    APIException
  - retireUser
```
public User retireUser(User user,
                       String reason)
                throws APIException
```
    Description copied from interface: UserService
    
    Deactivate a user account so that it can no longer log in.
    
    Specified by:
    
    retireUser in interface UserService
    
    Throws:
    
    APIException - Should retire user and set attributes
    
    See Also:
    
    UserService.retireUser(org.openmrs.User, java.lang.String)
  - unvoidUser
```
public User unvoidUser(User user)
                throws APIException
```
    Throws:
    
    APIException
  - unretireUser
```
public User unretireUser(User user)
                  throws APIException
```
    Description copied from interface: UserService
    
    Clears retired flag for a user.
    
    Specified by:
    
    unretireUser in interface UserService
    
    Throws:
    
    APIException - Should unretire and unmark all attributes
    
    See Also:
    
    UserService.unretireUser(org.openmrs.User)
  - getAllUsers
```
@Transactional(readOnly=true)
public List<User> getAllUsers()
                                                     throws APIException
```
    Description copied from interface: UserService
    
    Returns all users in the system
    
    Specified by:
    
    getAllUsers in interface UserService
    
    Returns:
    
    Global list of users
    
    Throws:
    
    APIException - Should fetch all users in the system Should not contains any duplicate users
    
    See Also:
    
    UserService.getAllUsers()
  - getAllPrivileges
```
@Transactional(readOnly=true)
public List<Privilege> getAllPrivileges()
                                                               throws APIException
```
    Description copied from interface: UserService
    
    Returns all privileges currently possible for any User
    
    Specified by:
    
    getAllPrivileges in interface UserService
    
    Returns:
    
    Global list of privileges
    
    Throws:
    
    APIException - Should return all privileges in the system
    
    See Also:
    
    UserService.getAllPrivileges()
  - getPrivilege
```
@Transactional(readOnly=true)
public Privilege getPrivilege(String p)
                                                     throws APIException
```
    Description copied from interface: UserService
    
    Returns Privilege in the system with given String privilege
    
    Specified by:
    
    getPrivilege in interface UserService
    
    Returns:
    
    Privilege
    
    Throws:
    
    APIException - Should fetch privilege for given name
    
    See Also:
    
    UserService.getPrivilege(java.lang.String)
  - purgePrivilege
```
public void purgePrivilege(Privilege privilege)
                    throws APIException
```
    Description copied from interface: UserService
    
    Completely remove a privilege from the database
    
    Specified by:
    
    purgePrivilege in interface UserService
    
    Parameters:
    
    privilege - Privilege to delete
    
    Throws:
    
    APIException - Should delete given privilege from the database Should throw error when privilege is core privilege
    
    See Also:
    
    UserService.purgePrivilege(org.openmrs.Privilege)
  - savePrivilege
```
public Privilege savePrivilege(Privilege privilege)
                        throws APIException
```
    Description copied from interface: UserService
    
    Save the given privilege in the database
    
    Specified by:
    
    savePrivilege in interface UserService
    
    Parameters:
    
    privilege - Privilege to update
    
    Returns:
    
    the saved privilege
    
    Throws:
    
    APIException - Should save given privilege to the database
    
    See Also:
    
    UserService.savePrivilege(org.openmrs.Privilege)
  - getAllRoles
```
@Transactional(readOnly=true)
public List<Role> getAllRoles()
                                                     throws APIException
```
    Description copied from interface: UserService
    
    Returns all roles currently possible for any User
    
    Specified by:
    
    getAllRoles in interface UserService
    
    Returns:
    
    Global list of roles
    
    Throws:
    
    APIException - Should return all roles in the system
    
    See Also:
    
    UserService.getAllRoles()
  - getRole
```
@Transactional(readOnly=true)
public Role getRole(String r)
                                           throws APIException
```
    Description copied from interface: UserService
    
    Returns role object with given string role
    
    Specified by:
    
    getRole in interface UserService
    
    Returns:
    
    Role object for specified string
    
    Throws:
    
    APIException - Should fetch role for given role name
    
    See Also:
    
    UserService.getRole(java.lang.String)
  - purgeRole
```
public void purgeRole(Role role)
               throws APIException
```
    Description copied from interface: UserService
    
    Complete remove a role from the database
    
    Specified by:
    
    purgeRole in interface UserService
    
    Parameters:
    
    role - Role to delete from the database
    
    Throws:
    
    APIException - Should throw error when role is a core role Should return if role is null Should delete given role from database
    
    See Also:
    
    UserService.purgeRole(org.openmrs.Role)
  - saveRole
```
public Role saveRole(Role role)
              throws APIException
```
    Description copied from interface: UserService
    
    Save the given role in the database
    
    Specified by:
    
    saveRole in interface UserService
    
    Parameters:
    
    role - Role to update
    
    Returns:
    
    the saved role
    
    Throws:
    
    APIException - Should throw error if role inherits from itself Should save given role to the database
    
    See Also:
    
    UserService.saveRole(org.openmrs.Role)
  - changePassword
```
public void changePassword(String oldPassword,
                           String newPassword)
                    throws APIException
```
    Description copied from interface: UserService
    
    Changes the current user's password.
    
    Specified by:
    
    changePassword in interface UserService
    
    Parameters:
    
    oldPassword - current password
    
    newPassword - new password
    
    Throws:
    
    APIException - Should match on correctly hashed sha1 stored password Should match on incorrectly hashed sha1 stored password Should match on sha512 hashed password Should be able to update password multiple times Should respect locking via runtime properties
    
    See Also:
    
    UserService.changePassword(java.lang.String, java.lang.String)
  - changeHashedPassword
```
public void changeHashedPassword(User user,
                                 String hashedPassword,
                                 String salt)
                          throws APIException
```
    Description copied from interface: UserService
    
    Changes the current user's password directly. This is most useful if migrating users from other systems and you want to retain the existing passwords. This method will simply save the passed hashed password and salt directly to the database.
    
    Specified by:
    
    changeHashedPassword in interface UserService
    
    Parameters:
    
    user - the user whose password you want to change
    
    hashedPassword - - the already hashed password to store
    
    salt - - the salt which should be used with this hashed password
    
    Throws:
    
    APIException
    
    See Also:
    
    UserService.changeHashedPassword(User, String, String)
  - changeQuestionAnswer
```
public void changeQuestionAnswer(User u,
                                 String question,
                                 String answer)
                          throws APIException
```
    Description copied from interface: UserService
    
    Changes the passed user's secret question and answer.
    
    Specified by:
    
    changeQuestionAnswer in interface UserService
    
    Parameters:
    
    u - User to change
    
    Throws:
    
    APIException
    
    See Also:
    
    UserService.changeQuestionAnswer(User, String, String)
  - changeQuestionAnswer
```
public void changeQuestionAnswer(String pw,
                                 String q,
                                 String a)
```
    Description copied from interface: UserService
    
    Changes the current user's secret question and answer.
    
    Specified by:
    
    changeQuestionAnswer in interface UserService
    
    Parameters:
    
    pw - user's password
    
    q - question
    
    a - answer
    
    See Also:
    
    UserService.changeQuestionAnswer(java.lang.String, java.lang.String, java.lang.String)
  - isSecretAnswer
```
@Transactional(readOnly=true)
public boolean isSecretAnswer(User u,
                                                            String answer)
```
    Description copied from interface: UserService
    
    Compares answer against the user's secret answer.
    
    Specified by:
    
    isSecretAnswer in interface UserService
    
    Parameters:
    
    u - user
    
    See Also:
    
    UserService.isSecretAnswer(org.openmrs.User, java.lang.String)
  - getUsersByName
```
@Transactional(readOnly=true)
public List<User> getUsersByName(String givenName,
                                                               String familyName,
                                                               boolean includeVoided)
                                                        throws APIException
```
    Description copied from interface: UserService
    
    Search for a list of users by exact first name and last name.
    
    Specified by:
    
    getUsersByName in interface UserService
    
    Returns:
    
    List<User> object of users matching criteria Should fetch users exactly matching the given givenName and familyName Should fetch voided users whenincludeVoided is true Should not fetch any voided users when includeVoided is false Should not fetch any duplicate users
    
    Throws:
    
    APIException
    
    See Also:
    
    UserService.getUsersByName(java.lang.String, java.lang.String, boolean)
  - getUsersByPerson
```
@Transactional(readOnly=true)
public List<User> getUsersByPerson(Person person,
                                                                 boolean includeRetired)
                                                          throws APIException
```
    Description copied from interface: UserService
    
    Get all user accounts that belong to a given person.
    
    Specified by:
    
    getUsersByPerson in interface UserService
    
    Returns:
    
    all user accounts that belong to person, including retired ones if specified
    
    Throws:
    
    APIException - Should fetch all accounts for a person when include retired is true Should not fetch retired accounts when include retired is false
    
    See Also:
    
    UserService.getUsersByPerson(org.openmrs.Person, boolean)
  - getUsers
```
@Transactional(readOnly=true)
public List<User> getUsers(String nameSearch,
                                                         List<Role> roles,
                                                         boolean includeVoided)
                                                  throws APIException
```
    Description copied from interface: UserService
    
    Return a list of users sorted by personName (see PersonByNameComparator) if any part of the search matches first/last/system id and the user has one at least one of the given roles assigned to them
    
    Specified by:
    
    getUsers in interface UserService
    
    Parameters:
    
    nameSearch - string to compare to the beginning of user's given/middle/family/family2 names
    
    roles - all the Roles the user must contain
    
    includeVoided - true/false whether to include voided users
    
    Returns:
    
    list of users matching the given attributes Should match search to familyName2 Should fetch voided users if includedVoided is true Should not fetch voided users if includedVoided is false Should fetch users with name that contains given nameSearch Should fetch users with systemId that contains given nameSearch Should fetch users with at least one of the given role objects Should not fetch duplicate users Should fetch all users if nameSearch is empty or null Should not fail if roles are searched but name is empty
    
    Throws:
    
    APIException
    
    See Also:
    
    UserService.getUsers(java.lang.String, java.util.List, boolean)
  - setUserProperty
```
public User setUserProperty(User user,
                            String key,
                            String value)
```
    Description copied from interface: UserService
    
    Adds the key/value pair to the given user.
    Implementations of this method should handle privileges
    
    Specified by:
    
    setUserProperty in interface UserService
    
    Returns:
    
    the user that was passed in and added to Should return null if user is null Should throw error when user is not authorized to edit users Should add property with given key and value when key does not already exist Should modify property with given key and value when key already exists
    
    See Also:
    
    UserService.setUserProperty(User, String, String)
  - removeUserProperty
```
public User removeUserProperty(User user,
                               String key)
```
    Description copied from interface: UserService
    
    Removes the property denoted by key from the user's properties. Implementations of this method should handle privileges
    
    Specified by:
    
    removeUserProperty in interface UserService
    
    Returns:
    
    the user that was passed in and removed from Should return null if user is null Should throw error when user is not authorized to edit users Should remove user property for given user and key
    
    See Also:
    
    UserService.removeUserProperty(org.openmrs.User, java.lang.String)
  - generateSystemId
```
@Transactional(readOnly=true)
public String generateSystemId()
```
    Generates system ids based on the following algorithm scheme: user_id-check digit
    
    Specified by:
    
    generateSystemId in interface UserService
    
    Returns:
    
    new system id
    
    See Also:
    
    UserService.generateSystemId()
  - purgeUser
```
public void purgeUser(User user)
               throws APIException
```
    Description copied from interface: UserService
    
    Completely remove a location from the database (not reversible). This method delegates to #purgeLocation(location, boolean) method.
    
    Specified by:
    
    purgeUser in interface UserService
    
    Parameters:
    
    user - the User to remove from the database. Should delete given user
    
    Throws:
    
    APIException
    
    See Also:
    
    UserService.purgeUser(org.openmrs.User)
  - purgeUser
```
public void purgeUser(User user,
                      boolean cascade)
               throws APIException
```
    Description copied from interface: UserService
    
    Completely remove a user from the database (not reversible). This is a delete from the database. This is included for troubleshooting and low-level system administration. Ideally, this method should never be called — Users should be voided and not deleted altogether (since many foreign key constraints depend on users, deleting a user would require deleting all traces, and any historical trail would be lost). This method only clears user roles and attempts to delete the user record. If the user has been included in any other parts of the database (through a foreign key), the attempt to delete the user will violate foreign key constraints and fail.
    
    Specified by:
    
    purgeUser in interface UserService
    
    cascade - true to delete associated content Should throw APIException if cascade is true Should delete given user when cascade equals false Should not delete user roles for given user when cascade equals false
    
    Throws:
    
    APIException
    
    See Also:
    
    UserService.purgeUser(org.openmrs.User, boolean)
  - getPrivilegeByUuid
```
@Transactional(readOnly=true)
public Privilege getPrivilegeByUuid(String uuid)
                                                           throws APIException
```
    Description copied from interface: UserService
    
    Get Privilege by its UUID
    
    Specified by:
    
    getPrivilegeByUuid in interface UserService
    
    Returns:
    
    privilege or null Should find object given valid uuid Should return null if no object found with given uuid Should fetch privilege for given uuid
    
    Throws:
    
    APIException
    
    See Also:
    
    UserService.getPrivilegeByUuid(java.lang.String)
  - getRoleByUuid
```
@Transactional(readOnly=true)
public Role getRoleByUuid(String uuid)
                                                 throws APIException
```
    Description copied from interface: UserService
    
    Get Role by its UUID
    
    Specified by:
    
    getRoleByUuid in interface UserService
    
    Returns:
    
    role or null Should find object given valid uuid Should return null if no object found with given uuid
    
    Throws:
    
    APIException
    
    See Also:
    
    UserService.getRoleByUuid(java.lang.String)
  - getUserByUuid
```
@Transactional(readOnly=true)
public User getUserByUuid(String uuid)
                                                 throws APIException
```
    Description copied from interface: UserService
    
    Get user by the given uuid.
    
    Specified by:
    
    getUserByUuid in interface UserService
    
    Returns:
    
    user or null
    
    Throws:
    
    APIException - Should fetch user with given uuid Should find object given valid uuid Should return null if no object found with given uuid
    
    See Also:
    
    UserService.getUserByUuid(java.lang.String)
  - getCountOfUsers
```
@Transactional(readOnly=true)
public Integer getCountOfUsers(String name,
                                                             List<Role> roles,
                                                             boolean includeRetired)
```
    Description copied from interface: UserService
    
    Return the number of users with a matching name or system id and have at least one of the given roles assigned to them
    
    Specified by:
    
    getCountOfUsers in interface UserService
    
    Parameters:
    
    name - patient name
    
    roles - all the Roles the user must contain
    
    includeRetired - Specifies whether voided users should be included
    
    Returns:
    
    the number of users matching the given attributes
    
    See Also:
    
    UserService.getCountOfUsers(String, List, boolean)
  - getUsers
```
@Transactional(readOnly=true)
public List<User> getUsers(String name,
                                                         List<Role> roles,
                                                         boolean includeRetired,
                                                         Integer start,
                                                         Integer length)
                                                  throws APIException
```
    Description copied from interface: UserService
    
    Return a batch of users of a specific size sorted by personName (see PersonByNameComparator) if any part of the search matches first/last/system id and the user has one at least one of the given roles assigned to them. If start and length are not specified, then all matches are returned, If name is empty or null, then all all users will be returned taking into consideration the values of start and length arguments.
    
    Specified by:
    
    getUsers in interface UserService
    
    Parameters:
    
    name - string to compare to the beginning of user's given/middle/family/family2 names
    
    roles - all the Roles the user must contain
    
    includeRetired - true/false whether to include voided users
    
    start - beginning index for the batch
    
    length - number of users to return in the batch
    
    Returns:
    
    list of matching users of a size based on the specified arguments
    
    Throws:
    
    APIException
    
    See Also:
    
    UserService.getUsers(String, List, boolean, Integer, Integer)
  - saveUserProperty
```
public User saveUserProperty(String key,
                             String value)
```
    Description copied from interface: UserService
    
    Saves the current key/value as a user property for the current user.
    
    Specified by:
    
    saveUserProperty in interface UserService
    
    Parameters:
    
    key - the authenticated user's property
    
    value - value of the property
  - saveUserProperties
```
public User saveUserProperties(Map<String,String> properties)
```
    Description copied from interface: UserService
    
    Replaces all user properties with the given map of properties for the current user
    
    Specified by:
    
    saveUserProperties in interface UserService
    
    Parameters:
    
    properties - the authenticated user's properties
  - changePassword
```
@Authorized(value="Edit User Passwords")
 @Logging(ignoredArgumentIndexes={1,2})
public void changePassword(User user,
                                                                                                            String oldPassword,
                                                                                                            String newPassword)
                                                                                                     throws APIException
```
    Description copied from interface: UserService
    
    Change user password.
    
    Specified by:
    
    changePassword in interface UserService
    
    Parameters:
    
    user - the user to update password
    
    oldPassword - the user password to update
    
    newPassword - the new user password
    
    Throws:
    
    APIException - for not existing user and if old password is weak
    
    See Also:
    
    UserService.changePassword(User, String, String)
  - changePassword
```
public void changePassword(User user,
                           String newPassword)
```
    Description copied from interface: UserService
    
    Changes password of User passed in
    
    Specified by:
    
    changePassword in interface UserService
    
    Parameters:
    
    user - user whose password is to be changed
    
    newPassword - new password to set
  - changePasswordUsingSecretAnswer
```
public void changePasswordUsingSecretAnswer(String secretAnswer,
                                            String pw)
                                     throws APIException
```
    Description copied from interface: UserService
    
    Change user password given the answer to the secret question
    
    Specified by:
    
    changePasswordUsingSecretAnswer in interface UserService
    
    Parameters:
    
    secretAnswer - the answer to secret question
    
    pw - the new password Should update password if secret is correct Should not update password if secret is not correct
    
    Throws:
    
    APIException
  - getSecretQuestion
```
public String getSecretQuestion(User user)
                         throws APIException
```
    Description copied from interface: UserService
    
    Returns secret question for the given user.
    
    Specified by:
    
    getSecretQuestion in interface UserService
    
    Returns:
    
    Throws:
    
    APIException
  - getUserByUsernameOrEmail
```
@Transactional(readOnly=true)
public User getUserByUsernameOrEmail(String usernameOrEmail)
```
    Description copied from interface: UserService
    
    Gets a user by username or email
    
    Specified by:
    
    getUserByUsernameOrEmail in interface UserService
    
    Parameters:
    
    usernameOrEmail - User's email address or username
    
    Returns:
    
    requested user or null if not found
    
    See Also:
    
    UserService.getUserByUsernameOrEmail(java.lang.String)
  - getUserByActivationKey
```
@Transactional(readOnly=true)
public User getUserByActivationKey(String activationKey)
```
    Description copied from interface: UserService
    
    Gets a user with the specified activation key
    
    Specified by:
    
    getUserByActivationKey in interface UserService
    
    Parameters:
    
    activationKey - User's activation key for password reset
    
    Returns:
    
    requested User with associated activation key
    
    See Also:
    
    UserService.getUserByActivationKey(java.lang.String)
  - setUserActivationKey
```
public User setUserActivationKey(User user)
                          throws MessageException
```
    Description copied from interface: UserService
    
    Sets a user's activation key
    
    Specified by:
    
    setUserActivationKey in interface UserService
    
    Parameters:
    
    user - The user for which the activation key will be set
    
    Throws:
    
    APIException
    
    MessageException
    
    See Also:
    
    UserService.setUserActivationKey(org.openmrs.User)
  - getDefaultLocaleForUser
```
public Locale getDefaultLocaleForUser(User user)
```
    Specified by:
    
    getDefaultLocaleForUser in interface UserService
    
    Parameters:
    
    user - the User whose Locale to retrieve
    
    Returns:
    
    the default Locale of the given user, or the system locale if unspecified
    
    See Also:
    
    UserService.getDefaultLocaleForUser(User)
  - changePasswordUsingActivationKey
```
public void changePasswordUsingActivationKey(String activationKey,
                                             String newPassword)
```
    Description copied from interface: UserService
    
    Change user password given the activation key
    
    Specified by:
    
    changePasswordUsingActivationKey in interface UserService
    
    Parameters:
    
    activationKey - the activation for password reset
    
    newPassword - the new password
    
    See Also:
    
    UserService.changePasswordUsingActivationKey(String, String);
  - getLastLoginTime
```
public String getLastLoginTime(User user)
```
    Description copied from interface: UserService
    
    Retrieves the last login time of the user in Unix Timestamp
    
    Specified by:
    
    getLastLoginTime in interface UserService
    
    Parameters:
    
    user - the subject user
    
    Returns:
    
    timestamp representing last login time (e.g. 1717414410587)
    
    See Also:
    
    UserService.getLastLoginTime(User)

Class UserServiceImpl

Field Summary

Fields inherited from interface org.openmrs.api.UserService

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.api.impl.BaseOpenmrsService

Methods inherited from class java.lang.Object

Methods inherited from interface org.openmrs.api.OpenmrsService

Field Detail

dao

Constructor Detail

UserServiceImpl

Method Detail

setUserDAO

createUser

getUser

getUserByUsername

hasDuplicateUsername

getUsersByRole

saveUser

voidUser

retireUser

unvoidUser

unretireUser

getAllUsers

getAllPrivileges

getPrivilege

purgePrivilege

savePrivilege

getAllRoles

getRole

purgeRole

saveRole

changePassword

changeHashedPassword

changeQuestionAnswer

changeQuestionAnswer

isSecretAnswer

getUsersByName

getUsersByPerson

getUsers

setUserProperty

removeUserProperty

generateSystemId

purgeUser

purgeUser

getPrivilegeByUuid

getRoleByUuid

getUserByUuid

getCountOfUsers

getUsers

saveUserProperty

saveUserProperties

changePassword

changePassword

changePasswordUsingSecretAnswer

getSecretQuestion

getUserByUsernameOrEmail

getUserByActivationKey

setUserActivationKey

getDefaultLocaleForUser

changePasswordUsingActivationKey

getLastLoginTime