Overview

Two build environments are available for OpenJMS, one based on Ant , the other on Maven

The Ant build is simple and self-contained, but does not enable install archives or documentation to be built.

The Maven build requires Maven to be installed. Maven 1.0 rc1 or higher must be used.

Building OpenJMS using Ant

To build OpenJMS using Ant:

Windows

> cd %OPENJMS_HOME%
> build.bat <target>
        

Unix

> cd $OPENJMS_HOME
> build.sh <target>
        

Where target may be:

  • clean - removes the build artifacts
  • jar - builds the JARs
  • all - cleans and builds all the packages and examples

For a list of the available targets, invoke the build script with the -projecthelp argument.

Building OpenJMS using Maven

To build OpenJMS using Maven:

Windows

> cd %OPENJMS_HOME%
> maven.bat <goal>
        

Unix

> cd $OPENJMS_HOME
> maven <goal>
        

Where goal may be:

  • clean - removes the build artifacts
  • java:compile - compiles sources
  • jar - builds the JARs
  • devinstall - installs JARs and scripts
  • dist:build-bin - builds the install archives
  • dist:build-src - builds the source archives
  • site - generates the web site
  • site:deploy - deploy the generated web site

Documentation

The Maven build environment is responsible for producing the OpenJMS documentation.

All of the documentation is in xdoc format, and is transformed to HTML using the xdoc plugin

The OpenJMS documentation can be found in the src/xdocs directory in the CVS repository and source distribution.