ThreatFactor NSIA

h1. Development Environment

Below is information regarding what you'll need if you want to modify or develop NSIA. You can use whatever IDE you like, or you can use a "preconfigured instance of Eclipse":http://ondemand.yoxos.com/geteclipse/rap?profiles=868129468_1269911860683718583. 

h2. Compiler Requirements

NSIA requires Java JDK 6 (1.6) in order to compile successfully. It will not compile on earlier versions of Java (including Java 1.5).

h2. Libraries

Make sure that the libraries (under the _/lib_ directory) are on the classpath. Additionally, JUnit 3 is required for the unit tests. Note that you will get errors if you link to JUnit 4 as opposed to JUnit 3. 

h2. Build Script

NSIA includes an Ant task for handling various development related functions. You'll need to have the svnbinclean run every time a build occurs so that SVN does not think that the java-bin scratch directory is part of the repository.

h2. Local Build Properties

The build script uses a local build properties that sets variables that dictate how the build process will be performed. Below are the attributes that are used:

|_.Property                              |_.Example                  |_.Description                                                               |

| value.build.version                    | 0.9.2                     | Current version of the application (used when creating the Debian package) |

| value.build.debianpackage.directory    | build/dpkg                | Directory to use as the temporary directory for building the Debian package|

| value.build.licensekey                 | 1111-2222-3333-4444-5555  | License key to be used for downloading definitions that will included with the NSIA package (not currently used) |

h2. Creating Debian Packages Using jDeb

The project includes a build target for creating Debian packages using jDeb. For the build script to work you must add the jDeb and Apache commpress library to the Ant classpath. To do this in Eclipse, go to Window --> Preferences, Ant --> Runtime. Select "Global Entries" in the Classpath tab and then select "Add External JARs...". Add both the attachment:jdeb-0.8,jar and the "Apache commons compress":http://commons.apache.org/compress/download_compress.cgi (commons-compress-1.0.jar) Jar files.

h2. "Access restriction: Class is not accessible due to restriction..."

Eclipse may not let NSIA compile giving the message "Access restriction: Class is not accessible due to restriction on required library". This issue is due to an Eclipse setting. To fix it, change the "Forbidden reference" setting to "Ignore"; this setting is under "Errors/Warnings":

!Project_Access_Restriction.png!