UserService (cosmo-api 1.0.26 API)

All Superinterfaces:

Service
```
public interface UserService
extends Service
```
Interface for services that manage user accounts.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`PasswordRecovery`	`createPasswordRecovery(PasswordRecovery passwordRecovery)` Creates a PasswordRecovery entity in the repository.
`User`	`createUser(User user)` Creates a user account in the repository.
`User`	`createUser(User user, ServiceListener[] listeners)` Creates a user account in the repository as per `createUser(User)`.
`void`	`deletePasswordRecovery(PasswordRecovery passwordRecovery)` Deletes the specified PasswordRecovery object from the repository.
`Set<User>`	`findUsersByPreference(String key, String value)` Returns a set of users that contain a user preference that matches a specific key and value.
`String`	`generatePassword()` Generates a random password in a format suitable for presentation as an authentication credential.
`PasswordRecovery`	`getPasswordRecovery(String key)` Returns the PasswordRecovery entity associated with the given password recovery key.
`User`	`getUser(String username)` Returns the user account identified by the given username.
`User`	`getUserByActivationId(String activationId)` Returns the user account associated with the given activation id.
`User`	`getUserByEmail(String email)` Returns the user account identified by the given email address.
`Set<User>`	`getUsers()` Returns an unordered set of all user accounts in the repository.
`PagedList<User,User.SortType>`	`getUsers(PageCriteria<User.SortType> pageCriteria)` Returns the all user accounts meeting the supplied `PageCriteria`'s requirements
`void`	`removeUser(String username)` Removes the user account identified by the given username from the repository.
`void`	`removeUser(User user)` Removes a user account from the repository.
`void`	`removeUsers(Set<User> users)` Removes a set of user accounts from the repository.
`void`	`removeUsersByName(Set<String> usernames)` Removes the user accounts identified by the given usernames from the repository.
`User`	`updateUser(User user)` Updates a user account that exists in the repository.

Methods inherited from interface org.unitedinternet.cosmo.service.Service
destroy, init

- Method Detail
  - getUsers
```
Set<User> getUsers()
```
    Returns an unordered set of all user accounts in the repository.
  - getUser
```
User getUser(String username)
```
    Returns the user account identified by the given username.
    
    Parameters:
    
    username - the username of the account to return
    
    Throws:
    
    DataRetrievalFailureException - if the account does not exist
  - getUsers
```
PagedList<User,User.SortType> getUsers(PageCriteria<User.SortType> pageCriteria)
```
    Returns the all user accounts meeting the supplied PageCriteria's requirements
    
    Parameters:
    
    pageCriteria - the Pagination Criteria for the PagedList
    
    Throws:
    
    IllegalArgumentException - if an invalid pageNumber is supplied in the PageCriteria
  - getUserByEmail
```
User getUserByEmail(String email)
```
    Returns the user account identified by the given email address.
    
    Parameters:
    
    email - the email address of the account to return
    
    Throws:
    
    DataRetrievalFailureException - if the account does not exist
  - getUserByActivationId
```
User getUserByActivationId(String activationId)
```
    Returns the user account associated with the given activation id.
    
    Parameters:
    
    activationId - the activation id associated with the account to return
    
    Returns:
    
    the User associated with activationId
    
    Throws:
    
    DataRetrievalFailureException - if there is no user associated with this activation id.
  - findUsersByPreference
```
Set<User> findUsersByPreference(String key,
                                String value)
```
    Returns a set of users that contain a user preference that matches a specific key and value.
    
    Parameters:
    
    key - user preference key to match
    
    value - user preference value to match
    
    Returns:
    
    set of users containing a user preference that matches key and value
  - createUser
```
User createUser(User user)
```
    Creates a user account in the repository. Digests the raw password and uses the result to replace the raw password. Returns a new instance of User after saving the original one.
    
    Parameters:
    
    user - the account to create
    
    Throws:
    
    DataIntegrityViolationException - if the username or email address is already in use
  - createUser
```
User createUser(User user,
                ServiceListener[] listeners)
```
    Creates a user account in the repository as per createUser(User). Sends the #EVENT_CREATE_USER event to each provided listener.
    
    Parameters:
    
    user - the account to create
    
    listeners - an array of listeners to notify
    
    Throws:
    
    DataIntegrityViolationException - if the username or email address is already in use
  - updateUser
```
User updateUser(User user)
```
    Updates a user account that exists in the repository. If the password has been changed, digests the raw new password and uses the result to replace the stored password. Returns a new instance of User after saving the original one.
    
    Parameters:
    
    user - the account to update
    
    Throws:
    
    DataRetrievalFailureException - if the account does not exist
    
    DataIntegrityViolationException - if the username or email address is already in use
  - removeUser
```
void removeUser(User user)
```
    Removes a user account from the repository.
    
    Parameters:
    
    user - the account to remove
  - removeUser
```
void removeUser(String username)
```
    Removes the user account identified by the given username from the repository.
    
    Parameters:
    
    username - the username of the account to return
  - removeUsers
```
void removeUsers(Set<User> users)
          throws OverlordDeletionException
```
    Removes a set of user accounts from the repository.
    
    Parameters:
    
    users -
    
    Throws:
    
    OverlordDeletionException
  - removeUsersByName
```
void removeUsersByName(Set<String> usernames)
                throws OverlordDeletionException
```
    Removes the user accounts identified by the given usernames from the repository.
    
    Parameters:
    
    usernames -
    
    Throws:
    
    OverlordDeletionException
  - generatePassword
```
String generatePassword()
```
    Generates a random password in a format suitable for presentation as an authentication credential.
  - getPasswordRecovery
```
PasswordRecovery getPasswordRecovery(String key)
```
    Returns the PasswordRecovery entity associated with the given password recovery key. If the specified PasswordRecovery entity has expired, returns null after removing the PasswordRecovery object from persistant storage.
    
    Parameters:
    
    key - the password recovery key associated with the account to return
    
    Returns:
    
    the User associated with key
    
    Throws:
    
    DataRetrievalFailureException - if there is no user associated with this activation id.
  - createPasswordRecovery
```
PasswordRecovery createPasswordRecovery(PasswordRecovery passwordRecovery)
```
    Creates a PasswordRecovery entity in the repository. Returns a new instance of the PasswordRecovery object after saving the original.
    
    Parameters:
    
    passwordRecovery - the PasswordRecovery object to create in the repository.
  - deletePasswordRecovery
```
void deletePasswordRecovery(PasswordRecovery passwordRecovery)
```
    Deletes the specified PasswordRecovery object from the repository.
    
    Parameters:
    
    passwordRecovery - the PasswordRecovery object to delete.

Interface UserService

Method Summary

Methods inherited from interface org.unitedinternet.cosmo.service.Service

Method Detail

getUsers

getUser

getUsers

getUserByEmail

getUserByActivationId

findUsersByPreference

createUser

createUser

updateUser

removeUser

removeUser

removeUsers

removeUsersByName

generatePassword

getPasswordRecovery

createPasswordRecovery

deletePasswordRecovery