Codehaus Cargo : Installation

Java API

Cargo offers primarily a Java API. It is meant to be embedded in your application. You'll need Java SE version 7 or greater.

You have two choices to pick from the Downloads page:

the cargo-core-api-* jars and the container implementations you wish to use (cargo-core-container-* jars)
or the cargo-core-uberjar jar which aggregates all the required jars

Cargo's base dependencies are as follows:

Ant 1.7.0 or greater
Commons discovery 0.5 or greater
Commons logging 1.2 or greater

In addition, some specific containers (for example, JRun or WildFly / WildFly Swarm) and some deployables (for example, Tomcat WARs) require the following:

jdom 1.1.3 (not any jdom2 version)
jaxen 1.1.6 or greater
JSON.simple 1.1.1 or greater
Jackson core 2.10.1 or greater, Jackson YAML dataformat 2.10.1 or greater and SnakeYAML 1.24 or greater
The convenience JAR with DTDs that are used by some Cargo components which have licenses incompatible with the rest of Cargo, in case you want to use the Java API offline with some containers / deployables

Apache Ant

If you want use the Cargo Ant tasks, add the following JARs to ANT's classpath:

The same jars as for the Java API (i.e., either the API JARs + the container(s) or the uberjar)
The cargo-ant JAR, containing the <taskdef> definition (see the Ant support page)

Apache Maven 2 / Maven 3

Maven 2 / Maven 3 will automatically download all required dependencies: see the Maven2 plugin page. As a result, no installation is required for Maven 2 / Maven 3.

If you are creating a Java applications which use the Cargo via API, you need to add as dependency either the artifact for your favorite container or the uberjar (which contains all containers). See below

Example for adding the Codehaus Cargo uberjar as dependency

<dependency>
  <groupId>org.codehaus.cargo</groupId>
  <artifactId>cargo-core-uberjar</artifactId>
  <version>${cargo.version}</version>
</dependency>

Example for adding the Codehaus Cargo Tomcat container as dependency

<dependency>
  <groupId>org.codehaus.cargo</groupId>
  <artifactId>cargo-core-container-tomcat</artifactId>
  <version>${cargo.version}</version>
</dependency>