org.apache.sling.discovery.commons.providers.spi.base

Class OakBacklogClusterSyncService

java.lang.Object

org.apache.sling.discovery.commons.providers.spi.base.AbstractServiceWithBackgroundCheck

org.apache.sling.discovery.commons.providers.spi.base.OakBacklogClusterSyncService

All Implemented Interfaces:

ClusterSyncService

public class OakBacklogClusterSyncService
extends AbstractServiceWithBackgroundCheck
implements ClusterSyncService

The OakBacklogClusterSyncService will wait until all instances in the local cluster are no longer in any backlog state.

Constructor Summary

Constructors

Constructor and Description
OakBacklogClusterSyncService()

Method Summary

Modifier and Type	Method and Description
void	cancelSync()
ClusterSyncHistory	getConsistencyHistory()
List<String>	getSyncHistory()
void	setConsistencyHistory(ClusterSyncHistory consistencyHistory)
void	sync(BaseTopologyView view, Runnable callback) Starts the synchronization process and calls the provided callback upon completion.
static OakBacklogClusterSyncService	testConstructor(DiscoveryLiteConfig commonsConfig, IdMapService idMapService, SlingSettingsService settingsService, ResourceResolverFactory resourceResolverFactory) for testing only!
static OakBacklogClusterSyncService	testConstructorAndActivate(DiscoveryLiteConfig commonsConfig, IdMapService idMapService, SlingSettingsService settingsService, ResourceResolverFactory resourceResolverFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

OakBacklogClusterSyncService

public OakBacklogClusterSyncService()

Method Detail

testConstructorAndActivate

public static OakBacklogClusterSyncService testConstructorAndActivate(DiscoveryLiteConfig commonsConfig,
                                                                      IdMapService idMapService,
                                                                      SlingSettingsService settingsService,
                                                                      ResourceResolverFactory resourceResolverFactory)

testConstructor

public static OakBacklogClusterSyncService testConstructor(DiscoveryLiteConfig commonsConfig,
                                                           IdMapService idMapService,
                                                           SlingSettingsService settingsService,
                                                           ResourceResolverFactory resourceResolverFactory)

for testing only!

Parameters:

resourceResolverFactory -

slingId - the local slingId

syncTokenTimeoutMillis - timeout value in millis after which the sync-token process is cancelled - or -1 if no timeout should be used there

backlogWaitTimeoutMillis - timeout value in millis after which the waiting-while-backlog should be cancelled - or -1 if no timeout should be used there

Throws:

LoginException - when the login for initialization failed

JSONException - when the descriptor wasn't proper json at init time

setConsistencyHistory

public void setConsistencyHistory(ClusterSyncHistory consistencyHistory)

getConsistencyHistory

public ClusterSyncHistory getConsistencyHistory()

cancelSync

public void cancelSync()

Specified by:

cancelSync in interface ClusterSyncService

sync

public void sync(BaseTopologyView view,
                 Runnable callback)

Description copied from interface: ClusterSyncService

Starts the synchronization process and calls the provided callback upon completion.

sync() is not thread-safe and should not be invoked concurrently.

If sync() gets called before a previous invocation finished, that previous invocation will be discarded, ie the callback of the previous invocation will no longer be called.

The synchronization process consists of making sure that the repository has processed any potential backlog of instances that are no longer part of the provided, new view. Plus it writes a 'sync-token' to a well-defined location, with all peers doing the same, and upon seeing all other sync-tokens declares successful completion - at which point it calls the callback.run().

Specified by:

sync in interface ClusterSyncService

Parameters:

view - the view which all instances in the local cluster should agree on having seen

callback - the runnable which should be called after successful syncing

getSyncHistory

public List<String> getSyncHistory()