com.atlassian.crowd.directory

Class DbCachingRemoteChangeOperations

java.lang.Object

com.atlassian.crowd.directory.DbCachingRemoteChangeOperations

All Implemented Interfaces:

DirectoryCacheChangeOperations

public class DbCachingRemoteChangeOperations
extends Object
implements DirectoryCacheChangeOperations

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.crowd.directory.DirectoryCacheChangeOperations

DirectoryCacheChangeOperations.AddRemoveSets<T>, DirectoryCacheChangeOperations.GroupShadowingType, DirectoryCacheChangeOperations.GroupsToAddUpdateReplace

Constructor Summary

Constructors

Constructor and Description
DbCachingRemoteChangeOperations(DirectoryDao directoryDao, RemoteDirectory remoteDirectory, InternalRemoteDirectory internalDirectory, SynchronisationStatusManager synchronisationStatusManager, MultiEventPublisher eventPublisher, UserDao userDao, GroupDao groupDao, GroupActionStrategy groupActionStrategy)

Method Summary

Modifier and Type	Method and Description
void	addGroupMembershipsForGroup(Group parentGroup, Collection<String> groupsToAdd)
void	addGroups(Set<GroupTemplate> groupsToAdd)
void	addGroupToGroup(String childGroup, String parentGroup)
void	addOrUpdateCachedGroup(Group group)
void	addOrUpdateCachedUser(User user)
void	addUserMembershipsForGroup(Group group, Set<String> usersToAdd)
void	addUsers(Set<UserTemplateWithCredentialAndAttributes> usersToAdd)
void	addUserToGroup(String username, String groupName)
void	applySyncingGroupAttributes(String groupName, Set<String> deletedAttributes, Map<String,Set<String>> storedAttributes) Removes any syncing group attributes listed in deletedAttributes, and store any that are listed in storedAttributes If any non-syncing attributes are included, they will be ignored
void	applySyncingUserAttributes(String userName, Set<String> deletedAttributes, Map<String,Set<String>> storedAttributes) Removes any syncing user attributes listed in deletedAttributes, and store any that are listed in storedAttributes If any non-syncing attributes are included, they will be ignored
void	deleteCachedGroup(String groupName)
void	deleteCachedGroups(Set<String> groupnames)
void	deleteCachedGroupsByGuids(Set<String> guids)
void	deleteCachedGroupsNotIn(GroupType groupType, List<? extends Group> remoteGroups, Date syncStartDate)
void	deleteCachedGroupsNotInByExternalId(Collection<? extends Group> remoteGroups, Date syncStartDate)
void	deleteCachedUser(String username)
void	deleteCachedUsersByGuid(Set<String> guids)
void	deleteCachedUsersNotIn(Collection<? extends User> remoteUsers, Date synchStartDate)
DirectoryCacheChangeOperations.AddRemoveSets<String>	findGroupMembershipForGroupChanges(Group parentGroup, Collection<String> remoteGroups)
Map<String,String>	findGroupsByExternalIds(Set<String> externalIds) Searches the specified directory for group names of groups with the specified external ids
Map<String,String>	findGroupsExternalIdsByNames(Set<String> groupNames) Searches the specified directory for externalIds of groups with the specified names
DirectoryCacheChangeOperations.GroupsToAddUpdateReplace	findGroupsToUpdate(Collection<? extends Group> remoteGroups, Date syncStartDate)
GroupWithAttributes	findGroupWithAttributesByName(String name)
DirectoryCacheChangeOperations.AddRemoveSets<String>	findUserMembershipForGroupChanges(Group group, Collection<String> remoteUsers)
Map<String,String>	findUsersByExternalIds(Set<String> externalIds)
UserWithAttributes	findUserWithAttributesByName(String name)
Set<String>	getAllGroupGuids()
Set<String>	getAllLocalGroupNames()
Set<String>	getAllUserGuids()
protected Directory	getDirectory()
long	getExternalCachedGroupCount()
long	getGroupCount()
long	getUserCount()
AddUpdateSets<UserTemplateWithCredentialAndAttributes,UserTemplate>	getUsersToAddAndUpdate(Collection<? extends User> remoteUsers, Date syncStartDate) Returns the users that need to be added or updated given the list of all remote users.
protected boolean	hasChanged(User remoteUser, User internalUser)
DirectoryCacheChangeOperations.GroupShadowingType	isGroupShadowed(Group remoteGroup) Returns true if the given remote Group should not have its memberships synchronised for any reason.
protected static Map<String,TimestampedUser>	mapUsersByExternalId(Collection<TimestampedUser> users)
void	removeGroupFromGroup(String childGroup, String parentGroup)
void	removeGroupMembershipsForGroup(Group parentGroup, Collection<String> groupsToRemove)
void	removeGroups(Collection<String> groupsToRemove)
void	removeUserFromGroup(String username, String groupName)
void	removeUserMembershipsForGroup(Group group, Set<String> usersToRemove)
void	syncGroupMembershipsAndMembersForGroup(String groupName, Set<String> parentGroupNames, Set<String> childGroupNames)
void	syncGroupMembershipsForUser(String childUsername, Set<String> parentGroupNames)
void	updateGroups(Collection<GroupTemplate> groupsToUpdate)
void	updateUsers(Collection<UserTemplate> usersToUpdate)

Methods inherited from class java.lang.Object

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

Constructor Detail

DbCachingRemoteChangeOperations

public DbCachingRemoteChangeOperations(DirectoryDao directoryDao,
                                       RemoteDirectory remoteDirectory,
                                       InternalRemoteDirectory internalDirectory,
                                       SynchronisationStatusManager synchronisationStatusManager,
                                       MultiEventPublisher eventPublisher,
                                       UserDao userDao,
                                       GroupDao groupDao,
                                       GroupActionStrategy groupActionStrategy)

Method Detail

addUsers

public void addUsers(Set<UserTemplateWithCredentialAndAttributes> usersToAdd)
              throws OperationFailedException

Specified by:

addUsers in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

updateUsers

public void updateUsers(Collection<UserTemplate> usersToUpdate)
                 throws OperationFailedException

Specified by:

updateUsers in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

deleteCachedUsersByGuid

public void deleteCachedUsersByGuid(Set<String> guids)
                             throws OperationFailedException

Specified by:

deleteCachedUsersByGuid in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

deleteCachedUsersNotIn

public void deleteCachedUsersNotIn(Collection<? extends User> remoteUsers,
                                   Date synchStartDate)
                            throws OperationFailedException

Specified by:

deleteCachedUsersNotIn in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

findGroupsToUpdate

public DirectoryCacheChangeOperations.GroupsToAddUpdateReplace findGroupsToUpdate(Collection<? extends Group> remoteGroups,
                                                                                  Date syncStartDate)
                                                                           throws OperationFailedException

Specified by:

findGroupsToUpdate in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

removeGroups

public void removeGroups(Collection<String> groupsToRemove)
                  throws OperationFailedException

Specified by:

removeGroups in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

addGroups

public void addGroups(Set<GroupTemplate> groupsToAdd)
               throws OperationFailedException

Specified by:

addGroups in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

updateGroups

public void updateGroups(Collection<GroupTemplate> groupsToUpdate)
                  throws OperationFailedException

Specified by:

updateGroups in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

deleteCachedGroupsNotIn

public void deleteCachedGroupsNotIn(GroupType groupType,
                                    List<? extends Group> remoteGroups,
                                    Date syncStartDate)
                             throws OperationFailedException

Specified by:

deleteCachedGroupsNotIn in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

deleteCachedGroupsNotInByExternalId

public void deleteCachedGroupsNotInByExternalId(Collection<? extends Group> remoteGroups,
                                                Date syncStartDate)
                                         throws OperationFailedException

Specified by:

deleteCachedGroupsNotInByExternalId in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

deleteCachedGroups

public void deleteCachedGroups(Set<String> groupnames)
                        throws OperationFailedException

Specified by:

deleteCachedGroups in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

deleteCachedGroupsByGuids

public void deleteCachedGroupsByGuids(Set<String> guids)
                               throws OperationFailedException

Specified by:

deleteCachedGroupsByGuids in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

hasChanged

protected boolean hasChanged(User remoteUser,
                             User internalUser)

findUserMembershipForGroupChanges

public DirectoryCacheChangeOperations.AddRemoveSets<String> findUserMembershipForGroupChanges(Group group,
                                                                                              Collection<String> remoteUsers)
                                                                                       throws OperationFailedException

Specified by:

findUserMembershipForGroupChanges in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

removeUserMembershipsForGroup

public void removeUserMembershipsForGroup(Group group,
                                          Set<String> usersToRemove)
                                   throws OperationFailedException

Specified by:

removeUserMembershipsForGroup in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

addUserMembershipsForGroup

public void addUserMembershipsForGroup(Group group,
                                       Set<String> usersToAdd)
                                throws OperationFailedException

Specified by:

addUserMembershipsForGroup in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

findGroupMembershipForGroupChanges

public DirectoryCacheChangeOperations.AddRemoveSets<String> findGroupMembershipForGroupChanges(Group parentGroup,
                                                                                               Collection<String> remoteGroups)
                                                                                        throws OperationFailedException

Specified by:

findGroupMembershipForGroupChanges in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

addGroupMembershipsForGroup

public void addGroupMembershipsForGroup(Group parentGroup,
                                        Collection<String> groupsToAdd)
                                 throws OperationFailedException

Specified by:

addGroupMembershipsForGroup in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

removeGroupMembershipsForGroup

public void removeGroupMembershipsForGroup(Group parentGroup,
                                           Collection<String> groupsToRemove)
                                    throws OperationFailedException

Specified by:

removeGroupMembershipsForGroup in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

getDirectory

protected Directory getDirectory()
                          throws DirectoryNotFoundException

Throws:

DirectoryNotFoundException

isGroupShadowed

public DirectoryCacheChangeOperations.GroupShadowingType isGroupShadowed(Group remoteGroup)
                                                                  throws OperationFailedException

Returns true if the given remote Group should not have its memberships synchronised for any reason.

Specified by:

isGroupShadowed in interface DirectoryCacheChangeOperations

Parameters:

remoteGroup - The Group to test.

Returns:

true if the given remote Group should not have its memberships synchronised for any reason.

Throws:

OperationFailedException - If there is an error trying to find the group in the Internal Directory (should not occur).

getUsersToAddAndUpdate

public AddUpdateSets<UserTemplateWithCredentialAndAttributes,UserTemplate> getUsersToAddAndUpdate(Collection<? extends User> remoteUsers,
                                                                                                  Date syncStartDate)
                                                                                           throws OperationFailedException

Returns the users that need to be added or updated given the list of all remote users. Only the internal users modified before syncStartDate will be updated. This is done to avoid overriding changes made locally to a user after the synchronisation has started.

Specified by:

getUsersToAddAndUpdate in interface DirectoryCacheChangeOperations

Parameters:

remoteUsers - List of all remote users.

syncStartDate - Date and time of the start of the synchronisation. Used to determine which users need to be synchronised. Can be null in which case all the users are synchronised.

Returns:

a pair of Sets of users to update and update.

Throws:

OperationFailedException - if the operation failed for any reason

mapUsersByExternalId

protected static Map<String,TimestampedUser> mapUsersByExternalId(Collection<TimestampedUser> users)

addOrUpdateCachedUser

public void addOrUpdateCachedUser(User user)
                           throws OperationFailedException

Specified by:

addOrUpdateCachedUser in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

deleteCachedUser

public void deleteCachedUser(String username)
                      throws OperationFailedException

Specified by:

deleteCachedUser in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

addOrUpdateCachedGroup

public void addOrUpdateCachedGroup(Group group)
                            throws OperationFailedException

Specified by:

addOrUpdateCachedGroup in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

deleteCachedGroup

public void deleteCachedGroup(String groupName)
                       throws OperationFailedException

Specified by:

deleteCachedGroup in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

addUserToGroup

public void addUserToGroup(String username,
                           String groupName)
                    throws OperationFailedException

Specified by:

addUserToGroup in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

addGroupToGroup

public void addGroupToGroup(String childGroup,
                            String parentGroup)
                     throws OperationFailedException

Specified by:

addGroupToGroup in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

removeUserFromGroup

public void removeUserFromGroup(String username,
                                String groupName)
                         throws OperationFailedException

Specified by:

removeUserFromGroup in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

removeGroupFromGroup

public void removeGroupFromGroup(String childGroup,
                                 String parentGroup)
                          throws OperationFailedException

Specified by:

removeGroupFromGroup in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

syncGroupMembershipsForUser

public void syncGroupMembershipsForUser(String childUsername,
                                        Set<String> parentGroupNames)
                                 throws OperationFailedException

Specified by:

syncGroupMembershipsForUser in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

syncGroupMembershipsAndMembersForGroup

public void syncGroupMembershipsAndMembersForGroup(String groupName,
                                                   Set<String> parentGroupNames,
                                                   Set<String> childGroupNames)
                                            throws OperationFailedException

Specified by:

syncGroupMembershipsAndMembersForGroup in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

findUserWithAttributesByName

public UserWithAttributes findUserWithAttributesByName(String name)
                                                throws UserNotFoundException,
                                                       OperationFailedException

Specified by:

findUserWithAttributesByName in interface DirectoryCacheChangeOperations

Throws:

UserNotFoundException

OperationFailedException

findGroupWithAttributesByName

public GroupWithAttributes findGroupWithAttributesByName(String name)
                                                  throws GroupNotFoundException,
                                                         OperationFailedException

Specified by:

findGroupWithAttributesByName in interface DirectoryCacheChangeOperations

Throws:

GroupNotFoundException

OperationFailedException

findUsersByExternalIds

public Map<String,String> findUsersByExternalIds(Set<String> externalIds)

Specified by:

findUsersByExternalIds in interface DirectoryCacheChangeOperations

findGroupsByExternalIds

public Map<String,String> findGroupsByExternalIds(Set<String> externalIds)
                                           throws OperationFailedException

Description copied from interface: DirectoryCacheChangeOperations

Searches the specified directory for group names of groups with the specified external ids

Specified by:

findGroupsByExternalIds in interface DirectoryCacheChangeOperations

Parameters:

externalIds - external ids of the groups to find

Returns:

a map from external ids to group names

Throws:

OperationFailedException

findGroupsExternalIdsByNames

public Map<String,String> findGroupsExternalIdsByNames(Set<String> groupNames)
                                                throws OperationFailedException

Description copied from interface: DirectoryCacheChangeOperations

Searches the specified directory for externalIds of groups with the specified names

Specified by:

findGroupsExternalIdsByNames in interface DirectoryCacheChangeOperations

Parameters:

groupNames - names of the groups to find

Returns:

a map from group names to external ids

Throws:

OperationFailedException

applySyncingUserAttributes

public void applySyncingUserAttributes(String userName,
                                       Set<String> deletedAttributes,
                                       Map<String,Set<String>> storedAttributes)
                                throws UserNotFoundException,
                                       OperationFailedException

Description copied from interface: DirectoryCacheChangeOperations

Removes any syncing user attributes listed in deletedAttributes, and store any that are listed in storedAttributes If any non-syncing attributes are included, they will be ignored

Specified by:

applySyncingUserAttributes in interface DirectoryCacheChangeOperations

Parameters:

userName - user to apply attributes to

deletedAttributes - attribute keys that need to be deleted

storedAttributes - attributes and values that need to be saved (will overwrite any existing attributes with the same keys)

Throws:

UserNotFoundException

OperationFailedException

applySyncingGroupAttributes

public void applySyncingGroupAttributes(String groupName,
                                        Set<String> deletedAttributes,
                                        Map<String,Set<String>> storedAttributes)
                                 throws GroupNotFoundException,
                                        OperationFailedException

Description copied from interface: DirectoryCacheChangeOperations

Removes any syncing group attributes listed in deletedAttributes, and store any that are listed in storedAttributes If any non-syncing attributes are included, they will be ignored

Specified by:

applySyncingGroupAttributes in interface DirectoryCacheChangeOperations

Parameters:

groupName - group to apply attributes to

deletedAttributes - attribute keys that need to be deleted

storedAttributes - attributes and values that need to be saved (will overwrite any existing attributes with the same keys)

Throws:

GroupNotFoundException

OperationFailedException

getAllUserGuids

public Set<String> getAllUserGuids()
                            throws OperationFailedException

Specified by:

getAllUserGuids in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

getAllGroupGuids

public Set<String> getAllGroupGuids()
                             throws OperationFailedException

Specified by:

getAllGroupGuids in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

getUserCount

public long getUserCount()
                  throws OperationFailedException

Specified by:

getUserCount in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

getGroupCount

public long getGroupCount()
                   throws OperationFailedException

Specified by:

getGroupCount in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

getExternalCachedGroupCount

public long getExternalCachedGroupCount()
                                 throws OperationFailedException

Specified by:

getExternalCachedGroupCount in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException

getAllLocalGroupNames

public Set<String> getAllLocalGroupNames()
                                  throws OperationFailedException

Specified by:

getAllLocalGroupNames in interface DirectoryCacheChangeOperations

Throws:

OperationFailedException