com.atlassian.crowd.directory
Interface SynchronisableDirectory
- All Superinterfaces:
- Attributes, RemoteDirectory
- All Known Implementing Classes:
- DbCachingRemoteDirectory
public interface SynchronisableDirectory
- extends RemoteDirectory
A RemoteDirectory
that holds a local cache to remote data.
The methods on this interface offer methods related to synchronising the remote data.
- Since:
- v2.1
Methods inherited from interface com.atlassian.crowd.directory.RemoteDirectory |
addGroup, addGroupToGroup, addUser, addUserToGroup, authenticate, findGroupByName, findGroupWithAttributesByName, findUserByName, findUserWithAttributesByName, getAuthoritativeDirectory, getDescriptiveName, getDirectoryId, getMemberships, isGroupDirectGroupMember, isRolesDisabled, isUserDirectGroupMember, removeGroup, removeGroupAttributes, removeGroupFromGroup, removeUser, removeUserAttributes, removeUserFromGroup, renameGroup, renameUser, searchGroupRelationships, searchGroups, searchUsers, setAttributes, setDirectoryId, storeGroupAttributes, storeUserAttributes, supportsInactiveAccounts, supportsNestedGroups, testConnection, updateGroup, updateUser, updateUserCredential |
synchroniseCache
void synchroniseCache(SynchronisationMode mode,
SynchronisationStatusManager synchronisationStatusManager)
throws OperationFailedException
- Requests that this directory should update its cache by synchronising with the remote data.
Implementations of this method should publish a RemoteDirectorySynchronisedEvent after completing the synchronisation.
- Parameters:
mode
- synchronisation modesynchronisationStatusManager
- listener for synchronisation status change notifications
- Throws:
OperationFailedException
- underlying directory implementation failed to execute the operation.
Copyright © 2012 Atlassian. All Rights Reserved.