Classes needed by the Sync Engine providersAdded by IBM on October 5, 2011 | Version 1 (Original)
|This section identifies the basic classes that are used when providing a new Sync Engine and SyncService. This is not an exhaustive list of all classes that could be used, but rather a list of the classes referred to in the following sections. Additional classes may be used in other circumstances. Refer to the Javadoc for more detailed information on the classes and the methods provided.
This section identifies the basic classes that are used when providing a new Sync Engine and SyncService. This is not an exhaustive list of all classes that could be used, but rather a list of the classes referred to in the following sections. Additional classes may be used in other circumstances. Refer to the Javadoc for more detailed information on the classes and the methods provided.
The following classes are the basic classes and interfaces that are used when creating and providing a Sync Engine to plug into the Sync Manager framework.
Parent topic: Contributing a new Sync Engine
- com.ibm.rcp.sync.service.sync.SyncServiceFactory - Factory interface to return a specific instance of a SyncService
- com.ibm.rcp.sync.service.sync.SyncService - Interface class implemented by the Sync Engine provider. This implementation class bridges between the SyncManager implementation and the Sync Engine. The SyncService is responsible for creating default and real instances of the SUSyncData implementation class. Interactions with the SyncService are with the SUSyncData and the URI. The SyncService may sync one or more types. The types may be defined by one or more TypeServices. However, as noted above, a type defined by a TypeService can be synced by one and only one SyncService.
- com.ibm.rcp.sync.service.sync.SUSyncData - An interface class implemented by the SyncService/Sync Engine provider that contains data specific to the service/engine. The SUSyncData implementation contains the URI necessary to identify a particular synchronization task/resource.
- com.ibm.rcp.sync.service.type.TypeServiceFactory - Factory interface to return a specific instance of a TypeService
- com.ibm.rcp.sync.service.type.TypeService - Interface class implemented by the Sync Engine provider. The TypeService is responsible for creating SyncUnit implementations.
- com.ibm.rcp.sync.service.sync.BaseSyncUnit - The base class that must be extended by the Sync Engine provider to enable synchronization tasks to be created. This class also implements com.ibm.rcp.sync.manager.SyncUnit. The SyncUnit implementation has a 1:1 relationship with the SUSyncData implementation (through the BaseSyncUnit class). The primary consumers of the SyncUnit are the Sync UI and the Scheduler. Some code must request the creation of template SyncUnits from the Sync Manager, update the template and then add it to the Sync Manager. The SyncUnit (via the BaseSyncUnit class) has references to data for the Sync Manager itself, and to the data for the SyncService implementation (in the form of the SUSyncData), but otherwise the SyncUnit implementation is primarily a wrapper to get/set data on the contained SUSyncData , and should not contain any fields, as they will not be able to be transferred from template to concrete instance.
- com.ibm.rcp.sync.manager.event.SyncEventFactory - Creates instances of SyncEvents that are to be passed to SyncEventListeners
- com.ibm.rcp.sync.manager.event.SyncEvent - The interface implemented by all events that are passed. Specific implementations are created by the SyncEventFactory.
- com.ibm.rcp.sync.manager.event.EventType - The class that provides the event identity for a SyncEvent
- com.ibm.rcp.sync.manager.util.SyncEventSource - A utility class that provides listener management and notification helper methods.
- com.ibm.rcp.sync.manager.event.context.SyncUnitContext - Context container for a SyncUnit. This will be created by the SyncEventFactory if supplying a SyncUnit as the context object.
- com.ibm.rcp.sync.manager.event.context.ErrorContext (interface) - An instance of the ErrorContext is created by the SyncEventFactory when calling createSyncErrorEvent
- com.ibm.rcp.sync.manager.event.context.ProgressContext (interface) - concrete implementation is SyncUnitProgress