Sync Plugin

Collaboration diagram for Sync Plugin:

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

Detailed Description

Sync Interface: Sync

Overview

The Sync plugin interface provides all the required functionalities to synchronize PIM Items (OpenAB::PIMItem) from either between Source (OpenAB_Source::Source) and Storage (OpenAB_Storage::Storage) or two Storage plugins. Sync plugins are expected to add/remove/modify contents of Storage based on Source/ another Storage data. Sync plugins are item type independent.

API Details

Sync functionalities

Synchronizing items is main functionality required from Sync:

• Sync::synchronize ( depends of support of them in used OpenAB_Source::Source plugin):
• Sync::suspend ( Sync::resume)
• Sync::cancel ( Sync::init)

initialization will use parameters provided during creation of Sync instance (Parameters, OpenAB::PluginManager::getPluginInstance). Each Sync plugin can have its own specific parameters (please refer to given plugin documentation). Sync plugins configuration need to provide parameters for source and storage plugins (please refer to given plugin documentation if local and/or remote source/storage parameters are mandatory):

• "source_plugin" key with name of OpenAB_Source::Source plugin to be used
• Parameters::sourcePluginParams ( Parameters::storagePluginParams)

Next step is the definition of synchronization phases using functions:

• Sync::addPhase ( Sync::clearPhases)

At least one phase needs to be defined. After that synchronization can be started using Sync::synchronize function. If "cb" parameter was provided with valid instance of Sync::SyncCallback it will be notified about progress and results of synchronization.