Introduction

Ant tool is used to compile and manage project files. GC100 Targets uses ant script for the following tasks.

• Creating Tomcat Web project (UCH) structure under directory '[TOMCAT_HOME]/webapps'.
• Compiling all Java files under the directory 'GC100 Targetsdev/src' and put generated class files in same directory.
• Creating Java Archive(.jar) files from compiled class files.
• Coping required files to Tomcat directory([TOMCAT_HOME]/webapps/UCH) from project directory (GC100 Targets).
• Creating Web Archive (.war) file.
• Creating Java Docs for Java classes.
• Creating Zip file for GC100 Targets project.

Ant script file is located at: build.xml

GC100 ANT Usage:

1. Target: "init"

   Create directory structure like a Tomcat Project at [TOMCAT_HOME]/webapps if it does not exist.

   [TOMCAT_HOME]/webapps/UCH/WEB-INF/lib

2. Target: "compile-all"

   Compile all the .java files of the directory GC100Targets/dev/src recursively and create the .class files at the same location.

3. Target: "make-jar"

   Create gclib.jar file which contains .class files of the packages:

   • edu.wisc.trace.uch.tdm.gc100.lib
   • edu.wisc.trace.uch.tdm.gc100.lib.util

   Create gctdm.jar file which contains .class files of the packages:

   • edu.wisc.trace.uch.tdm.gc100
   • edu.wisc.trace.uch.tdm.gc100.action

   Create gcirta.jar file which contains .class files of the package and its sub packages:

   • edu.wisc.trace.uch.ta.gc100.ir.generic

   Create gcserialta.jar file which contains .class files of the package and its sub packages:

   • edu.wisc.trace.uch.ta.gc100.serial.generic

   Create gcrelayta.jar file which contains .class files of the package and its sub packages:

   • edu.wisc.trace.uch.ta.gc100.relay.generic

   Put all the created jar files in UCH/bin directory.

4. Target: "copy-to-tomcat"

   In this process files from other projects are being pulled in.

   Required Files:

   • Copy the file web.xml from GC100Targets directory to [TOMCAT_HOME]/webapps/UCH/WEB-INF directory.
   • Copy the files license.txt, GC100Targets-ReleaseNotes.php and 3rdPartyLicenses.php from GC100Targets directory to [TOMCAT_HOME]/webapps/UCH directory.

   GC100 Files:

   • Copy the jar files clink.jar, jmdns.jar, xercesImpl.jar, uch.jar, urchttpuipm.jar from GC100Targets/dev/lib and soap-2.3.1.jar, servlet-api.jar from GC100Targets/dev/lib/ext to [TOMCAT_HOME]/webapps/UCH/WEB-INF/lib directory.

   Delete/Create Files from cache directory:

   • Delete all files from [TOMCAT_HOME]/webapps/cache directory. If it is not exists then create it.
5. Target: "uch-war"

   Create a UCH.war file and copy it to GC100Targets/bin directory.

   UCH.war contains following contents

   [TOMCAT_HOME]/webapps/UCH/**

   NOTE: ** - all files, directories with sub-directories and files of that directory.

• Target: "javadoc"

  Create Java documentation for all the classes and packages and put them under GC100Targets/doc directory.

• Target: "gc100_zip"

  Create a gc100.zip file at GC100Targets/zip which contains following contents

  • GC100Targets/GC100Targets-ReleaseNotes.php
  • GC100Targets/3rdPartyLicenses.php
  • GC100Targets/license.txt
  • GC100Targets/LicenseAgreement.php
  • GC100Targets/dev/*
  • GC100Targets/dev/src/**
  • GC100Targets/dev/lib/ext/**
  • GC100Targets/dev/lib/ext/**/Readme.*
  • GC100Targets/doc/**
  • GC100Targets/tutorial/**
  • GC100Targets/bin/gc100.war
  • NOTE: * - all files of that directory only.
  • ** - all files, directories with sub-directories and files of that directory.

  Don't include following contents

  • **/.*
  • dev/lib/ext/**
  • **/*.class
  • keystore/**
  • dev/bin/**
  • zip/**
  • **/*.bak
  • **/.cvsignore
  • dev/*.builddate
  • res/**
  • NOTE: * - all files of that directory only.
  • ** - all files, directories with sub-directories and files of that directory.

Last update: Parikshit Thakur & Team, 2010-04-13