Prerequisites

* Install J2SE 7 SDK. The build is also compatible with JDK 6.0 Update 29 or later.

* Make sure that your JAVA_HOME environment variable is set to the newly installed JDK location, and that your PATH includes %JAVA_HOME%\bin (windows) or $JAVA_HOME$/bin (*nix).

* Install Maven 3.0.4 (or later). Make sure that your PATH includes the MVN_HOME/bin directory.

* In addition, access to a Maven repository with the latest project artifacts and dependencies is necessary in order for a successful build. The following sample settings.xml (the default settings file) can be used to access the public repositories with the required artifacts. For more help on how to use the settings.xml file, see the Maven settings reference page.

Sample settings.xml file

<settings>
 <!-- If proxy is needed
 <proxies>
   <proxy>
   </proxy>
 </proxies>
 -->
</settings>

Handy Tip on Encrypting Passwords

See this Maven guide on how to encrypt the passwords in your settings.xml.

Procedures

Run the Build

In order to run through a full build, be sure to have a clone for all repositories in the same folder:

ddf (https://github.com/codice/ddf.git)
ddf-catalog (https://github.com/codice/ddf-catalog.git)
ddf-content (https://github.com/codice/ddf-content.git)
ddf-parent (https://github.com/codice/ddf-parent.git)
ddf-platform (https://github.com/codice/ddf-platform.git)
ddf-security (https://github.com/codice/ddf-security.git)
ddf-solr (https://github.com/codice/ddf-solr.git)
ddf-spatial (https://github.com/codice/ddf-spatial.git)
ddf-support (https://github.com/codice/ddf-support.git)
ddf-ui (https://github.com/codice/ddf-ui.git)

Build command example for one individual repository.

# Build is run from the top level of the specified repository in a command line prompt or terminal. 
cd ddf-support
mvn clean install
 
# At the end of the build, a BUILD SUCCESS will be displayed.

Build command example to build all repositories. Must be performed at the top level folder that contains all the repositories. A command list would look like this.

# Build is run from the top level folder that contains all the repositories in a command line prompt or terminal.
 
cd ddf-support
mvn clean install
 
cd ../ddf-parent
mvn clean install

cd ../ddf-platform
mvn clean install

cd ../ddf-security
mvn clean install

cd ../ddf-catalog
mvn clean install

cd ../ddf-content
mvn clean install

cd ../ddf-spatial
mvn clean install

cd ../ddf-solr
mvn clean install

cd ../ddf-ui
mvn clean install

cd ../ddf
mvn clean install
 
# This will fully compile each individual app. From here you may hot deploy the necessary apps on top of the DDF Kernel.

To be able to use the updated apps in a DDF Distribution, you will have to update the versions referenced in the "ddf" repository.

The zip distribution of DDF is contained in the DDF app in the distribution/ddf/target directory after the DDF app is built

Also note that you may create a reactor pom that will allow you to do this whole build process by calling a build on one pom rather than all of them. This pom would have to reside in the top level folder that holds all the repositories. An example of the file would be:

<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/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 
	 <groupId>org.codice.ddf</groupId>
	 <artifactId>reactor</artifactId>
	 <version>1.0.0-SNAPSHOT</version>
	 <packaging>pom</packaging>
	 <name>DDF Reactor</name>
	 <description>Distributed Data Framework (DDF) is an open source, modular integration framework</description>
 
	 <modules>
		 <module>ddf-support</module>
		 <module>ddf-parent</module>
		 <module>ddf-platform</module>
		 <module>ddf-security</module>
		 <module>ddf-catalog</module>
		 <module>ddf-content</module>
		 <module>ddf-spatial</module>
		 <module>ddf-solr</module>
		 <module>ddf-ui</module>
		 <module>ddf</module>
	 </modules>
 
 	<build>
		 <plugins>
			 <plugin>
				 <groupId>org.apache.maven.plugins</groupId>
				 <artifactId>maven-deploy-plugin</artifactId>
				 <version>2.4</version>
				 <configuration>
					 <!-- Do not deploy the reactor pom -->
					 <skip>true</skip>
				 </configuration>
			 </plugin>
		 </plugins>
	 </build>
 
</project>

It usually takes some time for maven to download required dependencies in the first build. Build times may vary based on network speed and machine specifications.

In certain circumstances the build may fail due to a 'java.lang.OutOfMemory: Java heap space' error. This error is due to the large number of sub-modules in the DDF build causing the heap space to run out in the main maven JVM. To fix this issue, set the system variable MAVEN_OPTS with the value -Xmx512m -XX:MaxPermSize=256m before running the build.

Example on Linux system with the bash shell: export MAVEN_OPTS='-Xmx512m -XX:MaxPermSize=256m'

Browser not supported