org.jSyncManager.Client

Class ApplicationJFrame

Implemented Interfaces:
ActionListener, WindowListener, SynchronizerListener, TransportChangedListener

public final class ApplicationJFrame
extends JFrame
implements WindowListener, SynchronizerListener, TransportChangedListener, ActionListener

The main jSyncManager Frame. This class contains the main jSyncManager Swing GUI frame.

Constructor Summary

ApplicationJFrame(RegistrationData preferences)
Creates the main jSyncManager application frame, using the specified user preferences object.

Method Summary

void
actionPerformed(ActionEvent ae)
The action event handler method.
void
changeTransport(SLPTransportInterface t)
This method will be called when the used has changed their transport class.
void
endOfSync(Synchronizer s)
This message is called by the Synchronizer instance specified when it has completed a synchronization.
java.util.Vector
getConduits(Synchronizer s)
Retrieves a Vector object containing the active instances of the conduits to be synchronized.
AbstractConduit
getDefaultConduit(Synchronizer s)
Retrieves the DefaultConduit object to be used at the end of a standard sync.
DLPUserInfo
getNewUserInfo(Synchronizer s)
Requests new user information from the sync application.
File
getRestoreDatabasePath()
Gets the database set to be used for the restore operation.
int
getSyncType(Synchronizer s)
Retrieves the type of synchronization to perform.
void
midSync(Synchronizer s)
This message is called by the Synchronizer instance specified when it has reached the mid-point of a synchronization job.
void
processUser(DLPUserInfo userInfo, Synchronizer s)
Gives the application a chance to process the user info for the handhelds owner.
void
startOfSync(Synchronizer s)
This message is called by the Synchronizer instance specified when it has began a synchronization job.
boolean
useTimeSync(Synchronizer s)
Requests wether or not date and time synchronization should be used at sync time.
boolean
validateUser(DLPUserInfo user, String serialNumber, Synchronizer s)
Requests user validation from the implementing application.
void
windowActivated(WindowEvent windowevent)
Method to handle events for the WindowListener interface.
void
windowClosed(WindowEvent windowevent)
Method to handle events for the WindowListener interface.
void
windowClosing(WindowEvent windowevent)
Method to handle events for the WindowListener interface.
void
windowDeactivated(WindowEvent windowevent)
Method to handle events for the WindowListener interface.
void
windowDeiconified(WindowEvent windowevent)
Method to handle events for the WindowListener interface.
void
windowIconified(WindowEvent windowevent)
Method to handle events for the WindowListener interface.
void
windowOpened(WindowEvent windowevent)
Method to handle events for the WindowListener interface.

Constructor Details

ApplicationJFrame

public ApplicationJFrame(RegistrationData preferences)
            throws Exception
Creates the main jSyncManager application frame, using the specified user preferences object.
Parameters:
preferences - the user application preferences object to use.

Method Details

actionPerformed

public void actionPerformed(ActionEvent ae)
The action event handler method.
Parameters:
ae - the ActionEvent to be handled.

changeTransport

public void changeTransport(SLPTransportInterface t)
This method will be called when the used has changed their transport class.
Specified by:
changeTransport in interface TransportChangedListener
Parameters:
t - the new Transport instance to be used.

endOfSync

public void endOfSync(Synchronizer s)
This message is called by the Synchronizer instance specified when it has completed a synchronization.
Specified by:
endOfSync in interface SynchronizerListener
Parameters:
s - a reference to the Synchronizer that has completed a sync job.

getConduits

public java.util.Vector getConduits(Synchronizer s)
Retrieves a Vector object containing the active instances of the conduits to be synchronized. Conduits are only used during a standard sync. This method is not called for a backup or restore sync.
Specified by:
getConduits in interface SynchronizerListener
Parameters:
s - a reference to the Synchronizer that has completed a sync job.
Returns:
a Vector object containing the active instances of the conduits to be synchronized.

getDefaultConduit

public AbstractConduit getDefaultConduit(Synchronizer s)
Retrieves the DefaultConduit object to be used at the end of a standard sync.
Specified by:
getDefaultConduit in interface SynchronizerListener
Parameters:
s - a reference to the Synchronizer that has completed a sync job.
Returns:
the DefaultConduit object to be used at the end of a standard sync.

getNewUserInfo

public DLPUserInfo getNewUserInfo(Synchronizer s)
Requests new user information from the sync application. If the Synchronizer engine determines that the handheld contains no user information, it will request that the application provide the necessary information so it may be written to the handheld. For applications that can't handle this (such as remote servers), return null to inform the Synchronizer that it should reject this user.
Specified by:
getNewUserInfo in interface SynchronizerListener
Parameters:
s - a reference to the Synchronizer that has completed a sync job.
Returns:
a DLPUserInfo object describing the new user, or null.

getRestoreDatabasePath

public File getRestoreDatabasePath()
Gets the database set to be used for the restore operation. If the sync type equals Synchronizer.RESTORE_SYNC, this method will be called at sync time to retreive the DLPDatabaseSet containing the databases to be restored.
Specified by:
getRestoreDatabasePath in interface SynchronizerListener
Returns:
the DLPDatabaseSet object containing the databases to be restored.

getSyncType

public int getSyncType(Synchronizer s)
Retrieves the type of synchronization to perform. Valid return values include Synchronizer.NORMAL_SYNC, Synchronizer.BACKUP_SYNC, and Synchronizer.RESTORE_SYNC.
Specified by:
getSyncType in interface SynchronizerListener
Parameters:
s - a reference to the Synchronizer that has completed a sync job.
Returns:
the type of synchronization to perform.

midSync

public void midSync(Synchronizer s)
This message is called by the Synchronizer instance specified when it has reached the mid-point of a synchronization job. The mid-point is defined to be after all user, system, and database info has been read, date and time synchronized (as requested), but before the main synchronization task has begun.
Specified by:
midSync in interface SynchronizerListener
Parameters:
s - a reference to the Synchronizer that has reached the mid-point of a sync job.

processUser

public void processUser(DLPUserInfo userInfo,
                        Synchronizer s)
Gives the application a chance to process the user info for the handhelds owner. Processing of this information is application-specific. An application may simply return from this method with no penalty.
Specified by:
processUser in interface SynchronizerListener
Parameters:
userInfo - the DLPUserInfo object for the currently synchronizing handheld.
s - a reference to the Synchronizer that has completed a sync job.

startOfSync

public void startOfSync(Synchronizer s)
This message is called by the Synchronizer instance specified when it has began a synchronization job.
Specified by:
startOfSync in interface SynchronizerListener
Parameters:
s - a reference to the Synchronizer that has started a sync job.

useTimeSync

public boolean useTimeSync(Synchronizer s)
Requests wether or not date and time synchronization should be used at sync time. Date and Time sync will write the sync hosts current date and time to the handheld. Note however that some users may not desire this functionality, particularily if their handheld is in a different timezone than the system they're syncing against. This method allows the application to provide the user with such a choice. Note that the user shouldn't be interrupted at sync time with this question -- it should be something they are required to set/unset prior to synchronization.
Specified by:
useTimeSync in interface SynchronizerListener
Parameters:
s - a reference to the Synchronizer that has completed a sync job.
Returns:
true if the date/time should be synchronized, false otherwise.

validateUser

public boolean validateUser(DLPUserInfo user,
                            String serialNumber,
                            Synchronizer s)
Requests user validation from the implementing application.
Specified by:
validateUser in interface SynchronizerListener
Parameters:
user - the DLPUserInfo object to validate.
serialNumber - the serial number of the connecting device.
s - a reference to the active Synchronizer.
Returns:
true, as this implementation always permits synchronization.

windowActivated

public void windowActivated(WindowEvent windowevent)
Method to handle events for the WindowListener interface.
Parameters:
windowevent - java.awt.event.WindowEvent.

windowClosed

public void windowClosed(WindowEvent windowevent)
Method to handle events for the WindowListener interface.
Parameters:
windowevent - java.awt.event.WindowEvent.

windowClosing

public void windowClosing(WindowEvent windowevent)
Method to handle events for the WindowListener interface.
Parameters:
windowevent - java.awt.event.WindowEvent.

windowDeactivated

public void windowDeactivated(WindowEvent windowevent)
Method to handle events for the WindowListener interface.
Parameters:
windowevent - java.awt.event.WindowEvent.

windowDeiconified

public void windowDeiconified(WindowEvent windowevent)
Method to handle events for the WindowListener interface.
Parameters:
windowevent - java.awt.event.WindowEvent.

windowIconified

public void windowIconified(WindowEvent windowevent)
Method to handle events for the WindowListener interface.
Parameters:
windowevent - java.awt.event.WindowEvent.

windowOpened

public void windowOpened(WindowEvent windowevent)
Method to handle events for the WindowListener interface.
Parameters:
windowevent - java.awt.event.WindowEvent.