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

Method Summary

Modifier and Type	Method and Description
boolean	isIncrementalSyncEnabled() Gets the preferred synchronisation mode for this remote directory.
void	synchroniseCache(SynchronisationMode mode, SynchronisationStatusManager synchronisationStatusManager) Requests that this directory should update its cache by synchronising with the remote data.

Methods inherited from interface com.atlassian.crowd.directory.RemoteDirectory

addGroup, addGroupToGroup, addUser, addUser, addUserToGroup, authenticate, countDirectMembersOfGroup, expireAllPasswords, findGroupByName, findGroupWithAttributesByName, findUserByExternalId, findUserByName, findUserWithAttributesByName, getAuthoritativeDirectory, getDescriptiveName, getDirectoryId, getLocallyFilteredGroupNames, getMemberships, getUserAvatarByName, isGroupDirectGroupMember, isRolesDisabled, isUserDirectGroupMember, removeGroup, removeGroupAttributes, removeGroupFromGroup, removeUser, removeUserAttributes, removeUserFromGroup, renameGroup, renameUser, searchGroupRelationships, searchGroups, searchUsers, setAttributes, setDirectoryId, storeGroupAttributes, storeUserAttributes, supportsInactiveAccounts, supportsNestedGroups, supportsPasswordExpiration, supportsSettingEncryptedCredential, testConnection, updateGroup, updateUser, updateUserCredential, updateUserFromRemoteDirectory, userAuthenticated

Methods inherited from interface com.atlassian.crowd.embedded.api.Attributes

getKeys, getValue, getValues, isEmpty

Method Detail

isIncrementalSyncEnabled

boolean isIncrementalSyncEnabled()

Gets the preferred synchronisation mode for this remote directory.

Note: some directory implementation don't support incremental sync and will ignore this preference.

Returns:

true if incremental sync is preferred.

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 mode

synchronisationStatusManager - listener for synchronisation status change notifications

Throws:

OperationFailedException - underlying directory implementation failed to execute the operation.