org.openmobileis.modules.common.log.terminal.LogsSynchroListener Class Reference

Inheritance diagram for org.openmobileis.modules.common.log.terminal.LogsSynchroListener:

org.openmobileis.synchro.openmsp.client.OpenMSPSyncListener List of all members.

Detailed Description

Title: OpenMobileIS project source
Description: mail synchro listeners.

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

Definition at line 63 of file LogsSynchroListener.java.

Public Member Functions

 LogsSynchroListener ()
void initListener () throws OpenMSPException
 Call during listener registering.
void setSynchroStatus (int status)
int getSynchroStatus ()
 Return the synchro status of the listener.
boolean isSyncOK ()
 return true if the synchronisation is OK for the listener.
void notifySynchroFailure ()
 The listener is called if the syncML command processing failed.
void receiveStatusCommand (Status statusCommande, ContainerMessage initialCommand) throws OpenMSPException
 Event sent when the sync manager receives STATUS openML messages from the server.
void sendData (Message message) throws OpenMSPException
 Event sent when the sync manager sends a openML message to the server The specified message is the message use to construct the synchro message This method fill the message with listener commande container.
void receiveSyncCommand (ContainerMessage syncContainer, long newSyncNumber) throws OpenMSPException
 Event sent when the sync manager receives Sync command openML messages from the server.
void receiveMapCommand (ContainerMessage mapContainer) throws OpenMSPException
 Event sent when the sync manager receives MAP command openML messages from the server.
void receiveResultCommand (ContainerMessage resultContainer, ContainerMessage initialCommand) throws OpenMSPException
 Event sent when the sync manager receives RESULT openML messages from the server.
void receiveGetCommand (Credential cred, ContainerMessage replaceContainer, long newSyncNumber) throws OpenMSPException
 Call when the server answer container contains a GET command.
String getSyncName ()
 Return the name used to identiy the of the listener in the synchro processus.
void startSync (Credential cred, SynchroDescriptor synchrodescriptor) throws OpenMSPException
 Fire this event once a synchro is starting.
void endSync ()
 Fire this event once the current synchro is ended.
int getErrorStatus ()
 
Returns:


Static Public Attributes

static final String LOG_LISTENER_NAME = "FWKLogSynchroListener"


Member Function Documentation

void org.openmobileis.modules.common.log.terminal.LogsSynchroListener.initListener (  )  throws OpenMSPException

Call during listener registering.

The init occurs before the synchronisation. If an exception is throws the listener is not registered.

Exceptions:
ServiceException 

Implements org.openmobileis.synchro.openmsp.client.OpenMSPSyncListener.

Definition at line 78 of file LogsSynchroListener.java.

References org.openmobileis.modules.common.log.terminal.LogsSynchroListener.getSyncName().

int org.openmobileis.modules.common.log.terminal.LogsSynchroListener.getSynchroStatus (  ) 

Return the synchro status of the listener.

The return value is defined by the OpenMSP Status class.

See also:
org.openmobileis.synchro.openmsp.protocol.Status

Implements org.openmobileis.synchro.openmsp.client.OpenMSPSyncListener.

Definition at line 92 of file LogsSynchroListener.java.

void org.openmobileis.modules.common.log.terminal.LogsSynchroListener.receiveStatusCommand ( Status  statusCommande,
ContainerMessage  initialCommand 
) throws OpenMSPException

Event sent when the sync manager receives STATUS openML messages from the server.

Parameters:
Status statusCommande : resultCommande containing the Status of a command
long newSessionID : the session id use for this synchro for this listener message.
ContainerMessage : command sent that generate the status.

Implements org.openmobileis.synchro.openmsp.client.OpenMSPSyncListener.

Definition at line 105 of file LogsSynchroListener.java.

References org.openmobileis.modules.common.log.terminal.LogsSynchroListener.getSyncName().

void org.openmobileis.modules.common.log.terminal.LogsSynchroListener.receiveSyncCommand ( ContainerMessage  syncContainer,
long  newSyncNumber 
) throws OpenMSPException

Event sent when the sync manager receives Sync command openML messages from the server.

Parameters:
ContainerMessage container : container containing the message
long newSessionID : the session id use for this synchro for this listener message.

Implements org.openmobileis.synchro.openmsp.client.OpenMSPSyncListener.

Definition at line 162 of file LogsSynchroListener.java.

void org.openmobileis.modules.common.log.terminal.LogsSynchroListener.receiveMapCommand ( ContainerMessage  mapContainer  )  throws OpenMSPException

Event sent when the sync manager receives MAP command openML messages from the server.

Parameters:
ContainerMessage container : container containing the message
long newSessionID : the session id use for this synchro for this listener message.

Implements org.openmobileis.synchro.openmsp.client.OpenMSPSyncListener.

Definition at line 171 of file LogsSynchroListener.java.

void org.openmobileis.modules.common.log.terminal.LogsSynchroListener.receiveResultCommand ( ContainerMessage  resultContainer,
ContainerMessage  initialCommand 
) throws OpenMSPException

Event sent when the sync manager receives RESULT openML messages from the server.

Parameters:
Result resultCommande : resultCommande containing the result of a command
long newSessionID : the session id use for this synchro for this listener message.
ContainerMessage : command sent that generate the status.

Implements org.openmobileis.synchro.openmsp.client.OpenMSPSyncListener.

Definition at line 181 of file LogsSynchroListener.java.

void org.openmobileis.modules.common.log.terminal.LogsSynchroListener.receiveGetCommand ( Credential  cred,
ContainerMessage  replaceContainer,
long  newSyncNumber 
) throws OpenMSPException

Call when the server answer container contains a GET command.

Extends this method to process GET command.

Parameters:
ContainerMessage container : container containing the GET message
long newSyncNumber : the synchro number use for this synchro for this listener message.
Credential cred : the credential is any added in the GET command.

Implements org.openmobileis.synchro.openmsp.client.OpenMSPSyncListener.

Definition at line 185 of file LogsSynchroListener.java.

String org.openmobileis.modules.common.log.terminal.LogsSynchroListener.getSyncName (  ) 

Return the name used to identiy the of the listener in the synchro processus.

This name correspond to the source in the OpenMS protocol.

Implements org.openmobileis.synchro.openmsp.client.OpenMSPSyncListener.

Definition at line 194 of file LogsSynchroListener.java.

Referenced by org.openmobileis.modules.common.log.terminal.LogsSynchroListener.endSync(), org.openmobileis.modules.common.log.terminal.LogsSynchroListener.initListener(), org.openmobileis.modules.common.log.terminal.LogsSynchroListener.receiveStatusCommand(), and org.openmobileis.modules.common.log.terminal.LogsSynchroListener.startSync().


The documentation for this class was generated from the following file:
Generated on Mon Dec 4 11:03:40 2006 for OpenMobileIS by  doxygen 1.5.1-p1