UserManagementImpl (Communote 3.5 API)

java.lang.Object
- com.communote.server.core.user.UserManagementBase
- - com.communote.server.core.user.UserManagementImpl

All Implemented Interfaces:

UserManagement
```
@Service(value="userManagement")
public class UserManagementImpl
extends UserManagementBase
```
The implementation of the UserManagement.
TODO REFACTORING getting to complex

Author:

Communote GmbH - http://www.communote.com/

Nested Class Summary
- Nested classes/interfaces inherited from interface com.communote.server.core.user.UserManagement
  UserManagement.RegistrationType

Field Summary
- Fields inherited from interface com.communote.server.core.user.UserManagement
  ANONYMIZE_USER_PREFIX

Constructor Summary

Constructors
Constructor and Description

UserManagementImpl()

Constructors
Constructor and Description
`UserManagementImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`changeAlias(Long userId, String newAlias)` Method to change the users alias.
`Collection<User>`	`findNotDeletedUsers(boolean excludeSystemUsers)` Returns a collection with all users that do not have one of the deleted statuses.
`User`	`findUser(UserIdentification userIdentification)` Find the User by the given identification, not loading the `ExternalUserAuthentication` s
`User`	`findUser(UserIdentification userIdentification, boolean loadExternalAuthentications)` Find the User by the given identification
`User`	`findUserByUserId(Long userId, boolean loadExternalAuthentications)` Find a user by the its id.
`List<User>`	`findUsersByRole(UserRole role, UserStatus status)` Returns a collection of users having a specific role and optionally a specific status.
`String`	`generateUniqueAlias(String externalUserName, String emailAddress)` Create a valid, not yet used, user alias.
`long`	`getActiveUserCount(String systemId, UserRole role)` Get the number of users with status ACTIVE.
`Set<ExternalUserAuthentication>`	`getExternalExternalUserAuthentications(long userId)`
`<T> T`	`getUserById(Long userId, Converter<User,T> converter)` Return the details of a user.
`protected void`	`handleAcceptTermsOfUse(Long userId)`
`protected void`	`handleAnonymizeUser(Long userId, Long[] blogIds, boolean becomeManager)` Performs the core logic for `UserManagementBase.anonymizeUser(Long, Long[], boolean)`
`protected User`	`handleAssignUserRole(Long userId, UserRole role)` Performs the core logic for `UserManagementBase.assignUserRole(Long, UserRole)`
`protected boolean`	`handleChangeEmailAddress(Long userId, String newEmail, boolean sendConfirmationEmail)` Performs the core logic for `#changeEmailAddress(Long, String)`
`protected void`	`handleChangeUserStatusByManager(Long userId, UserStatus newStatus)`
`protected void`	`handleConfirmNewEmailAddress(String securityCode)` Performs the core logic for `UserManagementBase.confirmNewEmailAddress(String)`
`protected User`	`handleConfirmUser(String securitycode, UserVO data)` Performs the core logic for `UserManagementBase.confirmUser(String, UserVO)`
`protected User`	`handleCreateOrUpdateExternalUser(ExternalUserVO userVO)` Performs the core logic for `UserManagementBase.createOrUpdateExternalUser(ExternalUserVO)`
`protected User`	`handleCreateUser(UserVO userVo, boolean emailConfirmation, boolean managerActivation)` Performs the core logic for `UserManagementBase.createUser(UserVO, boolean, boolean)`
`protected User`	`handleFindUserByAlias(String alias)` Performs the core logic for `UserManagementBase.findUserByAlias(String)`
`protected User`	`handleFindUserByEmail(String email)` Performs the core logic for `UserManagementBase.findUserByEmail(String)`
`protected User`	`handleFindUserByEmailAlias(String username)` Performs the core logic for `#findKenmeiUserByEmailAlias(String)`
`protected User`	`handleFindUserByExternalUserId(String userId, String systemId)` Performs the core logic for `UserManagementBase.findUserByExternalUserId(String, String)`
`protected long`	`handleGetActiveUserCount()` Performs the core logic for `UserManagementBase.getActiveUserCount()`
`protected UserRole[]`	`handleGetRolesOfUser(Long userId)` Performs the core logic for `UserManagementBase.getRolesOfUser(Long)`
`protected User`	`handleInviteUserToBlog(Long blogId, UserVO userVo, BlogRole role)` Performs the core logic for `#inviteUserToBlog(Long, User, UserVO, com.communote.server.model.blog.BlogRole)`
`protected User`	`handleInviteUserToClient(UserVO userVo)` Performs the core logic for `#inviteUserToClient(User, UserVO)`
`protected void`	`handlePermanentlyDisableUser(Long userId, Long[] blogIds, boolean becomeManager)` Performs the core logic for `UserManagementBase.permanentlyDisableUser(Long, Long[], boolean)`
`protected User`	`handleRegisterUser(String email, Locale locale, UserManagement.RegistrationType type)` Performs the core logic for `#registerUser(String, java.util.Locale)`
`protected User`	`handleRemoveUserRole(Long userId, UserRole role)` Performs the core logic for `UserManagementBase.removeUserRole(Long, UserRole)`
`protected void`	`handleResetPermanentId(String systemId)` Performs the core logic for `#resetExternalUserId(String)`
`protected User`	`handleUnlockUser(String securityCode)` Performs the core logic for `UserManagementBase.unlockUser(String)`
`protected User`	`handleUpdateExternalUser(ExternalUserVO userVO)` Performs the core logic for `UserManagementBase.updateExternalUser(ExternalUserVO)`
`protected void`	`handleUpdateLanguage(Long userId, String languageCode)` Performs the core logic for `UserManagementBase.updateLanguage(Long, String)`
`boolean`	`hasExternalAuthentication(long userId, String externalSystemId)`
`protected void`	`init()`
`void`	`registerActivationValidator(UserActivationValidator validator)` Register a validator that will be called before the status of a user is set to `ACTIVE`.
`void`	`resetTermsOfUse()` Reset the terms of use for all users which have already accepted the terms of use.
`void`	`sendReminderMails()`
`void`	`unregisterActivationValidator(UserActivationValidator validator)` Unregister a previously registered validator.
`void`	`updateUserTags(Long userId, Set<TagTO> tags)` Updates the tags of the given user.

Methods inherited from class com.communote.server.core.user.UserManagementBase
acceptTermsOfUse, anonymizeUser, assignUserRole, changeEmailAddress, changeUserStatusByManager, confirmNewEmailAddress, confirmUser, createOrUpdateExternalUser, createUser, findUserByAlias, findUserByEmail, findUserByEmailAlias, findUserByExternalUserId, findUserByUserId, getActiveUserCount, getPrincipal, getRolesOfUser, inviteUserToBlog, inviteUserToClient, permanentlyDisableUser, registerUser, removeUserRole, resetPermanentId, unlockUser, updateExternalUser, updateLanguage

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

Constructor Detail
- UserManagementImpl
```
public UserManagementImpl()
```

Method Detail

changeAlias
```
public boolean changeAlias(Long userId,
                           String newAlias)
                    throws AliasAlreadyExistsException,
                           AliasInvalidException
```
Method to change the users alias.

Parameters:

userId - The users id.

newAlias - The new alias.

Returns:

True, when the alias was changed, else false.

Throws:

AliasAlreadyExistsException - Thrown, when there is already a user with this alias.

AliasInvalidException - Thrown, when the alias is syntactically invalid.

findNotDeletedUsers
```
@Transactional(readOnly=true)
public Collection<User> findNotDeletedUsers(boolean excludeSystemUsers)
```
Description copied from interface: UserManagement

Returns a collection with all users that do not have one of the deleted statuses.

Parameters:

excludeSystemUsers - whether to exclude the users who have the system user role

findUser
```
public User findUser(UserIdentification userIdentification)
```
Description copied from interface: UserManagement

Find the User by the given identification, not loading the ExternalUserAuthentication s

Parameters:

userIdentification - the identification

Returns:

the user found

findUser
```
public User findUser(UserIdentification userIdentification,
                     boolean loadExternalAuthentications)
```
Description copied from interface: UserManagement

Find the User by the given identification

Parameters:

userIdentification - the identification

loadExternalAuthentications - true if the external auths of the user should be loaded as well

Returns:

the user found

findUserByUserId
```
@Transactional(readOnly=true)
public User findUserByUserId(Long userId,
                                                           boolean loadExternalAuthentications)
```
Description copied from interface: UserManagement

Find a user by the its id.
Use UserManagement.getUserById(Long, Converter) instead.

Parameters:

userId - Id of the user to find.

loadExternalAuthentications - true to load the external authentications of the user

Returns:

the user

findUsersByRole

@Transactional(readOnly=true)
public List<User> findUsersByRole(UserRole role,
                                                                UserStatus status)

Description copied from interface: UserManagement

Returns a collection of users having a specific role and optionally a specific status.

generateUniqueAlias
```
@Transactional(readOnly=true)
public String generateUniqueAlias(String externalUserName,
                                                                String emailAddress)
```
Description copied from interface: UserManagement

Create a valid, not yet used, user alias.

Parameters:

externalUserName - the external user name to try first. Can be null.

emailAddress - the email address to extract the alias from

Returns:

the found alias

getActiveUserCount
```
@Transactional(readOnly=true)
public long getActiveUserCount(String systemId,
                                                             UserRole role)
```
Description copied from interface: UserManagement

Get the number of users with status ACTIVE.

Parameters:

systemId - ID of an external system to only count the users which originate from this external system. If null, all user are counted.

role - the role of a user. If not null only the users with that role will be counted otherwise all roles (including system users) are considered.

Returns:

the number of active users

getExternalExternalUserAuthentications
```
public Set<ExternalUserAuthentication> getExternalExternalUserAuthentications(long userId)
```
Parameters:

userId - The users id.

Returns:

A set of the external authentications of the given user. This will always return a set.

getUserById
```
@Transactional(readOnly=true)
public <T> T getUserById(Long userId,
                                                       Converter<User,T> converter)
```
Description copied from interface: UserManagement

Return the details of a user. The data of the user will be converted with the provided converter and the resulting object will be returned. In case there is no user for the ID null is returned.

Type Parameters:

T - the type of the resulting object

Parameters:

userId - the ID of the user

converter - the converter to use

Returns:

the converted object or null if the user does not exist

handleAcceptTermsOfUse

protected void handleAcceptTermsOfUse(Long userId)
                               throws UserNotFoundException,
                                      AuthorizationException,
                                      UserActivationValidationException

Specified by:: handleAcceptTermsOfUse in class UserManagementBase
Throws:: UserNotFoundException; AuthorizationException; UserActivationValidationException

handleAnonymizeUser

protected void handleAnonymizeUser(Long userId,
                                   Long[] blogIds,
                                   boolean becomeManager)
                            throws AuthorizationException,
                                   NoBlogManagerLeftException,
                                   NoClientManagerLeftException,
                                   UserDeletionDisabledException

Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.anonymizeUser(Long, Long[], boolean)

Specified by:: handleAnonymizeUser in class UserManagementBase
Throws:: AuthorizationException; NoBlogManagerLeftException; NoClientManagerLeftException; UserDeletionDisabledException

handleAssignUserRole
```
protected User handleAssignUserRole(Long userId,
                                    UserRole role)
                             throws AuthorizationException,
                                    InvalidOperationException
```
Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.assignUserRole(Long, UserRole)

Specified by:

handleAssignUserRole in class UserManagementBase

Throws:

AuthorizationException - in case the current user is not a client manager

InvalidOperationException - in case the user is already a system or a crawl user or the role to assign is the system or crawl user role

handleChangeEmailAddress
```
protected boolean handleChangeEmailAddress(Long userId,
                                           String newEmail,
                                           boolean sendConfirmationEmail)
                                    throws EmailAlreadyExistsException,
                                           EmailValidationException
```
Description copied from class: UserManagementBase

Performs the core logic for #changeEmailAddress(Long, String)

Specified by:

handleChangeEmailAddress in class UserManagementBase

Parameters:

userId - Id of the user, which email should be changed.

newEmail - The new email address.

sendConfirmationEmail - If true an confirmation link will be send to the user to confirm the new address. False is only possible, if the current use an administrator.

Returns:

True, when the address was changed.

Throws:

EmailAlreadyExistsException

EmailValidationException

handleChangeUserStatusByManager

protected void handleChangeUserStatusByManager(Long userId,
                                               UserStatus newStatus)
                                        throws UserActivationValidationException,
                                               InvalidUserStatusTransitionException,
                                               UserNotFoundException,
                                               NoClientManagerLeftException

Specified by:: handleChangeUserStatusByManager in class UserManagementBase
Throws:: UserActivationValidationException; InvalidUserStatusTransitionException; UserNotFoundException; NoClientManagerLeftException

handleConfirmNewEmailAddress
```
protected void handleConfirmNewEmailAddress(String securityCode)
                                     throws SecurityCodeNotFoundException,
                                            EmailAlreadyExistsException
```
Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.confirmNewEmailAddress(String)

Specified by:

handleConfirmNewEmailAddress in class UserManagementBase

Throws:

SecurityCodeNotFoundException

EmailAlreadyExistsException

handleConfirmUser

protected User handleConfirmUser(String securitycode,
                                 UserVO data)
                          throws SecurityCodeNotFoundException,
                                 EmailValidationException,
                                 EmailAlreadyExistsException,
                                 AliasAlreadyExistsException,
                                 PasswordValidationException,
                                 InvalidUserStatusTransitionException,
                                 ExternalUserPasswordChangeNotAllowedException

Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.confirmUser(String, UserVO)

Specified by:: handleConfirmUser in class UserManagementBase
Throws:: SecurityCodeNotFoundException; EmailValidationException; EmailAlreadyExistsException; AliasAlreadyExistsException; PasswordValidationException; InvalidUserStatusTransitionException; ExternalUserPasswordChangeNotAllowedException

handleCreateOrUpdateExternalUser

protected User handleCreateOrUpdateExternalUser(ExternalUserVO userVO)
                                         throws EmailAlreadyExistsException,
                                                EmailValidationException,
                                                AliasAlreadyExistsException,
                                                UserActivationValidationException,
                                                InvalidUserStatusTransitionException,
                                                PermanentIdMissmatchException

Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.createOrUpdateExternalUser(ExternalUserVO)

Specified by:: handleCreateOrUpdateExternalUser in class UserManagementBase
Throws:: EmailAlreadyExistsException; EmailValidationException; AliasAlreadyExistsException; UserActivationValidationException; InvalidUserStatusTransitionException; PermanentIdMissmatchException

handleCreateUser

protected User handleCreateUser(UserVO userVo,
                                boolean emailConfirmation,
                                boolean managerActivation)
                         throws EmailAlreadyExistsException,
                                EmailValidationException,
                                AliasAlreadyExistsException,
                                PasswordValidationException

Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.createUser(UserVO, boolean, boolean)

Specified by:: handleCreateUser in class UserManagementBase
Throws:: EmailAlreadyExistsException; EmailValidationException; AliasAlreadyExistsException; PasswordValidationException

handleFindUserByAlias
```
protected User handleFindUserByAlias(String alias)
```
Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.findUserByAlias(String)

Specified by:

handleFindUserByAlias in class UserManagementBase

handleFindUserByEmail
```
protected User handleFindUserByEmail(String email)
```
Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.findUserByEmail(String)

Specified by:

handleFindUserByEmail in class UserManagementBase

handleFindUserByEmailAlias
```
protected User handleFindUserByEmailAlias(String username)
```
Description copied from class: UserManagementBase

Performs the core logic for #findKenmeiUserByEmailAlias(String)

Specified by:

handleFindUserByEmailAlias in class UserManagementBase

handleFindUserByExternalUserId
```
protected User handleFindUserByExternalUserId(String userId,
                                              String systemId)
```
Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.findUserByExternalUserId(String, String)

Specified by:

handleFindUserByExternalUserId in class UserManagementBase

handleGetActiveUserCount
```
protected long handleGetActiveUserCount()
```
Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.getActiveUserCount()

Specified by:

handleGetActiveUserCount in class UserManagementBase

handleGetRolesOfUser
```
protected UserRole[] handleGetRolesOfUser(Long userId)
```
Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.getRolesOfUser(Long)

Specified by:

handleGetRolesOfUser in class UserManagementBase

handleInviteUserToBlog

protected User handleInviteUserToBlog(Long blogId,
                                      UserVO userVo,
                                      BlogRole role)
                               throws AliasAlreadyExistsException,
                                      EmailAlreadyExistsException,
                                      EmailValidationException,
                                      PermanentIdMissmatchException,
                                      AuthorizationException

Description copied from class: UserManagementBase

Performs the core logic for #inviteUserToBlog(Long, User, UserVO, com.communote.server.model.blog.BlogRole)

Specified by:: handleInviteUserToBlog in class UserManagementBase
Throws:: BlogAccessException - in case the current user is not allowed to add the user; AuthorizationException - in case there is no current user; AliasAlreadyExistsException; EmailAlreadyExistsException; EmailValidationException; PermanentIdMissmatchException

handleInviteUserToClient

protected User handleInviteUserToClient(UserVO userVo)
                                 throws EmailValidationException,
                                        EmailAlreadyExistsException,
                                        AliasAlreadyExistsException,
                                        PermanentIdMissmatchException,
                                        AuthorizationException

Description copied from class: UserManagementBase

Performs the core logic for #inviteUserToClient(User, UserVO)

Specified by:: handleInviteUserToClient in class UserManagementBase
Throws:: EmailValidationException; EmailAlreadyExistsException; AliasAlreadyExistsException; PermanentIdMissmatchException; AuthorizationException

handlePermanentlyDisableUser

protected void handlePermanentlyDisableUser(Long userId,
                                            Long[] blogIds,
                                            boolean becomeManager)
                                     throws AuthorizationException,
                                            NoBlogManagerLeftException,
                                            NoClientManagerLeftException,
                                            UserDeletionDisabledException,
                                            InvalidUserStatusTransitionException

Performs the core logic for UserManagementBase.permanentlyDisableUser(Long, Long[], boolean)

Specified by:: handlePermanentlyDisableUser in class UserManagementBase
Throws:: AuthorizationException; NoBlogManagerLeftException; NoClientManagerLeftException; UserDeletionDisabledException; InvalidUserStatusTransitionException

handleRegisterUser

protected User handleRegisterUser(String email,
                                  Locale locale,
                                  UserManagement.RegistrationType type)
                           throws EmailValidationException,
                                  EmailAlreadyExistsException

Performs the core logic for #registerUser(String, java.util.Locale)

Specified by:: handleRegisterUser in class UserManagementBase
Throws:: EmailValidationException; EmailAlreadyExistsException
See Also:: UserManagement.registerUser(String, Locale, RegistrationType)

handleRemoveUserRole
```
protected User handleRemoveUserRole(Long userId,
                                    UserRole role)
                             throws AuthorizationException,
                                    InvalidOperationException,
                                    NoClientManagerLeftException
```
Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.removeUserRole(Long, UserRole)

Specified by:

handleRemoveUserRole in class UserManagementBase

Throws:

AuthorizationException - in case the current user is not client manager

InvalidOperationException - in case the user is a system or crawl user and the system or crawl user role should be removed

NoClientManagerLeftException - in case the client manager role should be removed from the last user with that role

handleResetPermanentId
```
protected void handleResetPermanentId(String systemId)
                               throws AuthorizationException
```
Performs the core logic for #resetExternalUserId(String)

Specified by:

handleResetPermanentId in class UserManagementBase

Throws:

AuthorizationException

handleUnlockUser
```
protected User handleUnlockUser(String securityCode)
                         throws SecurityCodeNotFoundException
```
Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.unlockUser(String)

Specified by:

handleUnlockUser in class UserManagementBase

Throws:

SecurityCodeNotFoundException

handleUpdateExternalUser

protected User handleUpdateExternalUser(ExternalUserVO userVO)
                                 throws AliasAlreadyExistsException,
                                        EmailValidationException,
                                        EmailAlreadyExistsException,
                                        UserActivationValidationException,
                                        InvalidUserStatusTransitionException,
                                        PermanentIdMissmatchException

Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.updateExternalUser(ExternalUserVO)

Specified by:: handleUpdateExternalUser in class UserManagementBase
Throws:: AliasAlreadyExistsException; EmailValidationException; EmailAlreadyExistsException; UserActivationValidationException; InvalidUserStatusTransitionException; PermanentIdMissmatchException

handleUpdateLanguage
```
protected void handleUpdateLanguage(Long userId,
                                    String languageCode)
```
Description copied from class: UserManagementBase

Performs the core logic for UserManagementBase.updateLanguage(Long, String)

Specified by:

handleUpdateLanguage in class UserManagementBase

hasExternalAuthentication
```
public boolean hasExternalAuthentication(long userId,
                                         String externalSystemId)
```
Parameters:

userId - The users id.

externalSystemId - ID of an external system

Returns:

true if the user has an external authentication with the given ID

init
```
@PostConstruct
protected void init()
```

registerActivationValidator
```
public void registerActivationValidator(UserActivationValidator validator)
```
Description copied from interface: UserManagement

Register a validator that will be called before the status of a user is set to ACTIVE. The validators are executed in the order defined by the Orderable implementation. If the first validator throws an exception the validation will be stopped.

Parameters:

validator - the validator to add

resetTermsOfUse
```
public void resetTermsOfUse()
                     throws AuthorizationException
```
Description copied from interface: UserManagement

Reset the terms of use for all users which have already accepted the terms of use. This will exclude users which are not active or temporarily disabled. The current user is excluded too. The status of the user is not modified only the termsAccepted flag is reset.

Throws:

AuthorizationException - in case the current user is not client manager or internal system user

sendReminderMails
```
public void sendReminderMails()
```

unregisterActivationValidator
```
public void unregisterActivationValidator(UserActivationValidator validator)
```
Description copied from interface: UserManagement

Unregister a previously registered validator.

Parameters:

validator - the validator to remove

updateUserTags

public void updateUserTags(Long userId,
                           Set<TagTO> tags)

Updates the tags of the given user.

Parameters:: userId - The users id.; tags - The tags of the user.

Class UserManagementImpl

Nested Class Summary

Nested classes/interfaces inherited from interface com.communote.server.core.user.UserManagement

Field Summary

Fields inherited from interface com.communote.server.core.user.UserManagement

Constructor Summary

Method Summary

Methods inherited from class com.communote.server.core.user.UserManagementBase

Methods inherited from class java.lang.Object

Constructor Detail

UserManagementImpl

Method Detail

changeAlias

findNotDeletedUsers

findUser

findUser

findUserByUserId

findUsersByRole

generateUniqueAlias

getActiveUserCount

getExternalExternalUserAuthentications

getUserById

handleAcceptTermsOfUse

handleAnonymizeUser

handleAssignUserRole

handleChangeEmailAddress

handleChangeUserStatusByManager

handleConfirmNewEmailAddress

handleConfirmUser

handleCreateOrUpdateExternalUser

handleCreateUser

handleFindUserByAlias

handleFindUserByEmail

handleFindUserByEmailAlias

handleFindUserByExternalUserId

handleGetActiveUserCount

handleGetRolesOfUser

handleInviteUserToBlog

handleInviteUserToClient

handlePermanentlyDisableUser

handleRegisterUser

handleRemoveUserRole

handleResetPermanentId

handleUnlockUser

handleUpdateExternalUser

handleUpdateLanguage

hasExternalAuthentication

init

registerActivationValidator

resetTermsOfUse

sendReminderMails

unregisterActivationValidator

updateUserTags