com.atlassian.crowd.manager.directory

Interface SynchronisationStatusManager

All Known Implementing Classes:

SynchronisationStatusManagerImpl

public interface SynchronisationStatusManager

Method Summary

Modifier and Type	Method and Description
DirectorySynchronisationInformation	getDirectorySynchronisationInformation(Directory directory) Returns directory synchronisation information.
void	syncFinished(long directoryId) Notify that directory synchronisation has finished.
void	syncStarted(Directory directory) Notify that directory synchronisation has started.
void	syncStatus(long directoryId, String key, Serializable... parameters) Notify that directory synchronisation status has changed.

Method Detail

syncStarted

void syncStarted(Directory directory)

Notify that directory synchronisation has started.

Parameters:

directory - directory

syncStatus

void syncStatus(long directoryId,
                String key,
                Serializable... parameters)

Notify that directory synchronisation status has changed.

Parameters:

directoryId - directory id

key - synchronisation status message key

parameters - synchronisation status message parameters

Throws:

IllegalStateException - if the directory is not currently synchronising

syncFinished

void syncFinished(long directoryId)

Notify that directory synchronisation has finished.

Parameters:

directoryId - directory id

getDirectorySynchronisationInformation

DirectorySynchronisationInformation getDirectorySynchronisationInformation(Directory directory)

Returns directory synchronisation information. The returned value is never be null.

Parameters:

directory - directory to retrieve information from

Returns:

directory synchronisation information