com.communote.server.core.user

Class UserGroupMemberManagementImpl<EntityListItem>

java.lang.Object

com.communote.server.core.user.UserGroupMemberManagementBase

com.communote.server.core.user.UserGroupMemberManagementImpl<EntityListItem>

Type Parameters:

EntityListItem -

All Implemented Interfaces:

UserGroupMemberManagement

@Service(value="userGroupMemberManagement")
public class UserGroupMemberManagementImpl<EntityListItem>
extends UserGroupMemberManagementBase

Author:

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

See Also:

UserGroupMemberManagement

Constructor Summary

Constructors

Constructor and Description
UserGroupMemberManagementImpl()

Method Summary

Modifier and Type	Method and Description
int	countMembers(Long groupId) Return the number of direct members of a group.
Collection<Long>	getUsersOfGroup(Long groupId, String externalSystemId) Return all IDs of users who are direct members of a given group.
protected void	handleAddGroup(Long parentGroupId, Long childGroupId) Add a group to a group if it is not already contained.
protected void	handleAddUser(Long groupId, Long userId) Performs the core logic for UserGroupMemberManagementBase.addUser(Long, Long)
protected void	handleAddUserForExternal(Long groupId, Long userId, String externalSystemId) Performs the core logic for UserGroupMemberManagementBase.addUserForExternal(Long, Long, String)
protected boolean	handleContainsEntityDirectly(Long groupId, Long entityId) Performs the core logic for UserGroupMemberManagementBase.containsEntityDirectly(Long, Long)
protected boolean	handleContainsUser(Long groupId, Long userId) Performs the core logic for UserGroupMemberManagementBase.containsUser(Long, Long)
protected boolean	handleContainsUserDirectly(Long groupId, Long userId) Performs the core logic for UserGroupMemberManagementBase.containsUserDirectly(Long, Long)
protected List<UserData>	handleGetUsersOfGroup(Long groupId) Performs the core logic for UserGroupMemberManagementBase.getUsersOfGroup(Long)
protected void	handleRemoveEntityFromGroup(Long groupId, Long entityId) Performs the core logic for UserGroupMemberManagementBase.removeEntityFromGroup(Long, Long)
protected void	handleRemoveGroupFromAllGroups(Long groupId) Performs the core logic for UserGroupMemberManagementBase.removeGroupFromAllGroups(Long)
protected void	handleRemoveUserForExternal(Long groupId, Long userId, String externalSystemId) Performs the core logic for UserGroupMemberManagementBase.removeUserForExternal(Long, Long, String)
protected void	handleRemoveUserFromAllGroups(Long userId) Performs the core logic for UserGroupMemberManagementBase.removeUserFromAllGroups(Long)
void	removeGroupFromAllExternalGroups(Long groupId, Collection<Long> groupIdsToIgnore) Remove an external group from all external groups of the same external system that contain this group as a direct member.

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

addGroup, addUser, addUserForExternal, containsEntityDirectly, containsUser, containsUserDirectly, getPrincipal, getUsersOfGroup, removeEntityFromGroup, removeGroupFromAllGroups, removeUserForExternal, removeUserFromAllGroups

Methods inherited from class java.lang.Object

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

Constructor Detail

UserGroupMemberManagementImpl

public UserGroupMemberManagementImpl()

Method Detail

countMembers

@Transactional(readOnly=true)
public int countMembers(Long groupId)

Description copied from interface: UserGroupMemberManagement

Return the number of direct members of a group.

Parameters:

groupId - the ID of the group whose members should be counted

Returns:

the number of direct members

getUsersOfGroup

@Transactional(readOnly=true)
public Collection<Long> getUsersOfGroup(Long groupId,
                                                                      String externalSystemId)
                                                               throws GroupNotFoundException

Return all IDs of users who are direct members of a given group.

Parameters:

groupId - Id of the group.

externalSystemId - If set, only users of the given external system are considered.

Returns:

a list of all user IDs who are direct members of the given group.

Throws:

GroupNotFoundException - in case the group does not exist

handleAddGroup

protected void handleAddGroup(Long parentGroupId,
                              Long childGroupId)
                       throws GroupNotFoundException,
                              CantAddParentAsChildException,
                              AuthorizationException,
                              GroupOperationNotPermittedException

Description copied from class: UserGroupMemberManagementBase

Add a group to a group if it is not already contained.

Specified by:

handleAddGroup in class UserGroupMemberManagementBase

Parameters:

parentGroupId - ID of the target group the other group should be added to

childGroupId - ID of the group to add

Throws:

GroupNotFoundException - in case the target group or the group to add does not exist

CantAddParentAsChildException - in case adding the group would lead to a cyclic group hierarchy

GroupOperationNotPermittedException - in case the target group is an external group

AuthorizationException - in case the current user is not client manager

handleAddUser

protected void handleAddUser(Long groupId,
                             Long userId)
                      throws GroupNotFoundException,
                             UserNotFoundException,
                             AuthorizationException,
                             GroupOperationNotPermittedException

Performs the core logic for UserGroupMemberManagementBase.addUser(Long, Long)

Specified by:

handleAddUser in class UserGroupMemberManagementBase

Throws:

AuthorizationException - in case the current user is not client manager

GroupNotFoundException

UserNotFoundException

GroupOperationNotPermittedException

handleAddUserForExternal

protected void handleAddUserForExternal(Long groupId,
                                        Long userId,
                                        String externalSystemId)
                                 throws GroupNotFoundException,
                                        UserNotFoundException,
                                        AuthorizationException

Description copied from class: UserGroupMemberManagementBase

Performs the core logic for UserGroupMemberManagementBase.addUserForExternal(Long, Long, String)

Specified by:

handleAddUserForExternal in class UserGroupMemberManagementBase

Throws:

GroupNotFoundException

UserNotFoundException

AuthorizationException

handleContainsEntityDirectly

protected boolean handleContainsEntityDirectly(Long groupId,
                                               Long entityId)
                                        throws GroupNotFoundException

Performs the core logic for UserGroupMemberManagementBase.containsEntityDirectly(Long, Long)

Specified by:

handleContainsEntityDirectly in class UserGroupMemberManagementBase

Throws:

GroupNotFoundException

handleContainsUser

protected boolean handleContainsUser(Long groupId,
                                     Long userId)
                              throws GroupNotFoundException

Performs the core logic for UserGroupMemberManagementBase.containsUser(Long, Long)

Specified by:

handleContainsUser in class UserGroupMemberManagementBase

Throws:

GroupNotFoundException

handleContainsUserDirectly

protected boolean handleContainsUserDirectly(Long groupId,
                                             Long userId)
                                      throws GroupNotFoundException

Performs the core logic for UserGroupMemberManagementBase.containsUserDirectly(Long, Long)

Specified by:

handleContainsUserDirectly in class UserGroupMemberManagementBase

Throws:

GroupNotFoundException

handleGetUsersOfGroup

protected List<UserData> handleGetUsersOfGroup(Long groupId)
                                        throws GroupNotFoundException

Performs the core logic for UserGroupMemberManagementBase.getUsersOfGroup(Long)

Specified by:

handleGetUsersOfGroup in class UserGroupMemberManagementBase

Throws:

GroupNotFoundException

handleRemoveEntityFromGroup

protected void handleRemoveEntityFromGroup(Long groupId,
                                           Long entityId)
                                    throws GroupNotFoundException,
                                           GroupOperationNotPermittedException

Performs the core logic for UserGroupMemberManagementBase.removeEntityFromGroup(Long, Long)

Specified by:

handleRemoveEntityFromGroup in class UserGroupMemberManagementBase

Throws:

GroupNotFoundException - Exception.

GroupOperationNotPermittedException - Exception.

handleRemoveGroupFromAllGroups

protected void handleRemoveGroupFromAllGroups(Long groupId)
                                       throws GroupNotFoundException,
                                              AuthorizationException

Description copied from class: UserGroupMemberManagementBase

Performs the core logic for UserGroupMemberManagementBase.removeGroupFromAllGroups(Long)

Specified by:

handleRemoveGroupFromAllGroups in class UserGroupMemberManagementBase

Throws:

AuthorizationException

GroupNotFoundException

handleRemoveUserForExternal

protected void handleRemoveUserForExternal(Long groupId,
                                           Long userId,
                                           String externalSystemId)
                                    throws AuthorizationException

Description copied from class: UserGroupMemberManagementBase

Performs the core logic for UserGroupMemberManagementBase.removeUserForExternal(Long, Long, String)

Specified by:

handleRemoveUserForExternal in class UserGroupMemberManagementBase

Throws:

AuthorizationException

handleRemoveUserFromAllGroups

protected void handleRemoveUserFromAllGroups(Long userId)

Performs the core logic for UserGroupMemberManagementBase.removeUserFromAllGroups(Long)

Specified by:

handleRemoveUserFromAllGroups in class UserGroupMemberManagementBase

removeGroupFromAllExternalGroups

@Transactional
public void removeGroupFromAllExternalGroups(Long groupId,
                                                            Collection<Long> groupIdsToIgnore)
                                                     throws GroupNotFoundException,
                                                            AuthorizationException

Description copied from interface: UserGroupMemberManagement

Remove an external group from all external groups of the same external system that contain this group as a direct member.

Parameters:

groupId - ID of the external group to remove from the other external groups

groupIdsToIgnore - list of IDs of groups the group should not be removed from. Can be null.

Throws:

GroupNotFoundException - in case the group does not exist

AuthorizationException - in case the current user is not the internal system user