org.unitedinternet.cosmo.service

Interface UserService

All Superinterfaces:

Service

public interface UserService
extends Service

Interface for services that manage user accounts.

Method Summary

Modifier and Type	Method and Description
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).
String	generatePassword() Generates a random password in a format suitable for presentation as an authentication credential.
User	getUser(String username) Returns the user account identified by the given username.
User	getUserByEmail(String email) Returns the user account identified by the given email address.
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

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

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

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.