OneWay Sync Plugin

The OneWay Sync plugin is responsible to perform one-way synchronization of PIM items. More...

Collaboration diagram for OneWay Sync Plugin:

The OneWay Sync plugin is responsible to perform one-way synchronization of PIM items.

Data is synchronized between remote source and local storage. The full synchronization process consists of couple phases (defined by user), each phase consists of few steps:

• Step1: Using the OpenAB_Storage::StorageItemIterator of the Storage used, build a reference list of PIMItems to be used in the next steps to identify the modified and delete items.
• Step2: Listen the stream of PIMItems received from the Source plugin (OpenAB_Source::Source::getItem).
  • perform all the required checks to find a match in the Ztorage
  • mark the item as to be added or modified in the reference list (defined in the step 1)
  • add or modify the item using the Storage APIs (OpenAB_Storage::Storage::addItems, OpenAB_Storage::Storage::modifyItems)
• Step3: Delete all the unmarked items from the Storage (OpenAB_Storage::Storage::deleteItems)

Each phase can define PIMItem fields that should be ignored both during getting items from OpenAB_Source::Source and during comparison of them with contents of OpenAB_Storage::Storage.

Parameters

Parameters:

Type	Name	Description	Mandatory
String	"remote_plugin"	name of OpenAB_Source::Source plugin to use	Yes
Struct	remoteSourcePluginParams	parameters of OpenAB_Source::Source plugin to use	Yes
String	"local_plugin"	name of OpenAB_Storage::Storage plugin to use	Yes
Struct	localStoragePluginParams	parameters of OpenAB_Storage::Storage plugin	Yes
Pointer	"callback"	pointer to OpenAB_Sync::Sync::SyncCallback	No
Float	"sync_progress_frequency"	interval of OpenAB_Sync::Sync::SyncCallback::syncProgress() emission in seconds	No
Integer	"batch_size"	size of batches to be used on Storage operations	No

Todo:

Input: define signal for sync statistics

Add possibility to sleep after processing each item to lower CPU consumption during sync