com.atlassian.crowd.directory.ldap.cache
Interface DirectoryCache

public interface DirectoryCache

A cache of users, groups and memberships for an external Directory. The CacheRefresher passes the updated data to this interface for caching.

See Also:

UsnChangedCacheRefresher

Method Summary

void	addGroupToGroup(java.lang.String childGroup, java.lang.String parentGroup)
void	addOrUpdateCachedGroup(Group group)
void	addOrUpdateCachedGroups(java.util.List<? extends Group> groups, java.util.Date syncStartDate)
void	addOrUpdateCachedUser(User user)
void	addOrUpdateCachedUsers(java.util.List<? extends User> users, java.util.Date syncStartDate) Synchronises a list of Users from an external directory in the local cache.
void	addUserToGroup(java.lang.String username, java.lang.String groupName)
void	deleteCachedGroup(java.lang.String groupName)
void	deleteCachedGroups(java.util.Set<java.lang.String> groupnames)
void	deleteCachedGroupsNotIn(GroupType groupType, java.util.List<? extends Group> ldapGroups, java.util.Date syncStartDate)
void	deleteCachedUser(java.lang.String username)
void	deleteCachedUsers(java.util.Set<java.lang.String> usernames)
void	deleteCachedUsersNotIn(java.util.List<? extends User> users, java.util.Date syncStartDate)
void	removeGroupFromGroup(java.lang.String childGroup, java.lang.String parentGroup)
void	removeUserFromGroup(java.lang.String username, java.lang.String groupName)
void	syncGroupMembersForGroup(Group ldapGroup, java.util.Collection<java.lang.String> groups)
void	syncGroupMembershipsAndMembersForGroup(java.lang.String groupName, java.util.Set<java.lang.String> parentGroupNames, java.util.Set<java.lang.String> childGroupNames)
void	syncGroupMembershipsForUser(java.lang.String childUsername, java.util.Set<java.lang.String> parentGroupNames)
void	syncUserMembersForGroup(Group ldapGroup, java.util.Collection<java.lang.String> remoteUsers)

Method Detail

addOrUpdateCachedUsers

void addOrUpdateCachedUsers(java.util.List<? extends User> users,
                            java.util.Date syncStartDate)
                            throws OperationFailedException

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 UsnChangedCacheRefresher does a partial synchronise.

Parameters:

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

deleteCachedUsersNotIn

void deleteCachedUsersNotIn(java.util.List<? extends User> users,
                            java.util.Date syncStartDate)
                            throws OperationFailedException

Throws:

OperationFailedException

deleteCachedUsers

void deleteCachedUsers(java.util.Set<java.lang.String> usernames)
                       throws OperationFailedException

Throws:

OperationFailedException

addOrUpdateCachedGroups

void addOrUpdateCachedGroups(java.util.List<? extends Group> groups,
                             java.util.Date syncStartDate)
                             throws OperationFailedException

Throws:

OperationFailedException

deleteCachedGroupsNotIn

void deleteCachedGroupsNotIn(GroupType groupType,
                             java.util.List<? extends Group> ldapGroups,
                             java.util.Date syncStartDate)
                             throws OperationFailedException

Throws:

OperationFailedException

deleteCachedGroups

void deleteCachedGroups(java.util.Set<java.lang.String> groupnames)
                        throws OperationFailedException

Throws:

OperationFailedException

syncUserMembersForGroup

void syncUserMembersForGroup(Group ldapGroup,
                             java.util.Collection<java.lang.String> remoteUsers)
                             throws OperationFailedException

Throws:

OperationFailedException

syncGroupMembersForGroup

void syncGroupMembersForGroup(Group ldapGroup,
                              java.util.Collection<java.lang.String> groups)
                              throws OperationFailedException

Throws:

OperationFailedException

addOrUpdateCachedUser

void addOrUpdateCachedUser(User user)
                           throws OperationFailedException

Throws:

OperationFailedException

deleteCachedUser

void deleteCachedUser(java.lang.String username)
                      throws OperationFailedException

Throws:

OperationFailedException

addOrUpdateCachedGroup

void addOrUpdateCachedGroup(Group group)
                            throws OperationFailedException

Throws:

OperationFailedException

deleteCachedGroup

void deleteCachedGroup(java.lang.String groupName)
                       throws OperationFailedException

Throws:

OperationFailedException

addUserToGroup

void addUserToGroup(java.lang.String username,
                    java.lang.String groupName)
                    throws OperationFailedException

Throws:

OperationFailedException

removeUserFromGroup

void removeUserFromGroup(java.lang.String username,
                         java.lang.String groupName)
                         throws OperationFailedException

Throws:

OperationFailedException

addGroupToGroup

void addGroupToGroup(java.lang.String childGroup,
                     java.lang.String parentGroup)
                     throws OperationFailedException

Throws:

OperationFailedException

removeGroupFromGroup

void removeGroupFromGroup(java.lang.String childGroup,
                          java.lang.String parentGroup)
                          throws OperationFailedException

Throws:

OperationFailedException

syncGroupMembershipsForUser

void syncGroupMembershipsForUser(java.lang.String childUsername,
                                 java.util.Set<java.lang.String> parentGroupNames)
                                 throws OperationFailedException

Throws:

OperationFailedException

syncGroupMembershipsAndMembersForGroup

void syncGroupMembershipsAndMembersForGroup(java.lang.String groupName,
                                            java.util.Set<java.lang.String> parentGroupNames,
                                            java.util.Set<java.lang.String> childGroupNames)
                                            throws OperationFailedException

Throws:

OperationFailedException