org.openmobileis.synchro.openmsp.client.OpenMSPSynchroManager Class Reference

Inheritance diagram for org.openmobileis.synchro.openmsp.client.OpenMSPSynchroManager:

org.openmobileis.synchro.client.SynchroProcessor

List of all members.


Detailed Description

Title: OpenMobileIS project source
Description: Default SynchroManager for OpenMSP protocol.

Author:
Philippe Delrieu
Since:
JDK 1.1
Version:
1.0.

Definition at line 62 of file OpenMSPSynchroManager.java.


Public Member Functions

Array getAllListeners ()
 Return an Array of all the listeners contains.
OpenMSPSyncListener getListenerByName (String listenerName)
 Return the registered listener with specified name.
boolean removeListenerByName (String listenerName)
 Remove the listener with the specified name.
void inactivateListenerByName (String listenerName)
 Inactivate the specified listener name.
void activateListenerByName (String listenerName)
 Activate the specified listener name.
OpenMSPSyncListener getModuleListenerByName (String listenerName)
 Return the registered module listener with specified name.
synchronized void restartSynchro ()
 restart the synchro when the current synchro finish.
void registerSynchroListenerAddNotifier (SynchroListenerAddNotifier listener)
 register a listener that will be notified when a synchrolistener is added.
void addListener (OpenMSPSyncListener listener, String[] depends)
 register a new listener and its depends that will participate to the synchro.
void addModuleListener (OpenMSPSyncListener listener, String[] depends)
 register a new listener and its depends that will participate to the module synchro.
String getSynchroUserAgent (SynchroDescriptor descriptor)
 return the user agent to use with synchronisation.

Member Function Documentation

Array org.openmobileis.synchro.openmsp.client.OpenMSPSynchroManager.getAllListeners (  ) 

Return an Array of all the listeners contains.

Returns:
array of listeners Added by Manuel GOMEZ

Definition at line 129 of file OpenMSPSynchroManager.java.

References org.openmobileis.synchro.openmsp.client.core.ListenerOrdonancer.getAllListeners().

OpenMSPSyncListener org.openmobileis.synchro.openmsp.client.OpenMSPSynchroManager.getListenerByName ( String  listenerName  ) 

Return the registered listener with specified name.

Parameters:
listenerName 
Returns:
registered listener with specified name.

Definition at line 138 of file OpenMSPSynchroManager.java.

References org.openmobileis.synchro.openmsp.client.core.ListenerOrdonancer.getListenerByName().

boolean org.openmobileis.synchro.openmsp.client.OpenMSPSynchroManager.removeListenerByName ( String  listenerName  ) 

Remove the listener with the specified name.

It remove all dependent listener too. Return a boolean to inform the succed or not of the remove operation

Parameters:
listenerName 
Returns:
succed or not boolean

Definition at line 148 of file OpenMSPSynchroManager.java.

References org.openmobileis.synchro.openmsp.client.core.ListenerOrdonancer.removeListenerByName().

void org.openmobileis.synchro.openmsp.client.OpenMSPSynchroManager.inactivateListenerByName ( String  listenerName  ) 

Inactivate the specified listener name.

Depend listener are not Inactivate

Parameters:
listenerName 
Returns:
succed or not boolean

Definition at line 157 of file OpenMSPSynchroManager.java.

void org.openmobileis.synchro.openmsp.client.OpenMSPSynchroManager.activateListenerByName ( String  listenerName  ) 

Activate the specified listener name.

Depend listener are not Activate if previously inactivate

Parameters:
listenerName 
Returns:
succed or not boolean

Definition at line 166 of file OpenMSPSynchroManager.java.

OpenMSPSyncListener org.openmobileis.synchro.openmsp.client.OpenMSPSynchroManager.getModuleListenerByName ( String  listenerName  ) 

Return the registered module listener with specified name.

Module listener participate to module synchro Module synchro is the synchro of module specific files to manage module update.

Parameters:
listenerName 
Returns:

Definition at line 178 of file OpenMSPSynchroManager.java.

References org.openmobileis.synchro.openmsp.client.core.ListenerOrdonancer.getListenerByName().

synchronized void org.openmobileis.synchro.openmsp.client.OpenMSPSynchroManager.restartSynchro (  ) 

restart the synchro when the current synchro finish.

Only effectiveif call during a synchronization.

Definition at line 185 of file OpenMSPSynchroManager.java.

void org.openmobileis.synchro.openmsp.client.OpenMSPSynchroManager.addListener ( OpenMSPSyncListener  listener,
String[]  depends 
)

register a new listener and its depends that will participate to the synchro.

Listener's depends are an array of listener name that must be synchronized before the new listener. There is no specific order to register the listener and its dependance. If the SynchroListenerAddNotifier is registered the listener is registered only if the isBlocking() call return true. In other case nothing is done. The listener initListener() method is call before in all case.

Parameters:
listener : listener to register
depends : list of listener name

Definition at line 329 of file OpenMSPSynchroManager.java.

References org.openmobileis.synchro.openmsp.client.core.ListenerOrdonancer.addListener(), org.openmobileis.synchro.openmsp.client.OpenMSPSyncListener.initListener(), org.openmobileis.database.fastobjectdb.synchro.client.SynchroListenerAddNotifier.isBlocking(), and org.openmobileis.database.fastobjectdb.synchro.client.SynchroListenerAddNotifier.notifyAddListener().

void org.openmobileis.synchro.openmsp.client.OpenMSPSynchroManager.addModuleListener ( OpenMSPSyncListener  listener,
String[]  depends 
)

register a new listener and its depends that will participate to the module synchro.

Module synchro is the synchro of module specific files to manage module update. Listener's depends are an array of listener name that must be synchronized before the new listener. Thier is no specific order to register the listener and its dependance.

Parameters:
listener : listener to register
depends : list of listener name

Definition at line 360 of file OpenMSPSynchroManager.java.

References org.openmobileis.synchro.openmsp.client.core.ListenerOrdonancer.addListener().

String org.openmobileis.synchro.openmsp.client.OpenMSPSynchroManager.getSynchroUserAgent ( SynchroDescriptor  descriptor  ) 

return the user agent to use with synchronisation.

The user agent can be defined with the property org.openmobileis.synchro.direct.useragent. or if not set, it's constructed with plateform information. default user agent : OpenMSPPlug-<OpenMobileISMajorVersion>.<OpenMobileISMinorVersion>-<OS>[<OSVersion>]-<user language>="">-<synchro type="" if="" present>=""> The synchro type is defined with the property OpenMSPsynchrotype of the descriptor.

Returns:

Definition at line 407 of file OpenMSPSynchroManager.java.

References org.openmobileis.common.context.Plateform.getOpenMobileISMajorVersion(), org.openmobileis.common.context.Plateform.getOpenMobileISMinorVersion(), org.openmobileis.common.context.Plateform.getOS(), org.openmobileis.common.context.Plateform.getOSVersion(), and org.openmobileis.synchro.client.SynchroDescriptor.getProperty().


The documentation for this class was generated from the following file:
Generated on Mon Jan 11 21:19:22 2010 for OpenMobileIS by  doxygen 1.5.4