Getting Started With NUPastry

You have multiple options how to incorporate NUPastry into your project. Here at the Aqualab, we use Maven and Eclipse to maintain and build our Java projects.

In any case, you need a Java runtime environment to run and a Java Development Kit to build applications based on Nemo. You can download the latest Java version from Sun. Nemo and its dependencies are tested with the latest Java 2 Platform Standard Edition 5.0 (JDK 5.0).

Getting Started With Maven

After downloading Maven 2, setup a new maven project using the following pom.xml. Please refer to the documentation of Maven for how to configure a project. If you start with the template below, just replace the fields with your project information.

<project xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <groupId>your.group.id</groupId>
        <artifactId>yourprojectid</artifactId>
        <packaging>jar</packaging>
        <version>1.0-SNAPSHOT</version>
        <name>Your Project Name</name>
        <url>http://your.www.com/path/to/project/home/page/</url>
        <inceptionYear>2006</inceptionYear>
        <organization>
                <name>Your Organization</name>
                <url>http://your.www.com</url>
        </organization>
        <licenses>
                <license>
                        <name>The GNU General Public License, Version 2.0</name>
                        <url>/LICENSE.txt</url>
                </license>
        </licenses>
        <developers>
                <developer>
                        <id>userid</id>
                        <name>Your Name</name>
                        <email>Your email address</email>
                        <organization>Your organization</organization>
                </developer>
        </developers>
        <dependencies>
                <dependency>
                        <groupId>junit</groupId>
                        <artifactId>junit</artifactId>
                        <version>3.8.1</version>
                        <scope>test</scope>
                </dependency>
                <dependency>
                        <groupId>edu.nwu</groupId>
                        <artifactId>heimdall</artifactId>
                        <version>1.0</version>
                        <scope>compile</scope>
                </dependency>
                <dependency>
                        <groupId>edu.nwu</groupId>
                        <artifactId>nucommon</artifactId>
                        <version>1.0</version>
                        <scope>compile</scope>
                </dependency>
                <dependency>
                        <groupId>edu.nwu</groupId>
                        <artifactId>dht</artifactId>
                        <version>1.0</version>
                        <scope>compile</scope>
                </dependency>
                <dependency>
                        <groupId>edu.nwu</groupId>
                        <artifactId>nupastry</artifactId>
                        <version>1.0</version>
                        <scope>compile</scope>
                </dependency>
                <dependency>
                        <groupId>commons-logging</groupId>
                        <artifactId>commons-logging</artifactId>
                        <version>1.0.3</version>
                        <scope>compile</scope>
                </dependency>
        </dependencies>
        <build>
                <resources>
                        <resource>
                                <directory>src/main/resources</directory>
                                <filtering>true</filtering>
                        </resource>
                </resources>
                <plugins>
                        <plugin>
                                <groupId>org.apache.maven.plugins</groupId>
                                <artifactId>maven-compiler-plugin</artifactId>
                                <configuration>
                                        <source>1.5</source>
                                        <target>1.5</target>
                                </configuration>
                        </plugin>
                </plugins>
        </build>
</project>

Once you got the pom.xml setup, simple invoke maven from the command line inside the project directory. It will then automatically fetch all the dependencies for your projects.

Using Eclipse

Using a graphical development environment offers a number of advantages. Consequently, maven supports several of them. To generate the project descriptor for Eclipse, simply type:

 mvn eclipse:eclipse

Building Your First NUPastry-based Application

... TODO ...