XFire

Home
Bug/Issue Reporting
Download
FAQ
Get Involved
License
News
Stack Comparison
Support
User's Guide
XFire Team

M5

Javadocs
Reports

M6-SNAPSHOT

Javadocs
Reports

Developers

Developer Space
CVS
Building
Architecture
Interesting Projects
Release Process

XFire maintains two build systems side by side: Maven and Ant. Both can be used for testing and buliding jars. Maven is used for building releases and distributions. A couple notes on how our build system is set up:

In the xfire directory, there are several different modules. These can be compiled individually or as an aggregate, named "xfire-all". The xfire-all module is solely used in the maven build to build an aggregate xfire-all jar. The ant build system does not require this.

Building with Ant

Building individual jars

To compile jars for all the modules run

$ ant

from the main directory. This will put a jar in each module's target directory. For example, the xfire-core jar will be placed in xfire-core/target as "xfire-core-VERSION.jar".

Building an "xfire-all" jar

To compile an jar of all the xfire modules run

$ ant all

from the main directory. The resultant jar will be placed in xfire/target.

Running Tests

To run tests for all modules run

$ ant test

from the main directory.

To run tests for an individual module:

$ cd xfire-core (replace core with any module you desire)
$ ant test

Building with Maven

To build with java 5.0 support you must included "-Dxfire.java5=true" in all your maven commands.

Building all the individual jars

To build jars for each xfire module and have them placed in your local maven repository, simply run "maven" from the main source directory.

Building an individual module

To build an individual module:

$ cd xfire-core (replace core with any module you desire)
$ maven jar:install

Building an "xfire-all" jar

$ cd xfire-all
$ maven jar:install

or if you desire java 5.0 support:

$ cd xfire-all
$ maven -Dxfire.java5=true jar:install