com.belladati.extensions

Interface UserService

public interface UserService

Interface defining methods for managing users - creating, updating, deleting, assigning to domains and user groups.

Author:

BellaDati Inc.

Method Summary

Modifier and Type	Method and Description
User	createUser(UserBuilder userBuilder, boolean notify) Creates new user
String	createUserRequest(String username, UserRequestType type) Creates an user request of desired type.
void	deleteUser(Integer id) Deletes the user
User	loadUserById(Integer id) Loads User specified by ID
User	loadUserByUsername(String username) Loads User specified by username
void	updateDomainAssociation(Integer userId, Integer domainId, UserRole... roles) Updates user-domain association
void	updateUser(Integer id, Long version, UserBuilder userBuilder) Updates user specified by ID and version
void	updateUserGroupAssociation(Integer userId, Integer... userGroups) Updates user-user group association

Method Detail

loadUserById

User loadUserById(Integer id)

Loads User specified by ID

Parameters:

id - of user

Returns:

User instance

Throws:

RuntimeException - if user does not exist

loadUserByUsername

User loadUserByUsername(String username)

Loads User specified by username

Parameters:

username - of user

Returns:

User instance

Throws:

RuntimeException - if user does not exist or permission is denied

createUser

User createUser(UserBuilder userBuilder,
                boolean notify)

Creates new user

Parameters:

userBuilder - used to define user properties

notify - determines whether notification email should be send

Returns:

newly created User

Throws:

RuntimeException - if user does not exist or permission is denied

updateUser

void updateUser(Integer id,
                Long version,
                UserBuilder userBuilder)

Updates user specified by ID and version

Parameters:

id - of the user to update

version - of the user to update

userBuilder - used to define user properties to be updated

Throws:

RuntimeException - if user does not exist or permission is denied

deleteUser

void deleteUser(Integer id)

Deletes the user

Parameters:

id - of the user to delete

Throws:

RuntimeException - if user does not exist or permission is denied

updateDomainAssociation

void updateDomainAssociation(Integer userId,
                             Integer domainId,
                             UserRole... roles)

Updates user-domain association

Parameters:

userId - of the user

domainId - of the domain

roles - UserRole to set.

Throws:

RuntimeException - if user does not exist, domain does not exist or permission is denied

updateUserGroupAssociation

void updateUserGroupAssociation(Integer userId,
                                Integer... userGroups)

Updates user-user group association

Parameters:

userId - of the user

userGroups - id's of the groups

Throws:

RuntimeException - if user does not exist, user groups do not exist or permission is denied

createUserRequest

String createUserRequest(String username,
                         UserRequestType type)

Creates an user request of desired type.

Parameters:

username - username of the user the request is created for.

type - Specifies the type of the request. Available types are: LOGIN_UNATTENDED, PASSWORD_SET, PASSWORD_RESET, UNLOCK_ACCOUNT, LOGIN

Returns:

request_id and request_code of the created request. Example: 1544;RDQX1Qx9UokSf4n3KAVWgNClvrFUqncSZg7fK3gnVAfNIAOylN

Throws:

RuntimeException - if user does not exist or permission is denied