de.alpharogroup.user.management.service.api

Interface UserManagementService

All Superinterfaces:

Serializable, de.alpharogroup.auth.usermanagement.UserExistenceService

All Known Implementing Classes:

UserManagementDomainService

public interface UserManagementService
extends de.alpharogroup.auth.usermanagement.UserExistenceService

The interface UserManagementService.

Method Summary

Modifier and Type	Method and Description
de.alpharogroup.user.domain.User	addUserContact(de.alpharogroup.user.domain.User user, de.alpharogroup.user.domain.User contact) Adds the given contact User object to the contacts of the given User object.
UserData	deleteAddress(de.alpharogroup.address.book.domain.Address address, UserData ud) Deletes the given Address object from the given UserData object.
UserData	deleteBlacklisted(de.alpharogroup.user.domain.User blacklisted, Integer userDataId) Deletes the given black listed User object from the given user data id.
void	deleteResource(de.alpharogroup.resource.system.application.model.ResourcesModel resource, Integer userDataId) Deletes the Resource object from the given resource model object with the given user data id.
boolean	existsUserWithEmail(Contactmethod emailContact) Checks if a user exists with the given email.
boolean	existsUserWithEmailOrUsername(String emailOrUsername) Checks if a user exists with the given email or user name.
List<de.alpharogroup.address.book.domain.Address>	findAddessesFromUser(de.alpharogroup.user.domain.User user) Find all Address from the given User.
de.alpharogroup.address.book.domain.Address	findAddressFromUser(de.alpharogroup.user.domain.User user) Find the main Address from the given User.
List<Contactmethod>	findAllEmailContactmethodsFromUser(de.alpharogroup.user.domain.User user) Find all email contacts from the given User.
List<Contactmethod>	findAllFaxContactmethodsFromUser(de.alpharogroup.user.domain.User user) Find all fax contacts from the given User.
List<Contactmethod>	findAllInternetContactmethodsFromUser(de.alpharogroup.user.domain.User user) Find all internet contacts from the given User.
List<Contactmethod>	findAllMobileContactmethodsFromUser(de.alpharogroup.user.domain.User user) Find all mobile contacts from user.
List<Contactmethod>	findAllTelefonContactmethodsFromUser(de.alpharogroup.user.domain.User user) Find all telefon contacts from the given User.
Contactmethod	findEmailContactFromUser(de.alpharogroup.user.domain.User user) Find email contact from the given User.
Contactmethod	findFaxContactFromUser(de.alpharogroup.user.domain.User user) Find fax contact from the given User.
Contactmethod	findInternetContactFromUser(de.alpharogroup.user.domain.User user) Find internet contact from the given User.
Contactmethod	findMobileContactFromUser(de.alpharogroup.user.domain.User user) Find mobile contact from the given User.
List<de.alpharogroup.user.domain.Role>	findRolesFromUser(de.alpharogroup.user.domain.User user) Find roles from the given User.
Contactmethod	findTelefonContactFromUser(de.alpharogroup.user.domain.User user) Find telefon contact from the given User.
de.alpharogroup.user.domain.User	findUserWithEmail(String email) Find the User object with the given email.
de.alpharogroup.user.domain.User	findUserWithEmailOrUsername(String emailOrUsername) Find User object from the given email or user name.
de.alpharogroup.user.domain.User	findUserWithUsername(String username) Find User object from the given user name.
boolean	isInRole(String rolename, List<de.alpharogroup.user.domain.Role> roles) Checks if a Role object exist in the given list with the given role name.
boolean	isUserInRole(de.alpharogroup.user.domain.User user, String rolename) Checks if the given User object is in the given role from the given role name.
boolean	isValid(String token) Checks if the given token is valid.
String	newAuthenticationToken(String username) Factory method that creates a new authentication token from the given user name.
de.alpharogroup.resource.system.domain.Resource	persistResource(de.alpharogroup.resource.system.application.model.ResourcesModel resourceModel, Integer userId) Persist the given resource model object with the given user id.
void	saveAddressesFromUser(de.alpharogroup.user.domain.User user, Collection<de.alpharogroup.address.book.domain.Address> addresses) Persist the given collection of Address objects from the given User object.
void	saveAddressFromUser(de.alpharogroup.user.domain.User user, de.alpharogroup.address.book.domain.Address address) Persist the given Address object from the given User object.
Serializable	saveNewUser(de.alpharogroup.user.domain.User user) Persist the given User object.
Serializable	saveUserOnlyWithEmail(de.alpharogroup.user.domain.User user) Persist the given User object without checking the user name.
Contactmethod	saveUserWithContactmethod(de.alpharogroup.user.domain.User user, Contactmethod contact) Persist the given Contactmethod object to the given User object contacts.
List<Contactmethod>	saveUserWithContactmethods(de.alpharogroup.user.domain.User user, List<Contactmethod> contacts) Persist the given list of Contactmethod objects to the given User object contacts.
void	saveUserWithRoles(de.alpharogroup.user.domain.User user, Collection<de.alpharogroup.user.domain.Role> roles) Persist the given User object with the given collection of Role objects.
Contactmethod	setEmail(String email, de.alpharogroup.user.domain.User user) Update email from the given User object if the email has changed and return the new contactMethod object or the contactMethod that is persist in database.
boolean	setUsername(String username, de.alpharogroup.user.domain.User user) Sets a new user name to the the given User object.
de.alpharogroup.user.management.sign.up.SignUpUserResult	signUpUser(de.alpharogroup.auth.models.UsernameSignUpModel model, Set<de.alpharogroup.user.domain.Role> roles, de.alpharogroup.user.management.sign.up.UserModel userModel) Sign up process for insert a new user in the database.
Contactmethod	updateContactmethod(String contactmethodValue, de.alpharogroup.user.management.enums.ContactmethodType contactmethodType, Contactmethod contactmethod) Update an existing Contactmethod object.
boolean	updateUsername(String username, de.alpharogroup.user.domain.User user) Update user name from the given User object if the user name has changed.
boolean	userIsInRole(de.alpharogroup.user.domain.User user, de.alpharogroup.user.domain.Role role) Checks if the given User object is in the given Role object.
de.alpharogroup.auth.models.ValidationErrors	validate(de.alpharogroup.auth.models.UsernameSignUpModel model) Validate the given UsernameSignUpModel object.

Methods inherited from interface de.alpharogroup.auth.usermanagement.UserExistenceService

existsUserWithEmail, existsUserWithEmailOrUsername, existsUserWithUsername

Method Detail

addUserContact

de.alpharogroup.user.domain.User addUserContact(de.alpharogroup.user.domain.User user,
                                                de.alpharogroup.user.domain.User contact)

Adds the given contact User object to the contacts of the given User object.

Parameters:

user - the user

contact - the contact to add

Returns:

the User object with the new contacts.

deleteAddress

UserData deleteAddress(de.alpharogroup.address.book.domain.Address address,
                       UserData ud)

Deletes the given Address object from the given UserData object.

Parameters:

address - the Address object

ud - the UserData object

Returns:

the UserData object.

deleteBlacklisted

UserData deleteBlacklisted(de.alpharogroup.user.domain.User blacklisted,
                           Integer userDataId)

Deletes the given black listed User object from the given user data id.

Parameters:

blacklisted - the black listed user

userDataId - the user data id

Returns:

the UserData object.

deleteResource

void deleteResource(de.alpharogroup.resource.system.application.model.ResourcesModel resource,
                    Integer userDataId)

Deletes the Resource object from the given resource model object with the given user data id.

Parameters:

resource - the resource

userDataId - the user data id

existsUserWithEmail

boolean existsUserWithEmail(Contactmethod emailContact)

Checks if a user exists with the given email.

Parameters:

emailContact - the email contact

Returns:

true, if successful

existsUserWithEmailOrUsername

boolean existsUserWithEmailOrUsername(String emailOrUsername)

Checks if a user exists with the given email or user name.

Specified by:

existsUserWithEmailOrUsername in interface de.alpharogroup.auth.usermanagement.UserExistenceService

Parameters:

emailOrUsername - the email or user name

Returns:

true, if successful

findAddessesFromUser

List<de.alpharogroup.address.book.domain.Address> findAddessesFromUser(de.alpharogroup.user.domain.User user)

Find all Address from the given User.

Parameters:

user - the user

Returns:

the list of found Address from the given User.

findAddressFromUser

de.alpharogroup.address.book.domain.Address findAddressFromUser(de.alpharogroup.user.domain.User user)

Find the main Address from the given User.

Parameters:

user - the user

Returns:

the main Address from the given User.

findAllEmailContactmethodsFromUser

List<Contactmethod> findAllEmailContactmethodsFromUser(de.alpharogroup.user.domain.User user)

Find all email contacts from the given User.

Parameters:

user - the user

Returns:

the list of found Contactmethod from the given User.

findAllFaxContactmethodsFromUser

List<Contactmethod> findAllFaxContactmethodsFromUser(de.alpharogroup.user.domain.User user)

Find all fax contacts from the given User.

Parameters:

user - the user

Returns:

the list of found Contactmethod from the given User.

findAllInternetContactmethodsFromUser

List<Contactmethod> findAllInternetContactmethodsFromUser(de.alpharogroup.user.domain.User user)

Find all internet contacts from the given User.

Parameters:

user - the user

Returns:

the list of found Contactmethod from the given User.

findAllMobileContactmethodsFromUser

List<Contactmethod> findAllMobileContactmethodsFromUser(de.alpharogroup.user.domain.User user)

Find all mobile contacts from user.

Parameters:

user - the user

Returns:

the list of found Contactmethod from the given User.

findAllTelefonContactmethodsFromUser

List<Contactmethod> findAllTelefonContactmethodsFromUser(de.alpharogroup.user.domain.User user)

Find all telefon contacts from the given User.

Parameters:

user - the user

Returns:

the list of found Contactmethod from the given User.

findEmailContactFromUser

Contactmethod findEmailContactFromUser(de.alpharogroup.user.domain.User user)

Find email contact from the given User.

Parameters:

user - the user

Returns:

the found Contactmethod from the given User.

findFaxContactFromUser

Contactmethod findFaxContactFromUser(de.alpharogroup.user.domain.User user)

Find fax contact from the given User.

Parameters:

user - the user

Returns:

the found Contactmethod from the given User.

findInternetContactFromUser

Contactmethod findInternetContactFromUser(de.alpharogroup.user.domain.User user)

Find internet contact from the given User.

Parameters:

user - the user

Returns:

the found Contactmethod from the given User.

findMobileContactFromUser

Contactmethod findMobileContactFromUser(de.alpharogroup.user.domain.User user)

Find mobile contact from the given User.

Parameters:

user - the user

Returns:

the found Contactmethod from the given User.

findRolesFromUser

List<de.alpharogroup.user.domain.Role> findRolesFromUser(de.alpharogroup.user.domain.User user)

Find roles from the given User.

Parameters:

user - the user

Returns:

the list of found Role from the given User.

findTelefonContactFromUser

Contactmethod findTelefonContactFromUser(de.alpharogroup.user.domain.User user)

Find telefon contact from the given User.

Parameters:

user - the user

Returns:

the found Contactmethod from the given User.

findUserWithEmail

de.alpharogroup.user.domain.User findUserWithEmail(String email)

Find the User object with the given email.

Parameters:

email - the email

Returns:

the found User object

findUserWithEmailOrUsername

de.alpharogroup.user.domain.User findUserWithEmailOrUsername(String emailOrUsername)

Find User object from the given email or user name.

Parameters:

emailOrUsername - the email or user name

Returns:

the found User object

findUserWithUsername

de.alpharogroup.user.domain.User findUserWithUsername(String username)

Find User object from the given user name.

Parameters:

username - the user name

Returns:

the found User object

isInRole

boolean isInRole(String rolename,
                 List<de.alpharogroup.user.domain.Role> roles)

Checks if a Role object exist in the given list with the given role name.

Parameters:

rolename - the role name

roles - the roles

Returns:

true, if the Role object exist in the list otherwise false.

isUserInRole

boolean isUserInRole(de.alpharogroup.user.domain.User user,
                     String rolename)

Checks if the given User object is in the given role from the given role name.

Parameters:

user - the user

rolename - the role name

Returns:

true, if the given User object is in role otherwise false.

isValid

boolean isValid(String token)

Checks if the given token is valid.

Parameters:

token - the token to validate

Returns:

true, if the given token is valid otherwise false

newAuthenticationToken

String newAuthenticationToken(String username)

Factory method that creates a new authentication token from the given user name.

Parameters:

username - the username

Returns:

the new authentication token

persistResource

de.alpharogroup.resource.system.domain.Resource persistResource(de.alpharogroup.resource.system.application.model.ResourcesModel resourceModel,
                                                                Integer userId)

Persist the given resource model object with the given user id.

Parameters:

resourceModel - the resource model

userId - the user id

Returns:

the persisted Resource object

saveAddressesFromUser

void saveAddressesFromUser(de.alpharogroup.user.domain.User user,
                           Collection<de.alpharogroup.address.book.domain.Address> addresses)

Persist the given collection of Address objects from the given User object.

Parameters:

user - the user

addresses - the addresses

saveAddressFromUser

void saveAddressFromUser(de.alpharogroup.user.domain.User user,
                         de.alpharogroup.address.book.domain.Address address)

Persist the given Address object from the given User object.

Parameters:

user - the user

address - the address

saveNewUser

Serializable saveNewUser(de.alpharogroup.user.domain.User user)
                  throws de.alpharogroup.auth.exceptions.UserAlreadyExistsException

Persist the given User object.

Parameters:

user - The User object to persist.

Returns:

the id of the persisted User object.

Throws:

de.alpharogroup.auth.exceptions.UserAlreadyExistsException - Thrown if the given User object already exists in the database.

saveUserOnlyWithEmail

Serializable saveUserOnlyWithEmail(de.alpharogroup.user.domain.User user)
                            throws de.alpharogroup.auth.exceptions.UserAlreadyExistsException

Persist the given User object without checking the user name.

Parameters:

user - The User object to persist.

Returns:

the id of the persisted User object.

Throws:

de.alpharogroup.auth.exceptions.UserAlreadyExistsException - Thrown if the given User object already exists in the database.

saveUserWithContactmethod

Contactmethod saveUserWithContactmethod(de.alpharogroup.user.domain.User user,
                                        Contactmethod contact)
                                 throws BatchUpdateException

Persist the given Contactmethod object to the given User object contacts.

Parameters:

user - the user

contact - the contact

Returns:

the persisted Contactmethod object.

Throws:

BatchUpdateException - the batch update exception

saveUserWithContactmethods

List<Contactmethod> saveUserWithContactmethods(de.alpharogroup.user.domain.User user,
                                               List<Contactmethod> contacts)
                                        throws BatchUpdateException

Persist the given list of Contactmethod objects to the given User object contacts.

Parameters:

user - the user

contacts - the contacts

Returns:

the persisted list of Contactmethod objects.

Throws:

BatchUpdateException - the batch update exception

saveUserWithRoles

void saveUserWithRoles(de.alpharogroup.user.domain.User user,
                       Collection<de.alpharogroup.user.domain.Role> roles)

Persist the given User object with the given collection of Role objects.

Parameters:

user - the user

roles - the roles

setEmail

Contactmethod setEmail(String email,
                       de.alpharogroup.user.domain.User user)
                throws de.alpharogroup.auth.exceptions.EmailAlreadyExistsException

Update email from the given User object if the email has changed and return the new contactMethod object or the contactMethod that is persist in database. Consider to check if the email already exists before you call this method otherwise an exception is thrown.

Parameters:

email - the email

user - the user

Returns:

the Contactmethod object

Throws:

de.alpharogroup.auth.exceptions.EmailAlreadyExistsException - the email already exists exception

setUsername

boolean setUsername(String username,
                    de.alpharogroup.user.domain.User user)
             throws de.alpharogroup.auth.exceptions.UserAlreadyExistsException

Sets a new user name to the the given User object.

Parameters:

username - the username

user - the user

Returns:

true, if successful

Throws:

de.alpharogroup.auth.exceptions.UserAlreadyExistsException - is thrown if the user already exists with the given user name.

signUpUser

de.alpharogroup.user.management.sign.up.SignUpUserResult signUpUser(de.alpharogroup.auth.models.UsernameSignUpModel model,
                                                                    Set<de.alpharogroup.user.domain.Role> roles,
                                                                    de.alpharogroup.user.management.sign.up.UserModel userModel)

Sign up process for insert a new user in the database.

Parameters:

model - the model

roles - the roles

userModel - the user model

Returns:

the SignUpUserResult object with the result of the sign up process

updateContactmethod

Contactmethod updateContactmethod(String contactmethodValue,
                                  de.alpharogroup.user.management.enums.ContactmethodType contactmethodType,
                                  Contactmethod contactmethod)

Update an existing Contactmethod object. If the contact method has changed the new Contactmethod object will be returned or null if nothing changed.

Parameters:

contactmethodValue - the contact method value

contactmethodType - the contact method type

contactmethod - the contact method

Returns:

the Contactmethod object

updateUsername

boolean updateUsername(String username,
                       de.alpharogroup.user.domain.User user)
                throws de.alpharogroup.auth.exceptions.UserAlreadyExistsException

Update user name from the given User object if the user name has changed. Returns true if the user name has changed otherwise false.

Parameters:

username - the user name

user - the user

Returns:

Returns true if the user name has changed otherwise false.

Throws:

de.alpharogroup.auth.exceptions.UserAlreadyExistsException - is thrown if the user already exists with the given user name.

userIsInRole

boolean userIsInRole(de.alpharogroup.user.domain.User user,
                     de.alpharogroup.user.domain.Role role)

Checks if the given User object is in the given Role object.

Parameters:

user - the user

role - the role

Returns:

true, if successful

validate

de.alpharogroup.auth.models.ValidationErrors validate(de.alpharogroup.auth.models.UsernameSignUpModel model)

Validate the given UsernameSignUpModel object.

Parameters:

model - the UsernameSignUpModel object.

Returns:

A ValidationErrors object if validation fail otherwise null if the validation is successful.