com.communote.server.core.user

Interface UserGroupMemberManagement

All Known Implementing Classes:

UserGroupMemberManagementBase, UserGroupMemberManagementImpl

public interface UserGroupMemberManagement

Management for group memberships.

Author:

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

Method Summary

Modifier and Type	Method and Description
void	addGroup(Long targetGroupId, Long groupId) Add a group to a group if it is not already contained.
void	addUser(Long groupId, Long userId) Add a user to a group
void	addUserForExternal(Long groupId, Long userId, String externalSystemId) Adds a user to an external group.
boolean	containsEntityDirectly(Long groupId, Long entityId) Returns true if the group or user is a direct member of the group.
boolean	containsUser(Long groupId, Long userId) Returns true if the user is a direct or indirect member of the group.
boolean	containsUserDirectly(Long groupId, Long userId) Returns true if the user is a direct member of the group.
int	countMembers(Long groupId) Return the number of direct members of a group.
List<UserData>	getUsersOfGroup(Long groupId) Return all users who are 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.
void	removeEntityFromGroup(Long groupId, Long entityId) This method removes an entity from a group.
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.
void	removeGroupFromAllGroups(Long groupId) Remove a group from all groups it is a member of.
void	removeUserForExternal(Long groupId, Long userId, String externalSystemId) Removes a user from an external group.
void	removeUserFromAllGroups(Long userId)

Method Detail

addGroup

void addGroup(Long targetGroupId,
              Long groupId)
       throws GroupOperationNotPermittedException,
              GroupNotFoundException,
              CantAddParentAsChildException,
              AuthorizationException

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

Parameters:

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

groupId - ID of the group to add

Throws:

GroupOperationNotPermittedException - in case the target group is an external group

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

AuthorizationException - in case the current user is not client manager

addUser

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

Add a user to a group

Parameters:

groupId - the ID of the group to add the user to

userId - the ID of the user to add

Throws:

GroupNotFoundException - in case the group does not exist

UserNotFoundException - in case the user does not exist

GroupOperationNotPermittedException - in case the group is an external group

AuthorizationException - in case the current user is not client manager

addUserForExternal

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

Adds a user to an external group. The external group must have an externalSystemId that is equal to the value of the externalSystemId parameter.

Parameters:

groupId - the ID of the external group to add the user to

userId - the ID of the user to add

externalSystemId - the ID of the external system the group should belong to

Throws:

GroupNotFoundException - in case the group does not exist

UserNotFoundException - in case the user does not exist

GroupOperationNotPermittedException - in case the group is not a group from the external system identified by the externalSystemId

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

containsEntityDirectly

boolean containsEntityDirectly(Long groupId,
                               Long entityId)
                        throws GroupNotFoundException

Returns true if the group or user is a direct member of the group.

Throws:

GroupNotFoundException

containsUser

boolean containsUser(Long groupId,
                     Long userId)
              throws GroupNotFoundException

Returns true if the user is a direct or indirect member of the group.

Throws:

GroupNotFoundException

containsUserDirectly

boolean containsUserDirectly(Long groupId,
                             Long userId)
                      throws GroupNotFoundException

Returns true if the user is a direct member of the group.

Throws:

GroupNotFoundException

countMembers

int countMembers(Long groupId)

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

List<UserData> getUsersOfGroup(Long groupId)
                        throws GroupNotFoundException

Return all users who are direct members of a group.

Parameters:

groupId - Id of the group.

Returns:

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

Throws:

GroupNotFoundException - in case the group does not exist

getUsersOfGroup

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

removeEntityFromGroup

void removeEntityFromGroup(Long groupId,
                           Long entityId)
                    throws GroupOperationNotPermittedException,
                           GroupNotFoundException

This method removes an entity from a group.

Throws:

GroupOperationNotPermittedException

GroupNotFoundException

removeGroupFromAllExternalGroups

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

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

removeGroupFromAllGroups

void removeGroupFromAllGroups(Long groupId)
                       throws GroupNotFoundException,
                              AuthorizationException

Remove a group from all groups it is a member of.

Parameters:

groupId - The id of the group to remove

Throws:

GroupNotFoundException - in case the group does not exist

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

removeUserForExternal

void removeUserForExternal(Long groupId,
                           Long userId,
                           String externalSystemId)
                    throws AuthorizationException

Removes a user from an external group. The external group must have an externalSystemId that is equal to the value of the externalSystemId parameter. If the group does not exist or the user is not a member of that group nothing will happen.

Parameters:

groupId - the ID of the external group

userId - the ID of the user to remove

externalSystemId - the ID of the external system the group originated from

Throws:

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

removeUserFromAllGroups

void removeUserFromAllGroups(Long userId)
                      throws UserNotFoundException

Throws:

UserNotFoundException