Package com.atlassian.crowd.directory

Class DirectoryCacheImplUsingChangeOperations

java.lang.Object

com.atlassian.crowd.directory.DirectoryCacheImplUsingChangeOperations

All Implemented Interfaces:

DirectoryCache

public class DirectoryCacheImplUsingChangeOperations
extends Object
implements DirectoryCache

Constructor Summary

Constructors

Constructor	Description
DirectoryCacheImplUsingChangeOperations(DirectoryCacheChangeOperations dc)

Method Summary

Modifier and Type	Method	Description
void	addGroupMembersForGroup(Group parentGroup, Set<String> remoteGroups)
void	addGroupToGroup(String childGroup, String parentGroup)
void	addOrUpdateCachedGroup(Group group)
void	addOrUpdateCachedGroups(Collection<? extends Group> remoteGroups, Date syncStartDate)
void	addOrUpdateCachedUser(User user)
AddUpdateSets<UserTemplateWithCredentialAndAttributes,UserTemplate>	addOrUpdateCachedUsers(Collection<? extends User> remoteUsers, Date syncStartDate)	Synchronises a list of Users from an external directory in the local cache.
void	addUserMembersForGroup(Group parentGroup, Set<String> remoteUsers)
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> users, Date syncStartDate)
void	deleteGroupMembersForGroup(Group parentGroup, Set<String> remoteGroups)
void	deleteUserMembersForGroup(Group parentGroup, Set<String> remoteUsers)
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
GroupWithAttributes	findGroupWithAttributesByName(String name)
Map<String,String>	findUsersByExternalIds(Set<String> externalIds)	Searches the specified directory for user names of users with the specified external ids, returns a map from external id to username
UserWithAttributes	findUserWithAttributesByName(String name)
Set<String>	getAllGroupGuids()	Returns a set of all group guids present in the cache excluding null values.
Set<String>	getAllLocalGroupNames()	Returns a set of all local group names.
Set<String>	getAllUserGuids()	Returns a set of all user guids present in the cache excluding null values.
long	getExternalCachedGroupCount()	Counts external cached groups in the directory cache
long	getGroupCount()	Counts groups in directory cache.
long	getUserCount()	Counts users in directory cache.
void	removeGroupFromGroup(String childGroup, String parentGroup)
void	removeUserFromGroup(String username, String groupName)
void	syncGroupMembersForGroup(Group parentGroup, Collection<String> remoteGroups)
void	syncGroupMembershipsAndMembersForGroup(String groupName, Set<String> parentGroupNames, Set<String> childGroupNames)
void	syncGroupMembershipsForUser(String childUsername, Set<String> parentGroupNames)
void	syncUserMembersForGroup(Group parentGroup, Collection<String> remoteUsers)

Methods inherited from class java.lang.Object

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

Constructor Details

DirectoryCacheImplUsingChangeOperations

public DirectoryCacheImplUsingChangeOperations(DirectoryCacheChangeOperations dc)

Method Details

addOrUpdateCachedUsers

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

Description copied from interface: DirectoryCache

Synchronises a list of Users from an external directory in the local cache.

If the syncStartDate is not null, then it is used to ensure we don't re-introduce stale data if a User is updated locally after we did our search. Some callers may intentionally choose to pass null - eg when com.atlassian.crowd.directory.ldap.cache.UsnChangedCacheRefresher does a partial synchronise.

Specified by:

addOrUpdateCachedUsers in interface DirectoryCache

Parameters:

remoteUsers - A list of Users from the external directory.

syncStartDate - The date that the synchronise started (can be null).

Throws:

OperationFailedException - If the Internal Directory throws a OperationFailedException - which seems unlikely.

deleteCachedUsersByGuid

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

Specified by:

deleteCachedUsersByGuid in interface DirectoryCache

Throws:

OperationFailedException

addOrUpdateCachedGroups

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

Specified by:

addOrUpdateCachedGroups in interface DirectoryCache

Throws:

OperationFailedException

deleteCachedGroupsNotIn

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

Specified by:

deleteCachedGroupsNotIn in interface DirectoryCache

Throws:

OperationFailedException

deleteCachedGroupsNotInByExternalId

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

Specified by:

deleteCachedGroupsNotInByExternalId in interface DirectoryCache

Throws:

OperationFailedException

syncUserMembersForGroup

public void syncUserMembersForGroup(Group parentGroup,
 Collection<String> remoteUsers)
                             throws OperationFailedException

Specified by:

syncUserMembersForGroup in interface DirectoryCache

Throws:

OperationFailedException

addUserMembersForGroup

public void addUserMembersForGroup(Group parentGroup,
 Set<String> remoteUsers)
                            throws OperationFailedException

Specified by:

addUserMembersForGroup in interface DirectoryCache

Throws:

OperationFailedException

deleteUserMembersForGroup

public void deleteUserMembersForGroup(Group parentGroup,
 Set<String> remoteUsers)
                               throws OperationFailedException

Specified by:

deleteUserMembersForGroup in interface DirectoryCache

Throws:

OperationFailedException

syncGroupMembersForGroup

public void syncGroupMembersForGroup(Group parentGroup,
 Collection<String> remoteGroups)
                              throws OperationFailedException

Specified by:

syncGroupMembersForGroup in interface DirectoryCache

Throws:

OperationFailedException

addGroupMembersForGroup

public void addGroupMembersForGroup(Group parentGroup,
 Set<String> remoteGroups)
                             throws OperationFailedException

Specified by:

addGroupMembersForGroup in interface DirectoryCache

Throws:

OperationFailedException

deleteGroupMembersForGroup

public void deleteGroupMembersForGroup(Group parentGroup,
 Set<String> remoteGroups)
                                throws OperationFailedException

Specified by:

deleteGroupMembersForGroup in interface DirectoryCache

Throws:

OperationFailedException

deleteCachedGroups

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

Specified by:

deleteCachedGroups in interface DirectoryCache

Throws:

OperationFailedException

deleteCachedGroupsByGuids

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

Specified by:

deleteCachedGroupsByGuids in interface DirectoryCache

Throws:

OperationFailedException

deleteCachedUsersNotIn

public void deleteCachedUsersNotIn(Collection<? extends User> users,
 Date syncStartDate)
                            throws OperationFailedException

Specified by:

deleteCachedUsersNotIn in interface DirectoryCache

Throws:

OperationFailedException

addOrUpdateCachedUser

public void addOrUpdateCachedUser(User user)
                           throws OperationFailedException

Specified by:

addOrUpdateCachedUser in interface DirectoryCache

Throws:

OperationFailedException

deleteCachedUser

public void deleteCachedUser(String username)
                      throws OperationFailedException

Specified by:

deleteCachedUser in interface DirectoryCache

Throws:

OperationFailedException

addOrUpdateCachedGroup

public void addOrUpdateCachedGroup(Group group)
                            throws OperationFailedException

Specified by:

addOrUpdateCachedGroup in interface DirectoryCache

Throws:

OperationFailedException

deleteCachedGroup

public void deleteCachedGroup(String groupName)
                       throws OperationFailedException

Specified by:

deleteCachedGroup in interface DirectoryCache

Throws:

OperationFailedException

addUserToGroup

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

Specified by:

addUserToGroup in interface DirectoryCache

Throws:

OperationFailedException

removeUserFromGroup

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

Specified by:

removeUserFromGroup in interface DirectoryCache

Throws:

OperationFailedException

addGroupToGroup

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

Specified by:

addGroupToGroup in interface DirectoryCache

Throws:

OperationFailedException

removeGroupFromGroup

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

Specified by:

removeGroupFromGroup in interface DirectoryCache

Throws:

OperationFailedException

syncGroupMembershipsForUser

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

Specified by:

syncGroupMembershipsForUser in interface DirectoryCache

Throws:

OperationFailedException

syncGroupMembershipsAndMembersForGroup

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

Specified by:

syncGroupMembershipsAndMembersForGroup in interface DirectoryCache

Throws:

OperationFailedException

getAllUserGuids

public Set<String> getAllUserGuids()
                            throws OperationFailedException

Description copied from interface: DirectoryCache

Returns a set of all user guids present in the cache excluding null values.

Specified by:

getAllUserGuids in interface DirectoryCache

Returns:

set of all user guids present in the cache

Throws:

OperationFailedException - if the internal directory throes a OperationFailedException

getAllGroupGuids

public Set<String> getAllGroupGuids()
                             throws OperationFailedException

Description copied from interface: DirectoryCache

Returns a set of all group guids present in the cache excluding null values.

Specified by:

getAllGroupGuids in interface DirectoryCache

Returns:

set of all group guids present in the cache

Throws:

OperationFailedException - if the internal directory throes a OperationFailedException

getAllLocalGroupNames

public Set<String> getAllLocalGroupNames()
                                  throws OperationFailedException

Description copied from interface: DirectoryCache

Returns a set of all local group names.

Specified by:

getAllLocalGroupNames in interface DirectoryCache

Returns:

set of all local group names.

Throws:

OperationFailedException - if the internal directory throes a OperationFailedException

getUserCount

public long getUserCount()
                  throws OperationFailedException

Description copied from interface: DirectoryCache

Counts users in directory cache.

Specified by:

getUserCount in interface DirectoryCache

Returns:

user count

Throws:

OperationFailedException

getGroupCount

public long getGroupCount()
                   throws OperationFailedException

Description copied from interface: DirectoryCache

Counts groups in directory cache.

Specified by:

getGroupCount in interface DirectoryCache

Returns:

group count

Throws:

OperationFailedException

getExternalCachedGroupCount

public long getExternalCachedGroupCount()
                                 throws OperationFailedException

Description copied from interface: DirectoryCache

Counts external cached groups in the directory cache

Specified by:

getExternalCachedGroupCount in interface DirectoryCache

Returns:

external cached group count

Throws:

OperationFailedException - if the internal directory throws a OperationFailedException

findUserWithAttributesByName

public UserWithAttributes findUserWithAttributesByName(String name)
                                                throws UserNotFoundException,
OperationFailedException

Specified by:

findUserWithAttributesByName in interface DirectoryCache

Throws:

UserNotFoundException

OperationFailedException

findUsersByExternalIds

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

Description copied from interface: DirectoryCache

Searches the specified directory for user names of users with the specified external ids, returns a map from external id to username

Specified by:

findUsersByExternalIds in interface DirectoryCache

Parameters:

externalIds - the external ids of the users to search for

findGroupsByExternalIds

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

Description copied from interface: DirectoryCache

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

Specified by:

findGroupsByExternalIds in interface DirectoryCache

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: DirectoryCache

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

Specified by:

findGroupsExternalIdsByNames in interface DirectoryCache

Parameters:

groupNames - names of the groups to find

Returns:

a map from group names to external ids

Throws:

OperationFailedException

findGroupWithAttributesByName

public GroupWithAttributes findGroupWithAttributesByName(String name)
                                                  throws GroupNotFoundException,
OperationFailedException

Specified by:

findGroupWithAttributesByName in interface DirectoryCache

Throws:

GroupNotFoundException

OperationFailedException

applySyncingUserAttributes

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

Description copied from interface: DirectoryCache

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 DirectoryCache

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: DirectoryCache

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 DirectoryCache

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