Developers guide

54
Once the workspace has been checked out from CVS the developer should manually edit the
build.xml (see Appendix F.2.3) file and modify the version-key property. This property is
used throughout the build process. This key must be unique, which is best achieved by simple
incrementing the version count or perhaps using the developers name.
<property name="version-key" value="test-0.96"/>
Throughout the build process, covered below, a dist/apt__V<version-key> directory is
created. This is where all the files belonging to the current version such as run scripts and
configuration files are created. Any changes, such as adding or removing files must be
reflected in modifications to the build.xml file.
To enable the application to run as an ordinary Java application locally, without deploying it,
run scripts and batch files are included in the apt__V<version-key> dir so that the versioned
clients can be run locally.
Like Make
i
, ant only compiles .java files that have changed by analysing file system time
stamps. Ant targets are executed from the command line in the form ant <target>. Each
target and its action is specified below:
clean
Deletes all the files and directories created by the build process.
init
Prepares temporary directories required for the build process.
compile-sp
Compile the SP Client to the build directory, this special target is required
due to the complex coding of the SP classes.
compile
Compile the entire apt source tree to the build directory.
apt-jar
Package the contents of the build directory into the apt__V<version-
key>.jar file. This file is created in the dist/apt__V<version-key>
directory.
config-jar
Performs String replacements to files in the config dir, copies them to the
apt__V<version-key>/config dir and packages this dir into a jar file. The
jar file is necessary so the .properties files can be used in Java Web Start.
sign-jars
Sign the jars using the aptdev certificate. Jar Signing is required for Web Start.
prepare
Performs the String replacements of files so that they contain the <version-
key> string. This is the dynamic creation of the run scripts and JNLP
configurations.
upload
Uses scp to copy the apt__V<version-key> dir to the Web Start directory in
the apt account on mcba5
upload-mistral
Uses scp to copy the apt__V<version-key> dir to the APTAutomation-
MultiVer dir on mistral. Ready to be run.
source-tar.gz
Packages the source code into to the archive apt__V<version-
key>/source-tar.gz
i
Unix Make build tool. Traditionally for compiling programs written in C