com.atlassian.crowd.manager.directory
Interface SynchronisationStatusManager

public interface SynchronisationStatusManager

Method Summary

com.atlassian.crowd.embedded.api.DirectorySynchronisationInformation	getDirectorySynchronisationInformation(com.atlassian.crowd.embedded.api.Directory directory) Returns directory synchronisation information.
void	syncFinished(long directoryId) Notify that directory synchronisation has finished.
void	syncStarted(com.atlassian.crowd.embedded.api.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(com.atlassian.crowd.embedded.api.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

com.atlassian.crowd.embedded.api.DirectorySynchronisationInformation getDirectorySynchronisationInformation(com.atlassian.crowd.embedded.api.Directory directory)

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

Parameters:

directory - directory to retrieve information from

Returns:

directory synchronisation information