com.communote.server.core.external

Class BlogRightsSynchronizer

java.lang.Object

com.communote.server.core.external.BlogRightsSynchronizer

public class BlogRightsSynchronizer
extends Object

Synchronizes the members of a given topic on the behalf of an external system.

Note: this class is not thread-safe

Author:

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

Constructor Summary

Constructors

Constructor and Description
BlogRightsSynchronizer(Long blogId, String externalSystemId)

Method Summary

Modifier and Type	Method and Description
void	mergeRights(List<ExternalTopicRoleTO> rolesToSetOrUpdate, List<ExternalTopicRoleTO> rolesToRemove) Synchronize blog rights for an external system by merging them with the existing rights.
void	replaceRights(List<ExternalTopicRoleTO> rolesToSet) Synchronize the members of the blog by replacing the existing member roles that were assigned for the external system with the provided members and there roles.
void	replaceRights(String externalObjectId, Map<String,BlogRole> externalUserRoles, Map<String,BlogRole> externalGroupRoles) Synchronize the members of the blog by replacing the existing member roles that were assigned for the external system with the provided members and there roles.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlogRightsSynchronizer

public BlogRightsSynchronizer(Long blogId,
                              String externalSystemId)

Parameters:

blogId - identifier of the blog whose members should be replaced

externalSystemId - external system identifier

Method Detail

mergeRights

public void mergeRights(List<ExternalTopicRoleTO> rolesToSetOrUpdate,
                        List<ExternalTopicRoleTO> rolesToRemove)
                 throws BlogAccessException,
                        BlogNotFoundException

Synchronize blog rights for an external system by merging them with the existing rights. New entities will be added and existing will be updated.

Parameters:

rolesToSetOrUpdate - collection of entities and roles to add or update

rolesToRemove - optional collection of entities to remove from the blog. If an entity is also contained in the rolesToSetOrUpdate it will still be removed. The role member of the TO is ignored.

Throws:

BlogAccessException - in case the current user is not allowed to modify the blog access rights for the external system

BlogNotFoundException - in case the blog does not exist

replaceRights

public void replaceRights(List<ExternalTopicRoleTO> rolesToSet)
                   throws BlogAccessException,
                          BlogNotFoundException

Synchronize the members of the blog by replacing the existing member roles that were assigned for the external system with the provided members and there roles. Entities assigned to the blog on behalf of the external system that are not contained in the input will be removed.

Parameters:

rolesToSet - collection of entities and roles to add or update

Throws:

BlogAccessException - in case the current user is not allowed to modify the blog access rights for the external system

BlogNotFoundException - in case the blog does not exist

replaceRights

public void replaceRights(String externalObjectId,
                          Map<String,BlogRole> externalUserRoles,
                          Map<String,BlogRole> externalGroupRoles)
                   throws BlogAccessException,
                          BlogNotFoundException

Synchronize the members of the blog by replacing the existing member roles that were assigned for the external system with the provided members and there roles. Entities assigned to the blog on behalf of the external system that are not contained in the input will be removed.

Parameters:

externalObjectId - identifier of an external object that has to be assigned to the blog. If the external object is not assigned the roles won't be synchronized.

externalUserRoles - mapping from the user identifier in the external system to the role to assign

externalGroupRoles - mapping from the group identifier in the external system to the role to assign

Throws:

BlogAccessException - in case the current user is not allowed to modify the blog access rights for the external system

BlogNotFoundException - in case the blog does not exist