com.atlassian.crowd.manager.directory

Class InDatabaseDirectorySynchronisationInformationStore

java.lang.Object

com.atlassian.crowd.manager.directory.InDatabaseDirectorySynchronisationInformationStore

All Implemented Interfaces:

DirectorySynchronisationInformationStore

@Transactional
public class InDatabaseDirectorySynchronisationInformationStore
extends Object
implements DirectorySynchronisationInformationStore

Stores information about synchronisation status in the database

Since:

2.12.0

Constructor Summary

Constructors

Constructor and Description
InDatabaseDirectorySynchronisationInformationStore(DirectorySynchronisationStatusDao statusDao, DirectoryDao directoryDao, ClusterService clusterService)

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.
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.
Collection<DirectorySynchronisationStatus>	getStalledSynchronizations() Attempts to find synchronizations that have been marked as in-progress, but don't seem to be running anymore.
void	syncFailure(long directoryId, SynchronisationMode syncMode, String failureReason) Updates active directory synchronisation status with a failure reason.
void	syncFinished(long directoryId, long timestamp, SynchronisationStatusKey statusKey, List<Serializable> parameters) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InDatabaseDirectorySynchronisationInformationStore

public InDatabaseDirectorySynchronisationInformationStore(DirectorySynchronisationStatusDao statusDao,
                                                          DirectoryDao directoryDao,
                                                          ClusterService clusterService)

Method Detail

getActive

public DirectorySynchronisationRoundInformation getActive(long directoryId)

Description copied from interface: DirectorySynchronisationInformationStore

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

Specified by:

getActive in interface DirectorySynchronisationInformationStore

Parameters:

directoryId - directory id

Returns:

information about the active synchronisation if present

getLast

public Optional<DirectorySynchronisationRoundInformation> getLast(long directoryId)

Description copied from interface: DirectorySynchronisationInformationStore

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

Specified by:

getLast in interface DirectorySynchronisationInformationStore

Parameters:

directoryId - directory id

Returns:

an optional either containing information about the last synchronisation if present

clear

public void clear(long directoryId)

Description copied from interface: DirectorySynchronisationInformationStore

Clears directory synchronisation information for the given directory.

Specified by:

clear in interface DirectorySynchronisationInformationStore

Parameters:

directoryId - directory id

clear

public void clear()

Description copied from interface: DirectorySynchronisationInformationStore

Clears directory synchronisation information of all directories.

Specified by:

clear in interface DirectorySynchronisationInformationStore

syncStatus

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

Description copied from interface: DirectorySynchronisationInformationStore

Updates active directory synchronisation status

Specified by:

syncStatus in interface DirectorySynchronisationInformationStore

Parameters:

directoryId - directory id

statusKey - new status i18n key

parameters - parameters for the statusKey

syncStatus

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

Description copied from interface: DirectorySynchronisationInformationStore

Updates active directory synchronisation status.

Specified by:

syncStatus in interface DirectorySynchronisationInformationStore

Parameters:

directoryId - directory id

statusKey - new status i18n key

parameters - paramaters for the statusKey

syncStarted

public void syncStarted(long directoryId,
                        long timestamp)

Description copied from interface: DirectorySynchronisationInformationStore

Starts the synchronisation, creating new directory synchronisation information.

Specified by:

syncStarted in interface DirectorySynchronisationInformationStore

Parameters:

directoryId - directory id

timestamp - synchronisation start

syncFailure

public void syncFailure(long directoryId,
                        SynchronisationMode syncMode,
                        String failureReason)

Description copied from interface: DirectorySynchronisationInformationStore

Updates active directory synchronisation status with a failure reason.

Specified by:

syncFailure in interface DirectorySynchronisationInformationStore

Parameters:

directoryId - directory id

syncMode - synchronisation mode

failureReason - failure reason

syncFinished

public void syncFinished(long directoryId,
                         long timestamp,
                         SynchronisationStatusKey statusKey,
                         List<Serializable> parameters)

Description copied from interface: DirectorySynchronisationInformationStore

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

Specified by:

syncFinished in interface DirectorySynchronisationInformationStore

Parameters:

directoryId - directory id

timestamp - synchronisation end

statusKey - ending status (should indicate failure or success)

parameters - parameters for the statusKey

getStalledSynchronizations

public Collection<DirectorySynchronisationStatus> getStalledSynchronizations()

Description copied from interface: DirectorySynchronisationInformationStore

Attempts to find synchronizations that have been marked as in-progress, but don't seem to be running anymore. The exact method of finding those depends on the implementation and configuration.

Specified by:

getStalledSynchronizations in interface DirectorySynchronisationInformationStore

Returns:

a list of synchronizations that are potentially stalled, or an empty list if stalled synchronisations can't be determined.