Building jSyncManager From A Source Package

Pre-requisites

The build environment is Jakarta ANT-driven - so you will need to have the ANT libraries on your system.  The ANT version we're currently supporting is 1.5.1.  You can get ANT at http://jakarta.apache.org/ant/.

• JAVA_HOME points to your jdk installation root directory
• JRE_HOME points to your jre installation root directory (could also point to JAVA_HOME/jre)
• ANT_HOME points to your ANT installation root directory

If you are using JDK 1.3.x (or earlier), you will need to download an XML Parser in order to compile successfully. We recommend using the Apache Project's Xerces2 Java-based XML Parser available from http://xml.apache.org/xerces2-j/index.html. If you are using JDK 1.4 (or higher), you will not require any other external 3rd party libraries to build the core jSyncManager classes. However, if you plan to build the USB or Serial Transport classes, you will need to obtain jUSB or javax.comm.* packages respectively.

Getting Started

In the root directory of the jsyncmanager module, there is a script called antmake.cmd (or antmake.sh for Un*x).  This is the only script you will need to invoke various different ANT targets.  The usage is as follows:

• antmake [target1] [target2] [target3]

If you do not provide a target, the script would automatically invoke the default target which, in our case, is the compile target (it compiles all files).

To see a list of all major targets, simple use the following command:

• antmake -projecthelp

Compiling the Source

There are several compile targets.  All compilation output goes to the build directory, which is automatically created during compilation.

To compile the USB related classes only (requires additional libraries - see pre-requisities above), simply invoke

• antmake compile.usb

To compile the Serial related classes only (requires additional libraries - see pre-requisities above), simply invoke

• antmake compile.serial

To compile the core jSyncManager classes only, simply invoke:

• antmake compile.core

Note: The classes (or pattern of classes) to be included during compilation are listed in buildtools\conf\usb.inc and buildtools\conf\serial.inc for USB-related and Serial-related respectively.  The "core" classes are any classes other than the classes (or pattern of classes) in the above-mentioned files.

To compile ALL classes, simply invoke:

• antmake

To clean up any previous compilation results, simply invoke:

• antmake clean

which would delete the build directory and everything in it.

Generating Javadocs

The javadocs get generated by using the javadoc target.  The javadocs are outputted to the build\apidocs directory, and can be cleaned by using the clean.javadoc target.

Anuj Agrawal