com.atlassian.crowd.directory

Interface DirectoryCacheChangeOperations

public interface DirectoryCacheChangeOperations

Individual methods that should be performed in transactions. No transactional integrity is presumed or required between methods.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DirectoryCacheChangeOperations.AddRemoveSets<T>
static class	DirectoryCacheChangeOperations.GroupShadowingType
static class	DirectoryCacheChangeOperations.GroupsToAddUpdateReplace

Method Summary

Modifier and Type	Method and Description
void	addGroupMembershipsForGroup(Group parentGroup, Collection<String> toAdd)
void	addGroups(Set<GroupTemplate> allToAdd)
void	addGroupToGroup(String childGroup, String parentGroup)
void	addOrUpdateCachedGroup(Group group)
void	addOrUpdateCachedUser(User user)
void	addUserMembershipsForGroup(Group group, Set<String> toAdd)
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> ldapGroups, Date syncStartDate)
void	deleteCachedGroupsNotInByExternalId(Collection<? extends Group> remoteGroups, Date syncStartDate)
void	deleteCachedUser(String username)
void	deleteCachedUsersByGuid(Set<String> usernames)
void	deleteCachedUsersNotIn(Collection<? extends User> users, Date syncStartDate)
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()
long	getExternalCachedGroupCount()
long	getGroupCount()
long	getUserCount()
AddUpdateSets<UserTemplateWithCredentialAndAttributes,UserTemplate>	getUsersToAddAndUpdate(Collection<? extends User> remoteUsers, Date syncStartDate)
DirectoryCacheChangeOperations.GroupShadowingType	isGroupShadowed(Group group)
void	removeGroupFromGroup(String childGroup, String parentGroup)
void	removeGroupMembershipsForGroup(Group parentGroup, Collection<String> toRemove)
void	removeGroups(Collection<String> keySet)
void	removeUserFromGroup(String username, String groupName)
void	removeUserMembershipsForGroup(Group group, Set<String> toRemove)
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)

Method Detail

deleteCachedUsersNotIn

void deleteCachedUsersNotIn(Collection<? extends User> users,
                            Date syncStartDate)
                     throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

deleteCachedUsersByGuid

void deleteCachedUsersByGuid(Set<String> usernames)
                      throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

deleteCachedGroupsNotIn

void deleteCachedGroupsNotIn(GroupType groupType,
                             List<? extends Group> ldapGroups,
                             Date syncStartDate)
                      throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

deleteCachedGroupsNotInByExternalId

void deleteCachedGroupsNotInByExternalId(Collection<? extends Group> remoteGroups,
                                         Date syncStartDate)
                                  throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

deleteCachedGroups

void deleteCachedGroups(Set<String> groupnames)
                 throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

deleteCachedGroupsByGuids

void deleteCachedGroupsByGuids(Set<String> guids)
                        throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

getUsersToAddAndUpdate

AddUpdateSets<UserTemplateWithCredentialAndAttributes,UserTemplate> getUsersToAddAndUpdate(Collection<? extends User> remoteUsers,
                                                                                           Date syncStartDate)
                                                                                    throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

addUsers

void addUsers(Set<UserTemplateWithCredentialAndAttributes> usersToAdd)
       throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

updateUsers

void updateUsers(Collection<UserTemplate> usersToUpdate)
          throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

findGroupsToUpdate

DirectoryCacheChangeOperations.GroupsToAddUpdateReplace findGroupsToUpdate(Collection<? extends Group> remoteGroups,
                                                                           Date syncStartDate)
                                                                    throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

removeGroups

void removeGroups(Collection<String> keySet)
           throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

addGroups

void addGroups(Set<GroupTemplate> allToAdd)
        throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

updateGroups

void updateGroups(Collection<GroupTemplate> groupsToUpdate)
           throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

isGroupShadowed

DirectoryCacheChangeOperations.GroupShadowingType isGroupShadowed(Group group)
                                                           throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

findUserMembershipForGroupChanges

DirectoryCacheChangeOperations.AddRemoveSets<String> findUserMembershipForGroupChanges(Group group,
                                                                                       Collection<String> remoteUsers)
                                                                                throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

addUserMembershipsForGroup

void addUserMembershipsForGroup(Group group,
                                Set<String> toAdd)
                         throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

removeUserMembershipsForGroup

void removeUserMembershipsForGroup(Group group,
                                   Set<String> toRemove)
                            throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

findGroupMembershipForGroupChanges

DirectoryCacheChangeOperations.AddRemoveSets<String> findGroupMembershipForGroupChanges(Group parentGroup,
                                                                                        Collection<String> remoteGroups)
                                                                                 throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

addGroupMembershipsForGroup

void addGroupMembershipsForGroup(Group parentGroup,
                                 Collection<String> toAdd)
                          throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

removeGroupMembershipsForGroup

void removeGroupMembershipsForGroup(Group parentGroup,
                                    Collection<String> toRemove)
                             throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

getAllUserGuids

Set<String> getAllUserGuids()
                     throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

getUserCount

long getUserCount()
           throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

getAllGroupGuids

Set<String> getAllGroupGuids()
                      throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

getGroupCount

long getGroupCount()
            throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

getExternalCachedGroupCount

long getExternalCachedGroupCount()
                          throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

getAllLocalGroupNames

Set<String> getAllLocalGroupNames()
                           throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

addOrUpdateCachedUser

void addOrUpdateCachedUser(User user)
                    throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

deleteCachedUser

void deleteCachedUser(String username)
               throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

addOrUpdateCachedGroup

void addOrUpdateCachedGroup(Group group)
                     throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

deleteCachedGroup

void deleteCachedGroup(String groupName)
                throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

addUserToGroup

void addUserToGroup(String username,
                    String groupName)
             throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

removeUserFromGroup

void removeUserFromGroup(String username,
                         String groupName)
                  throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

addGroupToGroup

void addGroupToGroup(String childGroup,
                     String parentGroup)
              throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

removeGroupFromGroup

void removeGroupFromGroup(String childGroup,
                          String parentGroup)
                   throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

syncGroupMembershipsForUser

void syncGroupMembershipsForUser(String childUsername,
                                 Set<String> parentGroupNames)
                          throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

syncGroupMembershipsAndMembersForGroup

void syncGroupMembershipsAndMembersForGroup(String groupName,
                                            Set<String> parentGroupNames,
                                            Set<String> childGroupNames)
                                     throws com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.OperationFailedException

findUserWithAttributesByName

UserWithAttributes findUserWithAttributesByName(String name)
                                         throws com.atlassian.crowd.exception.UserNotFoundException,
                                                com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.UserNotFoundException

com.atlassian.crowd.exception.OperationFailedException

findGroupWithAttributesByName

GroupWithAttributes findGroupWithAttributesByName(String name)
                                           throws com.atlassian.crowd.exception.GroupNotFoundException,
                                                  com.atlassian.crowd.exception.OperationFailedException

Throws:

com.atlassian.crowd.exception.GroupNotFoundException

com.atlassian.crowd.exception.OperationFailedException

findUsersByExternalIds

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

findGroupsByExternalIds

Map<String,String> findGroupsByExternalIds(Set<String> externalIds)
                                    throws com.atlassian.crowd.exception.OperationFailedException

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

Parameters:

externalIds - external ids of the groups to find

Returns:

a map from external ids to group names

Throws:

com.atlassian.crowd.exception.OperationFailedException

findGroupsExternalIdsByNames

Map<String,String> findGroupsExternalIdsByNames(Set<String> groupNames)
                                         throws com.atlassian.crowd.exception.OperationFailedException

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

Parameters:

groupNames - names of the groups to find

Returns:

a map from group names to external ids

Throws:

com.atlassian.crowd.exception.OperationFailedException

applySyncingUserAttributes

void applySyncingUserAttributes(String userName,
                                Set<String> deletedAttributes,
                                Map<String,Set<String>> storedAttributes)
                         throws com.atlassian.crowd.exception.UserNotFoundException,
                                com.atlassian.crowd.exception.OperationFailedException

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

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:

com.atlassian.crowd.exception.UserNotFoundException

com.atlassian.crowd.exception.OperationFailedException

applySyncingGroupAttributes

void applySyncingGroupAttributes(String groupName,
                                 Set<String> deletedAttributes,
                                 Map<String,Set<String>> storedAttributes)
                          throws com.atlassian.crowd.exception.GroupNotFoundException,
                                 com.atlassian.crowd.exception.OperationFailedException

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

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:

com.atlassian.crowd.exception.GroupNotFoundException

com.atlassian.crowd.exception.OperationFailedException