com.communote.server.core.user

Interface UserManagement

All Known Implementing Classes:

UserManagementBase, UserManagementImpl

public interface UserManagement

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserManagement.RegistrationType Possible registration types.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANONYMIZE_USER_PREFIX Prefix for user aliases for anonymized users.

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	changeAlias(Long userId, String newAlias) Method to change the users alias.
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 emailConfirmationRequired, boolean managerConfirmationRequired) Create a user based on the parameters.
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	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 emailOrAlias) find user by email or alias
User	findUserByExternalUserId(String externalUserId, String systemId) Find the user by the external system specification
User	findUserByUserId(Long userId) Deprecated. Use getUserById(Long, Converter) instead.
User	findUserByUserId(Long userId, boolean loadExternalAuthentications) Find a user by the its id.
List<User>	findUsersByRole(UserRole userRole, 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()
long	getActiveUserCount(String systemId, UserRole role) Get the number of users with status ACTIVE.
Set<ExternalUserAuthentication>	getExternalExternalUserAuthentications(long userId)
UserRole[]	getRolesOfUser(Long userId) Returns the roles of a user.
<T> T	getUserById(Long userId, Converter<User,T> converter) Return the details of a user.
boolean	hasExternalAuthentication(long userId, String externalSystemId)
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.
void	registerActivationValidator(UserActivationValidator validator) Register a validator that will be called before the status of a user is set to ACTIVE.
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
void	resetTermsOfUse() Reset the terms of use for all users which have already accepted the terms of use.
void	sendReminderMails()
User	unlockUser(String securityCode) Unlocks the user for the given security code.
void	unregisterActivationValidator(UserActivationValidator validator) Unregister a previously registered validator.
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.
void	updateUserTags(Long userId, Set<TagTO> tags) Updates the tags of the given user.

Field Detail

ANONYMIZE_USER_PREFIX

static final String ANONYMIZE_USER_PREFIX

Prefix for user aliases for anonymized users.

See Also:

Constant Field Values

Method Detail

acceptTermsOfUse

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

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.

Parameters:

userId - ID of the user whose ID should be accepted

Throws:

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

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

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

anonymizeUser

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.

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

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

Assign the user role to the user

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

changeAlias

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.

changeEmailAddress

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

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

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

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

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 anonymizeUser(Long, Long[], boolean) or permanentlyDisableUser(Long, Long[], boolean).

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

void confirmNewEmailAddress(String securityCode)
                     throws SecurityCodeNotFoundException,
                            EmailAlreadyExistsException

Confirms the new email address.

Parameters:

securityCode - The security code.

Throws:

SecurityCodeNotFoundException

EmailAlreadyExistsException

confirmUser

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

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

Throws:

SecurityCodeNotFoundException

EmailValidationException

EmailAlreadyExistsException

AliasAlreadyExistsException

PasswordValidationException

InvalidUserStatusTransitionException

ExternalUserPasswordChangeNotAllowedException

Since:

3.5

createOrUpdateExternalUser

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

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.

Parameters:

userVO - VO with details of the user to create

Returns:

the modified user

Throws:

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

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

EmailValidationException - in case the email address is not valid

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

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

UserActivationValidationException - in case the user cannot be updated

PermanentIdMissmatchException

createUser

User createUser(UserVO user,
                boolean emailConfirmationRequired,
                boolean managerConfirmationRequired)
         throws EmailAlreadyExistsException,
                EmailValidationException,
                AliasAlreadyExistsException,
                PasswordValidationException

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

Parameters:

user - the VO describing the user to create

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

managerConfirmationRequired - 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

Since:

3.5

findNotDeletedUsers

Collection<User> findNotDeletedUsers(boolean excludeSystemUsers)

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

User findUser(UserIdentification userIdentification)

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

Parameters:

userIdentification - the identification

Returns:

the user found

findUser

User findUser(UserIdentification userIdentification,
              boolean loadExternalAuthentications)

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

findUserByAlias

User findUserByAlias(String alias)

Find the User by the given alias s

Parameters:

alias - the alias

Returns:

the user found

findUserByEmail

User findUserByEmail(String email)

Find a user by the email address

Parameters:

email - address to search for.

findUserByEmailAlias

User findUserByEmailAlias(String emailOrAlias)

find user by email or alias

Parameters:

emailOrAlias - May be a user alias or email address

findUserByExternalUserId

User findUserByExternalUserId(String externalUserId,
                              String systemId)

Find the user by the external system specification

findUserByUserId

@Deprecated
User findUserByUserId(Long userId)

Deprecated. Use getUserById(Long, Converter) instead.

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

Parameters:

userId - Id of the user to find.

findUserByUserId

User findUserByUserId(Long userId,
                      boolean loadExternalAuthentications)

Find a user by the its id.
Use 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

List<User> findUsersByRole(UserRole userRole,
                           UserStatus status)

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

generateUniqueAlias

String generateUniqueAlias(String externalUserName,
                           String emailAddress)

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

long getActiveUserCount()

Returns:

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

getActiveUserCount

long getActiveUserCount(String systemId,
                        UserRole role)

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

@Transactional(readOnly=true)
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.

getRolesOfUser

UserRole[] getRolesOfUser(Long userId)

Returns the roles of a user.

Parameters:

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

Returns:

Array of the users roles.

getUserById

<T> T getUserById(Long userId,
                  Converter<User,T> converter)

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

hasExternalAuthentication

@Transactional(readOnly=true)
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

Since:

3.5

inviteUserToBlog

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

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

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

Throws:

EmailValidationException

EmailAlreadyExistsException

AliasAlreadyExistsException

PermanentIdMissmatchException

AuthorizationException

permanentlyDisableUser

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.

Throws:

AuthorizationException

NoClientManagerLeftException

UserDeletionDisabledException

InvalidUserStatusTransitionException

NoBlogManagerLeftException

registerActivationValidator

void registerActivationValidator(UserActivationValidator validator)

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

registerUser

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

Method to register an user via email address.

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

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

Remove a role from a user

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

resetPermanentId

void resetPermanentId(String systemId)
               throws AuthorizationException

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

Throws:

AuthorizationException

resetTermsOfUse

void resetTermsOfUse()
              throws AuthorizationException

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

void sendReminderMails()

unlockUser

User unlockUser(String securityCode)
         throws SecurityCodeNotFoundException

Unlocks the user for the given security code.

Parameters:

securityCode - The code, which user should be unlocked.

Returns:

The unlocked user.

Throws:

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

unregisterActivationValidator

void unregisterActivationValidator(UserActivationValidator validator)

Unregister a previously registered validator.

Parameters:

validator - the validator to remove

updateExternalUser

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

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.

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

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

UserActivationValidationException - in case the user cannot be activated

updateLanguage

void updateLanguage(Long userId,
                    String languageCode)

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

Parameters:

userId - The user to update.

languageCode - The language to set.

updateUserTags

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.