This document is provided to aid a developer in setting up his/her machine for doing development on the DiGIR Portal. Some of the items are recommendations while others are requirements. The document centers on the setup for developing on a Windows machine and was drafted during setup on a Windows 2000 Professional (with service pack 2) machine in specific. Also, an assumption is made that the developer has working knowledge of their own operating system, the internet, and development tools in general.
First and foremost, DiGIR is an established project on SourceForge.net. You will want to familiarize yourself with SourceForge and with the DiGIR materials on the SourceForge site.
It is also assumed that you've already done an install, as instructed in the DiGIR Portal Installation Instructions. If you have not done so, you will need to do so now. This will establish the necessary directory structure in which to work, as well as provide all the required software and libraries.
As a developer, you will need to register on SourceForge and be able to access the code repository. You should follow the documentation provided by SourceForge to get access to the repository. Some quick recommendations that might ease the process and differ from the doc:
This is really the hardest part of getting set up to do development, but once you have your environment set up, it should be smooth sailing.
After all the necessary utilities are installed, you will want to
src, web and
xml packages from
should do this in your established
directory. For further information on how to do this, refer to the "How to
check out source via SSH" section of the documentation
on SourceForge. A brief overview:
cvs -d:ext:firstname.lastname@example.org:/cvsroot/digir co directorynamewhere directoryname is either
The current Portal software is written in Java and uses a servlet/jsp
architecture running under Tomcat. All the required libraries, such as
logkit, uddi, soap, xalan, etc. are already provided for you in the
%DIGIR_HOME%/lib directory. A shared makefile
makefile_main.mk) establishes your CLASSPATH for you whenever
running make in any of the package directories. For your reference, the
files in the
lib directory are:
xerces.jarobtained from a Jakarta Tomcat 4.0.3 install
logkit-1_0_1.jarobtained from a Avalon Logkit 1.0.1 install
xalan.jarobtained from a XALAN-Java 2.4.D1 install
xml-apis.jarobtained from a XALAN-Java 2.4.D1 install
soap.jarobtained from a Apache SOAP 2.2 install
uddi.jarobtained from a UDDI4J 1.0.3 install
xerces.jarthat came with the Standard install of Jakarta Tomcat. Also, SOAP is required by UDDI. Lastly, the latest version(s) of UDDI4J underwent a complete package naming change and are not backwardly compatible, therefore, until the portal upgrades to accomodate this change, one should continue to use verion 1.0.3 of UDDI4J.
You do not need to download and install any of these packages as
they have already been provided for you in the
DiGIR_Portal_Env.zip file. This was done because they are
tested, known to be compatible, and also provides you with a certain level of
Makefiles are provided to build the application. You will find a
Makefile in the
web directory which simply copies the front end files into
the appropriate place within your DiGIR directory structure. All files in
web directory are used by the presentation layer of the
java directory contains source for both the
presentation and engine layers. You will find the following packages in the
javadirectory is a Makefile that simply invokes the make file for each of the packages listed above. This enables you to build the entire application at once. Also note, each makefile provides a "clean" option. If you are not familiar with make, please refer to the GNU make documentation.
A brief overview of how to make a code change:
makeon the command line
A recap of the environment variables that should have been set: