com.communote.server.core.user

Class UserManagementBase

java.lang.Object

com.communote.server.core.user.UserManagementBase

All Implemented Interfaces:

UserManagement

Direct Known Subclasses:

UserManagementImpl

@Transactional(propagation=REQUIRED)
public abstract class UserManagementBase
extends Object
implements UserManagement

Spring Service base class for com.communote.server.service.user.UserManagement, provides access to all services and entities referenced by this service.

Author:

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

See Also:

UserManagement

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
UserManagementBase()

Method Summary

Modifier and Type	Method and Description
void	acceptTermsOfUse(Long userId) Accept the terms of use for the given user.
void	anonymizeUser(Long userId, Long[] blogIds, boolean becomeManager) Delete a user by anonymizing his profile and removing the content (notes, topics if possible) he created.
User	assignUserRole(Long userId, UserRole role) Assign the user role to the user
boolean	changeEmailAddress(Long userId, String newEmail, boolean sendConfirmationLink) Changes the email address of an user and validates this new address.
void	changeUserStatusByManager(Long userId, UserStatus newStatus) Change the status of a user.
void	confirmNewEmailAddress(String securityCode) Confirms the new email address.
User	confirmUser(String securitycode, UserVO user) Confirms a registered or invited user, sets user data and change status to active or confirmed.
User	createOrUpdateExternalUser(ExternalUserVO userVO) Creates or updates a user with data retrieved from a external user repository (e.g.
User	createUser(UserVO user, boolean emailConfirmation, boolean managerConfirmation) Create a user based on the parameters.
User	findUserByAlias(String alias) Find the User by the given alias s
User	findUserByEmail(String email) Find a user by the email address
User	findUserByEmailAlias(String username) find user by email or alias
User	findUserByExternalUserId(String externalUserId, String systemId) Find the user by the external system specification
User	findUserByUserId(Long userId) Find a user by the its id.
long	getActiveUserCount()
protected Principal	getPrincipal() Gets the current principal if one has been set, otherwise returns null.
UserRole[]	getRolesOfUser(Long userId) Returns the roles of a user.
protected abstract void	handleAcceptTermsOfUse(Long userId)
protected abstract void	handleAnonymizeUser(Long userId, Long[] blogIds, boolean becomeManager) Performs the core logic for anonymizeUser(Long, Long[], boolean)
protected abstract User	handleAssignUserRole(Long userId, UserRole role) Performs the core logic for assignUserRole(Long, UserRole)
protected abstract boolean	handleChangeEmailAddress(Long userId, String newEmail, boolean sendConfirmationLink) Performs the core logic for #changeEmailAddress(Long, String)
protected abstract void	handleChangeUserStatusByManager(Long userId, UserStatus newStatus)
protected abstract void	handleConfirmNewEmailAddress(String securityCode) Performs the core logic for confirmNewEmailAddress(String)
protected abstract User	handleConfirmUser(String securitycode, UserVO user) Performs the core logic for confirmUser(String, UserVO)
protected abstract User	handleCreateOrUpdateExternalUser(ExternalUserVO userVO) Performs the core logic for createOrUpdateExternalUser(ExternalUserVO)
protected abstract User	handleCreateUser(UserVO user, boolean emailConfirmation, boolean managerConfirmation) Performs the core logic for createUser(UserVO, boolean, boolean)
protected abstract User	handleFindUserByAlias(String alias) Performs the core logic for findUserByAlias(String)
protected abstract User	handleFindUserByEmail(String email) Performs the core logic for findUserByEmail(String)
protected abstract User	handleFindUserByEmailAlias(String username) Performs the core logic for #findKenmeiUserByEmailAlias(String)
protected abstract User	handleFindUserByExternalUserId(String externalUserId, String systemId) Performs the core logic for findUserByExternalUserId(String, String)
protected abstract long	handleGetActiveUserCount() Performs the core logic for getActiveUserCount()
protected abstract UserRole[]	handleGetRolesOfUser(Long userId) Performs the core logic for getRolesOfUser(Long)
protected abstract User	handleInviteUserToBlog(Long blogId, UserVO userData, BlogRole role) Performs the core logic for #inviteUserToBlog(Long, User, UserVO, com.communote.server.model.blog.BlogRole)
protected abstract User	handleInviteUserToClient(UserVO user) Performs the core logic for #inviteUserToClient(User, UserVO)
protected abstract void	handlePermanentlyDisableUser(Long userId, Long[] blogIds, boolean becomeManager) Performs the core logic for permanentlyDisableUser(Long, Long[], boolean)
protected abstract User	handleRegisterUser(String email, Locale locale, UserManagement.RegistrationType type) Performs the core logic for #registerUser(String, java.util.Locale)
protected abstract User	handleRemoveUserRole(Long userId, UserRole role) Performs the core logic for removeUserRole(Long, UserRole)
protected abstract void	handleResetPermanentId(String systemId) Performs the core logic for #resetExternalUserId(String)
protected abstract User	handleUnlockUser(String securityCode) Performs the core logic for unlockUser(String)
protected abstract User	handleUpdateExternalUser(ExternalUserVO userVO) Performs the core logic for updateExternalUser(ExternalUserVO)
protected abstract void	handleUpdateLanguage(Long userId, String languageCode) Performs the core logic for updateLanguage(Long, String)
User	inviteUserToBlog(Long blogId, UserVO userData, BlogRole role)
User	inviteUserToClient(UserVO user)
void	permanentlyDisableUser(Long userId, Long[] blogIds, boolean becomeManager) Deletes a user by setting his status to PERMANENTLY_DISABLED but keeping all his data.
User	registerUser(String email, Locale locale, UserManagement.RegistrationType type) Method to register an user via email address.
User	removeUserRole(Long userId, UserRole role) Remove a role from a user
void	resetPermanentId(String systemId) resets the external user ID for users that have an external authentication which has the provided external system ID and a permanentId
User	unlockUser(String securityCode) Unlocks the user for the given security code.
User	updateExternalUser(ExternalUserVO userVO) Tries to update a user with data retrieved from an external resource (e.g.
void	updateLanguage(Long userId, String languageCode) Sets the language of the given user to the given language.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

changeAlias, findNotDeletedUsers, findUser, findUser, findUserByUserId, findUsersByRole, generateUniqueAlias, getActiveUserCount, getExternalExternalUserAuthentications, getUserById, hasExternalAuthentication, registerActivationValidator, resetTermsOfUse, sendReminderMails, unregisterActivationValidator, updateUserTags

Constructor Detail

UserManagementBase

public UserManagementBase()

Method Detail

acceptTermsOfUse

public void acceptTermsOfUse(Long userId)
                      throws UserNotFoundException,
                             AuthorizationException,
                             UserActivationValidationException

Description copied from interface: UserManagement

Accept the terms of use for the given user. If the user has status TERMS_NOT_ACCEPTED the status is changed to ACTIVE. If the user is already ACTIVE a user property which contains the revision of the accepted terms of use is updated. The provided ID must be that of the current user or there should be no current user or the internal system user.

Specified by:

acceptTermsOfUse in interface UserManagement

Parameters:

userId - ID of the user whose ID should be accepted

Throws:

UserNotFoundException - in case the user with the given ID does not exist

AuthorizationException - in case there is a current user which is not the internal system user and this user does not have the provided ID

UserActivationValidationException - in case the user has status TERMS_NOT_ACCEPTED but cannot be activated after accepting the terms

anonymizeUser

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

Delete a user by anonymizing his profile and removing the content (notes, topics if possible) he created. The user will have status DELETED afterwards and cannot be restored.

Specified by:

anonymizeUser in interface UserManagement

Parameters:

userId - ID of the user to remove

blogIds - an array of IDs of topics in which the user to remove is the only manager. If the current user is not a client manager this parameter is ignored.

becomeManager - whether the current user, which has to be a client manager, should become manager of the topics identified by the IDs in blogIds array. If false the topics will be deleted.

Throws:

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

NoClientManagerLeftException - in case the user to delete is the last active client manager

UserDeletionDisabledException - in case the anonymization of users is disabled and the current user is not a client manager

NoBlogManagerLeftException - in case there are topics which are managed by the user to remove and have additional users with read access but no other managers. If the current user is client manager this exception will only be thrown if the IDs of the topics are not in the blogIds array. The exception will contain the IDs of the topics that would become manager-less.

assignUserRole

public User assignUserRole(Long userId,
                           UserRole role)
                    throws AuthorizationException,
                           InvalidOperationException

Description copied from interface: UserManagement

Assign the user role to the user

Specified by:

assignUserRole in interface UserManagement

Parameters:

userId - the id of the user

role - the role to assign

Returns:

the final user

Throws:

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

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

changeEmailAddress

public boolean changeEmailAddress(Long userId,
                                  String newEmail,
                                  boolean sendConfirmationLink)
                           throws EmailValidationException,
                                  EmailAlreadyExistsException

Changes the email address of an user and validates this new address.

Specified by:

changeEmailAddress in interface UserManagement

Parameters:

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

newEmail - The new email address.

sendConfirmationLink - 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 email was changed, else false.

Throws:

EmailValidationException

EmailAlreadyExistsException

changeUserStatusByManager

public void changeUserStatusByManager(Long userId,
                                      UserStatus newStatus)
                               throws AuthorizationException,
                                      UserNotFoundException,
                                      InvalidUserStatusTransitionException,
                                      NoClientManagerLeftException,
                                      UserActivationValidationException

Description copied from interface: UserManagement

Change the status of a user.

Note: Attempts to set the user status to DELETED or PERMANENTLY_DISABLED will result in an InvalidUserStatusTransitionException. Such a status change can only be achieved by invoking the appropriate service methods UserManagement.anonymizeUser(Long, Long[], boolean) or UserManagement.permanentlyDisableUser(Long, Long[], boolean).

Specified by:

changeUserStatusByManager in interface UserManagement

Parameters:

userId - the ID of the user whose status should be changed

newStatus - the new status to set

Throws:

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

UserNotFoundException - in case there is no user with the provided ID

InvalidUserStatusTransitionException - in case new status cannot be set. This will for example happen if the it is one of DELETED or PERMANENTLY_DISABLED

NoClientManagerLeftException - in case the user to change is the only client manager with status ACTIVE and the new status is not ACTIVE

UserActivationValidationException - in case the user cannot be activated

confirmNewEmailAddress

public void confirmNewEmailAddress(String securityCode)
                            throws SecurityCodeNotFoundException,
                                   EmailAlreadyExistsException

Description copied from interface: UserManagement

Confirms the new email address.

Specified by:

confirmNewEmailAddress in interface UserManagement

Parameters:

securityCode - The security code.

Throws:

SecurityCodeNotFoundException

EmailAlreadyExistsException

confirmUser

public User confirmUser(String securitycode,
                        UserVO user)
                 throws SecurityCodeNotFoundException,
                        EmailValidationException,
                        EmailAlreadyExistsException,
                        AliasAlreadyExistsException,
                        PasswordValidationException,
                        InvalidUserStatusTransitionException,
                        ExternalUserPasswordChangeNotAllowedException

Description copied from interface: UserManagement

Confirms a registered or invited user, sets user data and change status to active or confirmed.

Specified by:

confirmUser in interface UserManagement

Throws:

SecurityCodeNotFoundException

EmailValidationException

EmailAlreadyExistsException

AliasAlreadyExistsException

PasswordValidationException

InvalidUserStatusTransitionException

ExternalUserPasswordChangeNotAllowedException

createOrUpdateExternalUser

public User createOrUpdateExternalUser(ExternalUserVO userVO)
                                throws EmailValidationException,
                                       EmailAlreadyExistsException,
                                       AliasAlreadyExistsException,
                                       InvalidUserStatusTransitionException,
                                       UserActivationValidationException,
                                       NoClientManagerLeftException,
                                       PermanentIdMissmatchException

Description copied from interface: UserManagement

Creates or updates a user with data retrieved from a external user repository (e.g. via LDAP). If the user does not yet exist it will be created, otherwise updated. In case of an update the null values of the VO are ignored. In case of a create the null values will be set to appropriate defaults.

Specified by:

createOrUpdateExternalUser in interface UserManagement

Parameters:

userVO - VO with details of the user to create

Returns:

the modified user

Throws:

EmailValidationException - in case the email address is not valid

EmailAlreadyExistsException - in case the email address is already assigned to another user

AliasAlreadyExistsException - in case the alias is already assigned to another user

InvalidUserStatusTransitionException - in case the user exists and the old status of that user cannot be updated with the new status

UserActivationValidationException - in case the user cannot be updated

NoClientManagerLeftException - in case the user exists and is the only active client manager and the new status is not ACTIVE

PermanentIdMissmatchException

createUser

public User createUser(UserVO user,
                       boolean emailConfirmation,
                       boolean managerConfirmation)
                throws EmailAlreadyExistsException,
                       EmailValidationException,
                       AliasAlreadyExistsException,
                       PasswordValidationException

Description copied from interface: UserManagement

Create a user based on the parameters. If the user already exists, an exception is thrown.

Specified by:

createUser in interface UserManagement

Parameters:

user - the VO describing the user to create

emailConfirmation - whether the user should confirm the provided email address. If true a confirmation email will be sent to the email address.

managerConfirmation - whether a client manager has to confirm and activate the user. If true the managers will be performed by email about the new user.

Returns:

the new user

Throws:

EmailAlreadyExistsException - in case the provided email address already exists

EmailValidationException - in case the provided email address is not valid

AliasAlreadyExistsException - in case the provided user alias already exists

PasswordValidationException - in case the provided password does not meet the minimum security requirements

findUserByAlias

@Transactional(readOnly=true)
public User findUserByAlias(String alias)

Description copied from interface: UserManagement

Find the User by the given alias s

Specified by:

findUserByAlias in interface UserManagement

Parameters:

alias - the alias

Returns:

the user found

findUserByEmail

@Transactional(readOnly=true)
public User findUserByEmail(String email)

Description copied from interface: UserManagement

Find a user by the email address

Specified by:

findUserByEmail in interface UserManagement

Parameters:

email - address to search for.

findUserByEmailAlias

@Transactional(readOnly=true)
public User findUserByEmailAlias(String username)

Description copied from interface: UserManagement

find user by email or alias

Specified by:

findUserByEmailAlias in interface UserManagement

Parameters:

username - May be a user alias or email address

findUserByExternalUserId

@Transactional(readOnly=true)
public User findUserByExternalUserId(String externalUserId,
                                                                   String systemId)

Description copied from interface: UserManagement

Find the user by the external system specification

Specified by:

findUserByExternalUserId in interface UserManagement

See Also:

UserManagement.findUserByExternalUserId(String, String)

findUserByUserId

@Transactional(readOnly=true)
public User findUserByUserId(Long userId)

Find a user by the its id. Note: This doesn't load the external authentications of the user. Use UserManagement.findUserByUserId(Long, boolean) if you need this information or better UserManagement.getUserById(Long, Converter).

Specified by:

findUserByUserId in interface UserManagement

Parameters:

userId - Id of the user to find.

getActiveUserCount

@Transactional(readOnly=true)
public long getActiveUserCount()

Specified by:

getActiveUserCount in interface UserManagement

Returns:

the number of users with status ACTIVE. System users are not counted.

See Also:

UserManagement.getActiveUserCount()

getPrincipal

protected Principal getPrincipal()

Gets the current principal if one has been set, otherwise returns null.

Returns:

the current principal

getRolesOfUser

@Transactional(readOnly=true)
public UserRole[] getRolesOfUser(Long userId)

Description copied from interface: UserManagement

Returns the roles of a user.

Specified by:

getRolesOfUser in interface UserManagement

Parameters:

userId - If of the user to get the roles for.

Returns:

Array of the users roles.

See Also:

UserManagement.getRolesOfUser(Long)

handleAcceptTermsOfUse

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

Throws:

UserNotFoundException

AuthorizationException

UserActivationValidationException

handleAnonymizeUser

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

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

Throws:

AuthorizationException

NoClientManagerLeftException

UserDeletionDisabledException

NoBlogManagerLeftException

handleAssignUserRole

protected abstract User handleAssignUserRole(Long userId,
                                             UserRole role)
                                      throws AuthorizationException,
                                             InvalidOperationException

Performs the core logic for assignUserRole(Long, UserRole)

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 abstract boolean handleChangeEmailAddress(Long userId,
                                                    String newEmail,
                                                    boolean sendConfirmationLink)
                                             throws EmailValidationException,
                                                    EmailAlreadyExistsException

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

Parameters:

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

newEmail - The new email address.

sendConfirmationLink - 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:

EmailValidationException

EmailAlreadyExistsException

handleChangeUserStatusByManager

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

Throws:

UserActivationValidationException

InvalidUserStatusTransitionException

UserNotFoundException

NoClientManagerLeftException

handleConfirmNewEmailAddress

protected abstract void handleConfirmNewEmailAddress(String securityCode)
                                              throws SecurityCodeNotFoundException,
                                                     EmailAlreadyExistsException

Performs the core logic for confirmNewEmailAddress(String)

Throws:

SecurityCodeNotFoundException

EmailAlreadyExistsException

handleConfirmUser

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

Performs the core logic for confirmUser(String, UserVO)

Throws:

SecurityCodeNotFoundException

EmailValidationException

EmailAlreadyExistsException

AliasAlreadyExistsException

PasswordValidationException

InvalidUserStatusTransitionException

ExternalUserPasswordChangeNotAllowedException

handleCreateOrUpdateExternalUser

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

Performs the core logic for createOrUpdateExternalUser(ExternalUserVO)

Throws:

EmailValidationException

EmailAlreadyExistsException

AliasAlreadyExistsException

InvalidUserStatusTransitionException

UserActivationValidationException

NoClientManagerLeftException

PermanentIdMissmatchException

handleCreateUser

protected abstract User handleCreateUser(UserVO user,
                                         boolean emailConfirmation,
                                         boolean managerConfirmation)
                                  throws EmailAlreadyExistsException,
                                         EmailValidationException,
                                         AliasAlreadyExistsException,
                                         PasswordValidationException

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

Throws:

EmailAlreadyExistsException

EmailValidationException

AliasAlreadyExistsException

PasswordValidationException

handleFindUserByAlias

protected abstract User handleFindUserByAlias(String alias)

Performs the core logic for findUserByAlias(String)

handleFindUserByEmail

protected abstract User handleFindUserByEmail(String email)

Performs the core logic for findUserByEmail(String)

handleFindUserByEmailAlias

protected abstract User handleFindUserByEmailAlias(String username)

Performs the core logic for #findKenmeiUserByEmailAlias(String)

handleFindUserByExternalUserId

protected abstract User handleFindUserByExternalUserId(String externalUserId,
                                                       String systemId)

Performs the core logic for findUserByExternalUserId(String, String)

handleGetActiveUserCount

protected abstract long handleGetActiveUserCount()

Performs the core logic for getActiveUserCount()

handleGetRolesOfUser

protected abstract UserRole[] handleGetRolesOfUser(Long userId)

Performs the core logic for getRolesOfUser(Long)

handleInviteUserToBlog

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

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

Throws:

BlogAccessException - in case the current user is not allowed to add the user

AuthorizationException - in case there is no current user

AliasAlreadyExistsException

EmailValidationException

EmailAlreadyExistsException

PermanentIdMissmatchException

handleInviteUserToClient

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

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

Throws:

EmailValidationException

EmailAlreadyExistsException

AliasAlreadyExistsException

PermanentIdMissmatchException

AuthorizationException

handlePermanentlyDisableUser

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

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

Throws:

AuthorizationException

NoClientManagerLeftException

UserDeletionDisabledException

InvalidUserStatusTransitionException

NoBlogManagerLeftException

handleRegisterUser

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

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

Parameters:

type -

Throws:

EmailValidationException

EmailAlreadyExistsException

handleRemoveUserRole

protected abstract User handleRemoveUserRole(Long userId,
                                             UserRole role)
                                      throws AuthorizationException,
                                             InvalidOperationException,
                                             NoClientManagerLeftException

Performs the core logic for removeUserRole(Long, UserRole)

Throws:

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

AuthorizationException - in case the current user is not client manager

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

handleResetPermanentId

protected abstract void handleResetPermanentId(String systemId)
                                        throws AuthorizationException

Performs the core logic for #resetExternalUserId(String)

Throws:

AuthorizationException

handleUnlockUser

protected abstract User handleUnlockUser(String securityCode)
                                  throws SecurityCodeNotFoundException

Performs the core logic for unlockUser(String)

Throws:

SecurityCodeNotFoundException

handleUpdateExternalUser

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

Performs the core logic for updateExternalUser(ExternalUserVO)

Throws:

AliasAlreadyExistsException

EmailAlreadyExistsException

EmailValidationException

InvalidUserStatusTransitionException

NoClientManagerLeftException

PermanentIdMissmatchException

UserActivationValidationException

handleUpdateLanguage

protected abstract void handleUpdateLanguage(Long userId,
                                             String languageCode)

Performs the core logic for updateLanguage(Long, String)

inviteUserToBlog

public User inviteUserToBlog(Long blogId,
                             UserVO userData,
                             BlogRole role)
                      throws AliasAlreadyExistsException,
                             EmailValidationException,
                             EmailAlreadyExistsException,
                             PermanentIdMissmatchException,
                             AuthorizationException

Specified by:

inviteUserToBlog in interface UserManagement

Throws:

BlogAccessException - in case the current user is not allowed to invite a user

AuthorizationException - in case there is no current user

AliasAlreadyExistsException

EmailValidationException

EmailAlreadyExistsException

PermanentIdMissmatchException

inviteUserToClient

public User inviteUserToClient(UserVO user)
                        throws EmailValidationException,
                               EmailAlreadyExistsException,
                               AliasAlreadyExistsException,
                               PermanentIdMissmatchException,
                               AuthorizationException

Specified by:

inviteUserToClient in interface UserManagement

Throws:

EmailValidationException

EmailAlreadyExistsException

AliasAlreadyExistsException

PermanentIdMissmatchException

AuthorizationException

permanentlyDisableUser

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

Deletes a user by setting his status to PERMANENTLY_DISABLED but keeping all his data.

Specified by:

permanentlyDisableUser in interface UserManagement

Throws:

AuthorizationException

NoClientManagerLeftException

UserDeletionDisabledException

InvalidUserStatusTransitionException

NoBlogManagerLeftException

registerUser

public User registerUser(String email,
                         Locale locale,
                         UserManagement.RegistrationType type)
                  throws EmailValidationException,
                         EmailAlreadyExistsException

Method to register an user via email address.

Specified by:

registerUser in interface UserManagement

Parameters:

email - The users email address.

locale - The locale to use for the confirmation email.

type - The type of the registration.

Returns:

The newly registered user.

Throws:

EmailValidationException - Thrown, when the email address is not syntactically valid.

EmailAlreadyExistsException - Thrown, when the email/user address already exists.

removeUserRole

public User removeUserRole(Long userId,
                           UserRole role)
                    throws AuthorizationException,
                           InvalidOperationException,
                           NoClientManagerLeftException

Description copied from interface: UserManagement

Remove a role from a user

Specified by:

removeUserRole in interface UserManagement

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

resetPermanentId

public void resetPermanentId(String systemId)
                      throws AuthorizationException

Description copied from interface: UserManagement

resets the external user ID for users that have an external authentication which has the provided external system ID and a permanentId

Specified by:

resetPermanentId in interface UserManagement

Throws:

AuthorizationException

See Also:

UserManagement#resetExternalUserId(String)

unlockUser

public User unlockUser(String securityCode)
                throws SecurityCodeNotFoundException

Unlocks the user for the given security code.

Specified by:

unlockUser in interface UserManagement

Parameters:

securityCode - The code, which user should be unlocked.

Returns:

The unlocked user.

Throws:

SecurityCodeNotFoundException - Thrown, when the code doesn't exist.

updateExternalUser

public User updateExternalUser(ExternalUserVO userVO)
                        throws AliasAlreadyExistsException,
                               EmailAlreadyExistsException,
                               EmailValidationException,
                               UserActivationValidationException,
                               InvalidUserStatusTransitionException,
                               NoClientManagerLeftException,
                               PermanentIdMissmatchException

Description copied from interface: UserManagement

Tries to update a user with data retrieved from an external resource (e.g. via LDAP). If the user does not exist locally the update request is ignored. Otherwise his data will be updated by only copying the non-null values.

Specified by:

updateExternalUser in interface UserManagement

Parameters:

userVO - a VO with data to update the user with

Returns:

the modified user or null

Throws:

AliasAlreadyExistsException - in case the new alias is already assigned to another user

EmailAlreadyExistsException - in case the new email address is already assigned to another user

EmailValidationException - in case the new email address is not valid

UserActivationValidationException - in case the user cannot be activated

InvalidUserStatusTransitionException - in case the old status of the user cannot be updated with the new status

NoClientManagerLeftException - in case the user is the only active client manager and the new status is not ACTIVE

PermanentIdMissmatchException

updateLanguage

public void updateLanguage(Long userId,
                           String languageCode)

Sets the language of the given user to the given language.

Specified by:

updateLanguage in interface UserManagement

Parameters:

userId - The user to update.

languageCode - The language to set.