You are here: MyURC.org > Tools & Prototypes > UCHj > tutorial > Trace UCHj - 3rd Party Licenses

Introduction

Ant tool is used to compile and manage project files. UCHj 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 'UCH/dev/src' and put generated classes file 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(UCH).
• Creating Web Archive(.war) file.
• Creating Java Documents for Java classes.
• Creating Zip file for UCH project.

Ant script is here.

Trace UCHj ANT Usage:

1. Target: "init"

   Create directory structure like a Tomcat Web Project under the directory specified by the property 'uchTomcatDir'. Most probably it is '[TOMCAT_HOME]/webapps/UCH'. Create the following directories, if they don't exist.

   • UCH/WEB-INF
   • UCH/WEB-INF/lib
   
   
2. Target: "compile-all"

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

   
   
3. Target: "make-jar"

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

   • edu.wisc.trace.uch
   • edu.wisc.trace.uch.action
   • edu.wisc.trace.uch.resource and its sub packages
   • edu.wisc.trace.uch.servlet
   • edu.wisc.trace.uch.util
   • edu.wisc.trace.uch.util.socket
   • edu.wisc.trace.uch.contextmanager and its sub packages

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

   • edu.wisc.trace.uch.tdm.upnp and its sub packages

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

   • edu.wisc.trace.uch.ta.upnpav and its sub packages

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

   • edu.wisc.trace.uch.ta.upnpsatellitebox and its sub packages

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

   • edu.wisc.trace.uch.tdm.generic and its sub packages

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

   • edu.wisc.trace.uch.ta.generictarget and its sub packages

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

   • edu.wisc.trace.uch.uipm.urchttp and its sub packages

   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 files index.html and error.html from UCH/bin directory to [TOMCAT_HOME]/webapps/UCH directory.
   • Copy the file UCH/dev/web.xml to [TOMCAT_HOME]/webapps/UCH/WEB-INF directory.
   • Copy files Installation.php, UCHj-ReleaseNotes.php, 3rdPartyLicenses.php from UCH directory to [TOMCAT_HOME]/webapps/UCH directory.

   UCH Files:

   • Copy the jar files uch.jar, clink.jar, xercesImpl.jar, jmdns.jar,soap-2.3.1.jar and gclib.jar from the directories UCH/bin, UCH/dev/lib/int/upnp, UCH/dev/lib/int/xerces, UCH/dev/lib/int/jmdns, UCH/dev/lib/ext/soap/ and GC100Targets/bin to [TOMCAT_HOME]/webapps/UCH/WEB-INF/lib directory respectively.

   Copy Resources:

   • Create a new directory [TOMCAT_HOME]/webapps/UCH/resources.
   • Create a new directory [TOMCAT_HOME]/webapps/UCH/resources/uploadedResources.
   • Copy directories UCH/res/upnptdm and UCH/res/gctdm to [TOMCAT_HOME]/webapps/UCH/resources/ directory.

   Copy Webclient:

   • Copy directory TraceProjs/Webclient/bin to [TOMCAT_HOME]/webapps/UCH/Webclient directory

   Delete jar Files:

   • Delete all jar files from /UCH/bin directory.

   Cache Directory:

   • Create a new directory [TOMCAT_HOME]/webapps/UCH/cache.

   
   

5. Target: "uch-war"

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

   UCH.war contains following contents

   [TOMCAT_HOME]/webapps/UCH/**

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

   
   
6. Target: "javadoc"

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

   
   
7. Target: "uch_zip"

   Create a uch.zip file at UCH/zip which contains following contents

   • UCH/UCHj-ReleaseNotes.php
   • UCH/3rdPartyLicenses.php
   • UCH/Installation.php
   • UCH/license.txt
   • UCH/LicenseAgreement.php
   • UCH/index.html
   • UCH/dev/*
   • UCH/dev/web/**
   • UCH/dev/src/**
   • UCH/dev/lib/int/**
   • UCH/doc/**
   • UCH/tutorial/**
   • UCH/bin/**
   • UCH/bin/Installation.php
   • UCH/${datetime}.builddate
   • 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/**
   • bin/*.jar
   • zip/**
   • res/**
   • installer/**
   • **/*.bak
   • **/.cvsignore
   • dev/*.builddate
   • livecd/**
   • NOTE: * - all files of that directory only.
   • ** - all files, directories with sub-directories and files of that directory.
   
   

---

Last update: Parikshit Thakur & Team, 2010-05-06