com.communote.server.service

Class UserService

java.lang.Object

com.communote.server.service.UserService

public class UserService
extends Object

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserService.UserServiceRetrievalFlag These flags allow to control the retrieval process of a user in the UserService.

Constructor Summary

Constructors

Constructor and Description
UserService()

Method Summary

Modifier and Type	Method and Description
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.
Collection<ExternalUserRepository>	getActiveUserRepositories() Returns all active user repositories.
ExternalUserRepository	getAvailableUserRepository(String systemId) Get the available repository for the given system id.
Collection<StringPropertyTO>	getExternalLoginProperties(Long userId, ExternalUserAuthentication externalUserAuthentication) External Repos can return additional properties that will be included e.g.
ExternalSystemConfiguration	getExternalSystemConfiguration(String externalSystemId)
ExternalUserRepository	getExternalUserRepository(String externalSystemId) Get the external user repository based on the repository mode.
Group	getGroup(String alias) Get a group by its alias.
Group	getGroup(String externalGroupId, String externalSystemId) Get group specific from external system
Collection<UserProfileFields>	getImmutableProfileFieldsOfUser(Long userId) Get the names of the user profile fields that cannot be changed by the user.
Collection<ExternalUserRepository>	getRegistedExternalUserRepositories()
User	getUser(String alias) Get a user by its alias.
User	getUser(String externalUserId, String externalSystemId) Get a user that originates from a specific external system.
User	getUser(UserIdentification userIdentification, UserService.UserServiceRetrievalFlag... flags) Get a user specified by the given UserIdentification.
boolean	hasRole(Long userId, UserRole role) Return whether the provided user has the given role.
boolean	isUserRepositoryActive(String externalSystemId)
void	registerRepository(String externalSystemId, ExternalUserRepository externalUserRepository) Register an external user repository.
void	setDefaultRepositories(Map<String,ExternalUserRepository> defaultRepositories) Set the default repositories
void	unregisterRepository(String externalSystemId) Unregister an external user repository if is not an default repository

Methods inherited from class java.lang.Object

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

Constructor Detail

UserService

public UserService()

Method Detail

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.

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.

getActiveUserRepositories

public Collection<ExternalUserRepository> getActiveUserRepositories()

Returns all active user repositories.

Returns:

List of user repositories.

getAvailableUserRepository

public ExternalUserRepository getAvailableUserRepository(String systemId)

Get the available repository for the given system id. Available means it is not necessarily an active and properly configured repository.

Parameters:

systemId - the system id to get the repository of

Returns:

the external user repository, can be null

getExternalLoginProperties

public Collection<StringPropertyTO> getExternalLoginProperties(Long userId,
                                                               ExternalUserAuthentication externalUserAuthentication)
                                                        throws AuthorizationException

External Repos can return additional properties that will be included e.g. in the rest resource

Parameters:

userId - the id of the user the authentication is for

externalUserAuthentication - the authentication to get additional properties for

Throws:

AuthorizationException

getExternalSystemConfiguration

public ExternalSystemConfiguration getExternalSystemConfiguration(String externalSystemId)

getExternalUserRepository

public ExternalUserRepository getExternalUserRepository(String externalSystemId)

Get the external user repository based on the repository mode. In "strict" mode always the primary repository will be returned. If the requested repository is not active null is returned.

Parameters:

externalSystemId - identifier of the external system. Can be null to get the primary repository.

Returns:

the repository or null if there is no matching repository or the repository is not active

See Also:

ClientProperty.REPOSITORY_MODE

getGroup

public Group getGroup(String alias)
               throws GroupNotFoundException

Get a group by its alias. The group will be searched in the local database. If not found, the primary repository will be queried.

Parameters:

alias - the alias of the group

Returns:

the found group

Throws:

GroupNotFoundException - in case the group was not found

getGroup

public Group getGroup(String externalGroupId,
                      String externalSystemId)
               throws GroupNotFoundException

Get group specific from external system

Parameters:

externalGroupId - group identifier of the external system

externalSystemId - identifier of the external system

Returns:

Group the found group, never null

Throws:

GroupNotFoundException - in case the group can not be found

getImmutableProfileFieldsOfUser

public Collection<UserProfileFields> getImmutableProfileFieldsOfUser(Long userId)

Get the names of the user profile fields that cannot be changed by the user. The immutable profile fields depend on the external authentication the user has and the external systems that are active. If a primary external system is defined only this system is used to determine the immutable fields.

Parameters:

userId - the id of user to get the fixed fields for

Returns:

the fields

getRegistedExternalUserRepositories

public Collection<ExternalUserRepository> getRegistedExternalUserRepositories()

getUser

public User getUser(String alias)
             throws UserNotFoundException

Get a user by its alias. This will first look in the internal database for a matching user. If there is no matching use but an external system is configured and it is allowed to automatically create users from external systems, it will be tried to find and create the user with the details provided by the external system.

Parameters:

alias - the alias of the user

Returns:

the existing user

Throws:

UserNotFoundException - in case there is no matching user or a matching external user cannot be created

getUser

public User getUser(String externalUserId,
                    String externalSystemId)
             throws UserNotFoundException

Get a user that originates from a specific external system. If there isn't a matching user but the provided external system is activated and it is allowed to automatically create users from external systems, it will be tried to find and create the user with the details provided by the external system.

Parameters:

externalUserId - identifier of the user in the external system

externalSystemId - identifier of the external system

Returns:

the existing user

Throws:

UserNotFoundException - in case there is no matching user or a matching external user cannot be created

getUser

public User getUser(UserIdentification userIdentification,
                    UserService.UserServiceRetrievalFlag... flags)
             throws UserNotFoundException

Get a user specified by the given UserIdentification. Depending on configuration and retrieval flags this can lead to a lookup of the user in an external repository.

Parameters:

userIdentification - identification of the user

flags - optional flags to configure how the user should be retrieved

Returns:

the user

Throws:

UserNotFoundException - in case the user does not exist or in case the user cannot be created or updated after a successful lookup in an external repository

hasRole

public boolean hasRole(Long userId,
                       UserRole role)

Return whether the provided user has the given role.

Parameters:

userId - the ID of the user to test

role - the role to test for

Returns:

true if the user exists and has the role, false otherwise

isUserRepositoryActive

public boolean isUserRepositoryActive(String externalSystemId)

registerRepository

public void registerRepository(String externalSystemId,
                               ExternalUserRepository externalUserRepository)

Register an external user repository. If there is already a repository for the externalSystemId it will be replaced.

Parameters:

externalSystemId - identifier of the external repository (LDAP, Confluence, ...)

externalUserRepository - the repository to register

setDefaultRepositories

public void setDefaultRepositories(Map<String,ExternalUserRepository> defaultRepositories)

Set the default repositories

Parameters:

defaultRepositories - map of repositories

unregisterRepository

public void unregisterRepository(String externalSystemId)

Unregister an external user repository if is not an default repository

Parameters:

externalSystemId - of the external repository (LDAP, Confluence, Sharepoint, ...)