com.communote.server.core.user

Class UserGroupMemberManagementBase

java.lang.Object

com.communote.server.core.user.UserGroupMemberManagementBase

All Implemented Interfaces:

UserGroupMemberManagement

Direct Known Subclasses:

UserGroupMemberManagementImpl

@Transactional(propagation=REQUIRED)
public abstract class UserGroupMemberManagementBase
extends Object
implements UserGroupMemberManagement

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

Author:

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

See Also:

UserGroupMemberManagement

Constructor Summary

Constructors

Constructor and Description
UserGroupMemberManagementBase()

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.
protected Principal	getPrincipal() Gets the current principal if one has been set, otherwise returns null.
List<UserData>	getUsersOfGroup(Long groupId) Return all users who are direct members of a group.
protected abstract void	handleAddGroup(Long targetGroupId, Long groupId) Add a group to a group if it is not already contained.
protected abstract void	handleAddUser(Long groupId, Long userId) Performs the core logic for addUser(Long, Long)
protected abstract void	handleAddUserForExternal(Long groupId, Long userId, String externalSystemId) Performs the core logic for addUserForExternal(Long, Long, String)
protected abstract boolean	handleContainsEntityDirectly(Long groupId, Long entityId) Performs the core logic for containsEntityDirectly(Long, Long)
protected abstract boolean	handleContainsUser(Long groupId, Long userId) Performs the core logic for containsUser(Long, Long)
protected abstract boolean	handleContainsUserDirectly(Long groupId, Long userId) Performs the core logic for containsUserDirectly(Long, Long)
protected abstract List<UserData>	handleGetUsersOfGroup(Long groupId) Performs the core logic for getUsersOfGroup(Long)
protected abstract void	handleRemoveEntityFromGroup(Long groupId, Long entityId) Performs the core logic for removeEntityFromGroup(Long, Long)
protected abstract void	handleRemoveGroupFromAllGroups(Long entityId) Performs the core logic for removeGroupFromAllGroups(Long)
protected abstract void	handleRemoveUserForExternal(Long groupId, Long userId, String externalSystemId) Performs the core logic for removeUserForExternal(Long, Long, String)
protected abstract void	handleRemoveUserFromAllGroups(Long userId) Performs the core logic for removeUserFromAllGroups(Long)
void	removeEntityFromGroup(Long groupId, Long entityId) This method removes an entity from a group.
void	removeGroupFromAllGroups(Long entityId) 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)

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.UserGroupMemberManagement

countMembers, getUsersOfGroup, removeGroupFromAllExternalGroups

Constructor Detail

UserGroupMemberManagementBase

public UserGroupMemberManagementBase()

Method Detail

addGroup

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

Description copied from interface: UserGroupMemberManagement

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

Specified by:

addGroup in interface UserGroupMemberManagement

Parameters:

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

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

addUser

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

Description copied from interface: UserGroupMemberManagement

Add a user to a group

Specified by:

addUser in interface UserGroupMemberManagement

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

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

Description copied from interface: UserGroupMemberManagement

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

Specified by:

addUserForExternal in interface UserGroupMemberManagement

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

@Transactional(readOnly=true)
public boolean containsEntityDirectly(Long groupId,
                                                                    Long entityId)
                                                             throws GroupNotFoundException

Description copied from interface: UserGroupMemberManagement

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

Specified by:

containsEntityDirectly in interface UserGroupMemberManagement

Throws:

GroupNotFoundException

See Also:

UserGroupMemberManagement.containsEntityDirectly(Long, Long)

containsUser

@Transactional(readOnly=true)
public boolean containsUser(Long groupId,
                                                          Long userId)
                                                   throws GroupNotFoundException

Description copied from interface: UserGroupMemberManagement

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

Specified by:

containsUser in interface UserGroupMemberManagement

Throws:

GroupNotFoundException

See Also:

UserGroupMemberManagement.containsUser(Long, Long)

containsUserDirectly

@Transactional(readOnly=true)
public boolean containsUserDirectly(Long groupId,
                                                                  Long userId)
                                                           throws GroupNotFoundException

Description copied from interface: UserGroupMemberManagement

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

Specified by:

containsUserDirectly in interface UserGroupMemberManagement

Throws:

GroupNotFoundException

See Also:

UserGroupMemberManagement.containsUserDirectly(Long, Long)

getPrincipal

protected Principal getPrincipal()

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

Returns:

the current principal

getUsersOfGroup

@Transactional(readOnly=true)
public List<UserData> getUsersOfGroup(Long groupId)
                                                             throws GroupNotFoundException

Description copied from interface: UserGroupMemberManagement

Return all users who are direct members of a group.

Specified by:

getUsersOfGroup in interface UserGroupMemberManagement

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

See Also:

UserGroupMemberManagement.getUsersOfGroup(Long)

handleAddGroup

protected abstract void handleAddGroup(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

handleAddUser

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

Performs the core logic for addUser(Long, Long)

Throws:

AuthorizationException - in case the current user is not client manager

GroupNotFoundException

UserNotFoundException

GroupOperationNotPermittedException

handleAddUserForExternal

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

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

Throws:

GroupNotFoundException

UserNotFoundException

AuthorizationException

handleContainsEntityDirectly

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

Performs the core logic for containsEntityDirectly(Long, Long)

Throws:

GroupNotFoundException

handleContainsUser

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

Performs the core logic for containsUser(Long, Long)

Throws:

GroupNotFoundException

handleContainsUserDirectly

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

Performs the core logic for containsUserDirectly(Long, Long)

Throws:

GroupNotFoundException

handleGetUsersOfGroup

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

Performs the core logic for getUsersOfGroup(Long)

Throws:

GroupNotFoundException

handleRemoveEntityFromGroup

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

Performs the core logic for removeEntityFromGroup(Long, Long)

Throws:

GroupOperationNotPermittedException

GroupNotFoundException

handleRemoveGroupFromAllGroups

protected abstract void handleRemoveGroupFromAllGroups(Long entityId)
                                                throws GroupNotFoundException,
                                                       AuthorizationException

Performs the core logic for removeGroupFromAllGroups(Long)

Throws:

AuthorizationException

GroupNotFoundException

handleRemoveUserForExternal

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

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

Throws:

AuthorizationException

handleRemoveUserFromAllGroups

protected abstract void handleRemoveUserFromAllGroups(Long userId)
                                               throws UserNotFoundException

Performs the core logic for removeUserFromAllGroups(Long)

Throws:

UserNotFoundException

removeEntityFromGroup

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

Description copied from interface: UserGroupMemberManagement

This method removes an entity from a group.

Specified by:

removeEntityFromGroup in interface UserGroupMemberManagement

Throws:

GroupOperationNotPermittedException

GroupNotFoundException

See Also:

UserGroupMemberManagement.removeEntityFromGroup(Long, Long)

removeGroupFromAllGroups

public void removeGroupFromAllGroups(Long entityId)
                              throws GroupNotFoundException,
                                     AuthorizationException

Description copied from interface: UserGroupMemberManagement

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

Specified by:

removeGroupFromAllGroups in interface UserGroupMemberManagement

Parameters:

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

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

Description copied from interface: UserGroupMemberManagement

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.

Specified by:

removeUserForExternal in interface UserGroupMemberManagement

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

public void removeUserFromAllGroups(Long userId)
                             throws UserNotFoundException

Specified by:

removeUserFromAllGroups in interface UserGroupMemberManagement

Throws:

UserNotFoundException

See Also:

UserGroupMemberManagement.removeUserFromAllGroups(Long)