org.jSyncManager.API.Conduit
Class AbstractConduit
java.lang.Objectorg.jSyncManager.API.Conduit.AbstractConduit
- Serializable
public abstract class AbstractConduit
extends java.lang.Object
implements Serializable
The abstract class representing a jConduit. All jConduits are derived from this class.
static int | CANCEL_BUTTON_PRESSED- A useful constant to denote when the parent settings dialogs
Cancel or Close buttons have been pressed.
|
static int | HELP_BUTTON_PRESSED- A useful constant to denote when the parent settings dialogs
Cancel or Close buttons have been pressed.
|
static byte | HIGH_PRIORITY- A useful constant denoting high jConduit priority.
|
static byte | LOW_PRIORITY- A useful constant denoting low jConduit priority.
|
static byte | NORMAL_PRIORITY- A useful constant denoting normal jConduit priority.
|
static int | OK_BUTTON_PRESSED- A useful constant to denote when the parent settings dialogs
OK button has been pressed.
|
protected JPanel | configurationPanel- Used to hold a local handle to a conduit configuration panel.
|
protected ResourceBundle | resources- A field to hold a resource bundle for this conduit, if available.
|
CANCEL_BUTTON_PRESSED
public static final int CANCEL_BUTTON_PRESSED
A useful constant to denote when the parent settings dialogs
Cancel or Close buttons have been pressed.
HELP_BUTTON_PRESSED
public static final int HELP_BUTTON_PRESSED
A useful constant to denote when the parent settings dialogs
Cancel or Close buttons have been pressed.
HIGH_PRIORITY
public static final byte HIGH_PRIORITY
A useful constant denoting high jConduit priority.
LOW_PRIORITY
public static final byte LOW_PRIORITY
A useful constant denoting low jConduit priority.
NORMAL_PRIORITY
public static final byte NORMAL_PRIORITY
A useful constant denoting normal jConduit priority.
OK_BUTTON_PRESSED
public static final int OK_BUTTON_PRESSED
A useful constant to denote when the parent settings dialogs
OK button has been pressed.
configurationPanel
protected JPanel configurationPanel
Used to hold a local handle to a conduit configuration panel.
resources
protected ResourceBundle resources
A field to hold a resource bundle for this conduit, if available.
AbstractConduit
public AbstractConduit()
The constructor used to initialize new jConduits.
The default implementation does nothing. You should ensure that if your jConduit
requires initialization when it is first installed, that this constructor is overridden.
Note that the default implementation of the jConduit loader will only call the no-parameter
constructor. if you provide constructors that take parameters, they will not be called by
the jConduit initializer.
constructConfigPanel
protected abstract JPanel constructConfigPanel()
Constructs a configuration panel for this jConduit.
If your jConduit requires user supplied configuration information, you may
construct a JPanel here to be associated with your jConduit, which GUI applications can use
to display to the user prior to synchronization. How this panel is accessed will be
application specific. You may return null here to signify that no setting panel is required.
- a JPanel containing whatever configuration widgets your jConduit requires.
doInitialization
protected void doInitialization()
Perform this jconduit's initialization tasks.
Initialization is done when a jConduit is loaded after serialization, and
gives the jConduit developer the opportunity to open files, prepare data sources,
or perform other tasks prior to synchronization.
Initialization is done just once per jConduit, either after it's been constructed,
or after it's been deserialized. jConduit developers should override this method if they
wish to perform any initialization tasks, otherwise the default is to do nothing.
getConduitDescription
public final String getConduitDescription()
throws MissingResourceExceptionReturns the description of this jConduit for display.
The description should be a single line of text, with no breaks.
It is up to the displaying application to provide proper word-wrapping.
- the description of this jConduit. Note that this method will use the
jConduit provided resource class to retreive the description, using the "conduit.description" key.
getConduitName
public final String getConduitName()
throws MissingResourceExceptionReturns the name of this jConduit for display.
The name should be a single line of text, with no breaks.
The text will be used by GUI applications for menus, tab labels, etc.
Hence, it should be short but descriptive. For a longer description, use
getConduitDescription(). Note that this method will use the
provided resource class to retreive the name, using the "conduit.name" key.
- the name of this jConduit.
getConduitResourceBundle
protected final ResourceBundle getConduitResourceBundle()
throws MissingResourceExceptionLoads the resource bundle named by the getResourceBundleName method.
If the getResourceBundleName method returns null, or if it can't be loaded,
this method will throw a MissingResourceException.
- the ResourceBundle object for this conduits resources.
getConfigurationPanel
public final JPanel getConfigurationPanel()
Retrieves the configuration panel for this jConduit.
This configuration panel should be constructed by the constructConfigPanel method.
This method will call constructConfigPanel if the configurationPanel field is null.
This is done as configurationPanel is a transient field, so as to prevent it from being
serialized. This will cause the constructConfigPanel method to be called
every time this method is called if constructConfigPanel returns null, however
this behaviour won't impact performance due to the very few instructions added to accomplish
this. We'll save instructions in the long run for jConduits that do provide a configuration panel.
- a JPanel containing whatever configuration widgets your jConduit requires.
getPriority
public byte getPriority()
This method returns the jConduits priority byte.
The priority byte is used to determine when a jConduit should be run during synchronization.
The value is a signed byte, with 127 being highest priority, and -128 the lowest.
jConduits with a higher priority will be run first. jConduits with the same priority are run in
an undefined order. By default, jConduits will have priority 0.
Conduits that are a part of a suite of conduits should implement descending priority values to ensure
they are run in a predetermined ordes.
Please resist the temptation to use priority 127 and -128. These should be reserved for
core jSyncManager conduits which do maintenence tasks (such as Installer and Deleter).
Using the maximum and minimum priorities may interfere with correct operation of these tools.
For convienence, AbstractConduit defines constants HIGH_PRIORITY, NORMAL_PRIORITY, and LOW_PRIORITY.
- the jConduits priority ordering byte.
getResourceBundleName
protected abstract String getResourceBundleName()
Retrieves the name of the class to use as the Conduits Resource Bundle.
This method should return a String containing the fully-qualified classname
of the class to use for this jConduits textual resources.
You may return null from this method, however if you do so you're expected to
override the getConduitName and getConduitDescription methods to return suitable data.
We suggest using Resource Bundles to ensure that your jConduits can be translated to other
languages.
- the fully-qualified classname of the class to use as this jConduits resource bundle.
initialize
public final void initialize()
Cause this conduit to be initialized.
Initialization is done when a jConduit is loaded after serialization, and
gives the jConduit developer the opportunity to open files, prepare data sources,
or perform other tasks prior to synchronization.
Initialization is done just once per jConduit, either after it's been constructed,
or after it's been deserialized.
jConduitDialogActionPerformed
public void jConduitDialogActionPerformed(int action)
Informs the jConduit of when the jConduit dialogs action buttons were pressed.
By default, this method has a null implementation, but jConduit developers can override
this in order to be informed of when one of the dialog buttons are pressed.
action - the action that was performed.
startSync
public abstract void startSync(ConduitHandler conduitHandler,
DLPUserInfo user)
throws NotConnectedExceptionThis method is called when this jConduit is given the opportunity to synchronize.
The contents of this method should use the provided ConduitHandler object to perform
any necessary data IO between the host and the handheld. If necessary, you may use the passed
DLPUserInfo object to distinguish between users.
conduitHandler - the handle to the active ConduitHandler to use for synchronization.user - the user information object for the handhelds owner.
toString
public String toString()
Returns the name of this jConduit.
- the name of this jConduit.