com.atlassian.crowd.manager.directory

Interface DirectorySynchronisationInformationStore

All Known Implementing Classes:

DirectorySynchronisationInformationStoreImpl, InDatabaseDirectorySynchronisationInformationStore

public interface DirectorySynchronisationInformationStore

Storage for directory synchronisation information.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears directory synchronisation information of all directories.
void	clear(long directoryId) Clears directory synchronisation information for the given directory
void	clearEventTokenForDirectory(long directoryId) Clears event tokens for the given directory
DirectorySynchronisationRoundInformation	getActive(long directoryId) Provides information about the status of the active synchronisation for the directory
Optional<DirectorySynchronisationRoundInformation>	getLast(long directoryId) Provides information about the last completed (either succeeded or failed) synchronisation
void	syncFinished(long directoryId, long timestamp, SynchronisationStatusKey statusKey, List<Serializable> parameters, String syncStatusToken) Finishes synchronisation status, marking it as last status information and clearing active synchronisation status
void	syncStarted(long directoryId, long timestamp) Starts the synchronisation, creating new directory synchronisation information
void	syncStatus(long directoryId, String statusKey, List<Serializable> parameters) Updates active directory synchronisation status
void	syncStatus(long directoryId, SynchronisationStatusKey statusKey, List<Serializable> parameters) Updates active directory synchronisation status

Method Detail

getActive

@Nullable
DirectorySynchronisationRoundInformation getActive(long directoryId)

Provides information about the status of the active synchronisation for the directory

Parameters:

directoryId - directory id

Returns:

information about the active synchronisation if present

getLast

Optional<DirectorySynchronisationRoundInformation> getLast(long directoryId)

Provides information about the last completed (either succeeded or failed) synchronisation

Parameters:

directoryId - directory id

Returns:

an optional either containing information about the last synchronisation if present

clear

void clear(long directoryId)

Clears directory synchronisation information for the given directory

Parameters:

directoryId - directory id

clear

void clear()

Clears directory synchronisation information of all directories.

syncStatus

void syncStatus(long directoryId,
                String statusKey,
                List<Serializable> parameters)

Updates active directory synchronisation status

Parameters:

directoryId - directory id

statusKey - new status i18n key

parameters - parameters for the statusKey

syncStatus

void syncStatus(long directoryId,
                SynchronisationStatusKey statusKey,
                List<Serializable> parameters)

Updates active directory synchronisation status

Parameters:

directoryId - directory id

statusKey - new status i18n key

parameters - paramaters for the statusKey

syncStarted

void syncStarted(long directoryId,
                 long timestamp)

Starts the synchronisation, creating new directory synchronisation information

Parameters:

directoryId - directory id

timestamp - synchronisation start

syncFinished

void syncFinished(long directoryId,
                  long timestamp,
                  SynchronisationStatusKey statusKey,
                  List<Serializable> parameters,
                  @Nullable
                  String syncStatusToken)

Finishes synchronisation status, marking it as last status information and clearing active synchronisation status

Parameters:

directoryId - directory id

timestamp - synchronisation end

statusKey - ending status (should indicate failure or success)

parameters - parameters for the statusKey

clearEventTokenForDirectory

void clearEventTokenForDirectory(long directoryId)

Clears event tokens for the given directory

Parameters:

directoryId - directory id