HomeDownloadsUser GuideDevelopment

Development: Build Environment

Overview

The Java based Ant tool is used as build tool within this project. See the setup page for more information on how to configure the build environment for your system.

Always use the bundled build script to invoke build commands instead of your local version of ant in order to avoid conflicts!

Due to the fact that Ant always has to be configured and enriched by additional libraries a complete Ant runtime environment is included in the project directory. To start the bundled Ant version there is a script in the top level directory of the project (build.sh for Unix / Mac OS X and build.cmd for Windows). This script is not named ant to prevent naming conflicts with other versions of Ant that might already be installed on your system.

Targets

The available targets and their descriptions is listed in the following table, but it can also be printed by running build -projecthelp.

Lifecycle Build Targets

Target Description Source
audit Creates all auditing information available. shared/build/audit.xml
check Performs a checkin check. shared/build/audit.xml
check.report Opens the auditing report in a browser. shared/build/audit.xml
clean Removes the build artifacts. build.xml
compile Compiles all modules of the project. shared/build/compile.xml
dist Builds the complete project distribution. shared/build/dist.xml
dist.clean Removes all build and distribution artifacts. shared/build/dist.xml
doc Creates the project documentation. shared/build/doc.xml
doc.site Creates the project site documentation. shared/build/doc.xml
javadoc Compiles all modules of the project. shared/build/javadoc.xml
resources Processes all resources of the project. shared/build/resources.xml
since Updates the since tags in the source code. build.xml
test Runs the unit tests. shared/build/audit.xml
version Updates the versioning and changelog information. build.xml
world Builds the complete project. (Default Target) build.xml

Modules

Lists the modules defined in the build file as well as module specific targets.

Imported Build Modules

Module Description Source
core Build file that contains core specific configuration and targets. core/module.xml
editor Build file that contains editor specific configuration and targets. editor/module.xml
examples-ejb Build file that contains the configuration and targets for the EJB hello world. examples/ejb/module.xml
examples-ldap Build file that contains the configuration and targets for the ldap example. examples/ldap/module.xml
examples-simple Build file that contains the configuration and targets for the simple example. examples/simple/module.xml

core (core/module.xml)

This module does not export module specific targets.

editor (editor/module.xml)

This module does not export module specific targets.

examples-ejb (examples/ejb/module.xml)

This module does not export module specific targets.

examples-ldap (examples/ldap/module.xml)

Target Description Source
examples-ldap.ldif Makes the ldif file with the certificates needed to fill the ldap server. examples/ldap/module.xml

examples-simple (examples/simple/module.xml)

Target Description Source
examples-simple.certs4ide Creates the certificates in the right directory allowing a start of the example directly from Eclipse. examples/simple/module.xml
examples-simple.dist Creates the certificates and copies them together with the example sources in the dist directory, making the example ready to ship. examples/simple/module.xml