com.atlassian.crowd.manager.directory

Interface DirectorySynchroniser

All Known Implementing Classes:

DirectorySynchroniserImpl, NoopDirectorySynchroniser

public interface DirectorySynchroniser

An object that synchronises a SynchronisableDirectory with a cache.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isSynchronising(long directoryId) Returns whether the directory is currently synchronising.
void	synchronise(SynchronisableDirectory synchronisableDirectory, SynchronisationMode mode) Executes a synchronisation in the current thread.

Method Detail

synchronise

void synchronise(SynchronisableDirectory synchronisableDirectory,
               SynchronisationMode mode)
                 throws DirectoryNotFoundException,
                        OperationFailedException

Executes a synchronisation in the current thread. If the directory is not active, then the method will return silently.

Parameters:

synchronisableDirectory - directory to synchronise.

mode - synchronisation mode.

Throws:

DirectoryNotFoundException

OperationFailedException

isSynchronising

boolean isSynchronising(long directoryId)
                        throws DirectoryNotFoundException

Returns whether the directory is currently synchronising.

Parameters:

directoryId - ID of the directory

Returns:

true if the directory is current synchronising, otherwise false.

Throws:

DirectoryNotFoundException - if the directory could not be found