org.dizitart.no2.sync

Class DataGateSyncTemplate

java.lang.Object

org.dizitart.no2.sync.DataGateSyncTemplate

All Implemented Interfaces:

SyncTemplate

public class DataGateSyncTemplate
extends java.lang.Object
implements SyncTemplate

Represents a template for DataGate sync operations.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
DataGateSyncTemplate(DataGateClient dataGateClient, java.lang.String collection) Instantiates a new DataGateSyncTemplate.

Method Summary

Modifier and Type	Method and Description
boolean	change(ChangeFeed changeFeed) Uploads the local changes to the server.
ChangeFeed	changedSince(FeedOptions feedOptions) Downloads the list of changes from the server.
void	clear() Clears the remote collection.
java.util.List<Document>	fetch(int offset, int limit) Fetches all documents from remote.
java.lang.String	getCollectionName() Gets the name of the remote collection.
boolean	isOnline() Checks if the server is online and reachable.
void	releaseLock(java.lang.String issuer) Releases the synchronization lock on the remote collection.
long	size() Gets the size of the remote collection.
boolean	trySyncLock(TimeSpan expiryDelay, java.lang.String issuer) Tries to acquire a synchronization lock on the remote collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataGateSyncTemplate

public DataGateSyncTemplate(DataGateClient dataGateClient,
                            java.lang.String collection)

Instantiates a new DataGateSyncTemplate.

Parameters:

dataGateClient - the DataGateClient

collection - the remote collection name

Method Detail

changedSince

public ChangeFeed changedSince(FeedOptions feedOptions)

Description copied from interface: SyncTemplate

Downloads the list of changes from the server.

Specified by:

changedSince in interface SyncTemplate

Parameters:

feedOptions - options to fetch the change feed

Returns:

the list of changes

change

public boolean change(ChangeFeed changeFeed)

Description copied from interface: SyncTemplate

Uploads the local changes to the server.

Specified by:

change in interface SyncTemplate

Parameters:

changeFeed - the list of changes to upload

Returns:

true if the operation is successful; false otherwise.

fetch

public java.util.List<Document> fetch(int offset,
                                      int limit)

Description copied from interface: SyncTemplate

Fetches all documents from remote.

Specified by:

fetch in interface SyncTemplate

Parameters:

offset - pagination offset

limit - pagination limit

Returns:

list of documents from remote.

size

public long size()

Description copied from interface: SyncTemplate

Gets the size of the remote collection.

Specified by:

size in interface SyncTemplate

Returns:

the size in long

clear

public void clear()

Description copied from interface: SyncTemplate

Clears the remote collection.

Specified by:

clear in interface SyncTemplate

isOnline

public boolean isOnline()

Description copied from interface: SyncTemplate

Checks if the server is online and reachable.

Specified by:

isOnline in interface SyncTemplate

Returns:

true if online; false otherwise.

getCollectionName

public java.lang.String getCollectionName()

Description copied from interface: SyncTemplate

Gets the name of the remote collection.

Specified by:

getCollectionName in interface SyncTemplate

Returns:

the name of the remote collection.

trySyncLock

public boolean trySyncLock(TimeSpan expiryDelay,
                           java.lang.String issuer)

Description copied from interface: SyncTemplate

Tries to acquire a synchronization lock on the remote collection. Before start of replication, a sync lock must be acquired on remote collection. If the acquisition is unsuccessful, replication will not occur and it will be retried in next iteration.

If the expiryDelay is expired, then a new lock will be acquired overwriting previous lock information.

Lock information should be maintain as a metadata in the remote database in a separate collection/table than the remote collection.

Specified by:

trySyncLock in interface SyncTemplate

Parameters:

expiryDelay - the expiry delay

issuer - originator of the change feed

Returns:

the boolean

releaseLock

public void releaseLock(java.lang.String issuer)

Description copied from interface: SyncTemplate

Releases the synchronization lock on the remote collection.

Specified by:

releaseLock in interface SyncTemplate