Home

Mission

Cargo is a thin wrapper around existing J2EE containers. It provides different APIs to easily manipulate containers. "Cargo, your container's best friend!"

Cargo provides the following APIs:

• A Java, Ant and Maven API to start/stop/configure Java Containers
• A Java API to parse/create J2EE Modules

Status

Version status (click in the status column to get release notes):

As glitches may happen even after a container is released for the first time, e.g. if a new feature is added to the framework, but not supported by all containers, we encourage you to report your success/failures in the Tested on section.

Documentation for Cargo version in development The documentation below is for Cargo 0.7 which is the version that we are currently developing (not released yet). The documentation for Cargo 0.6 (latest version) is available here

Architecture

Cargo offers differents ways of using it at different levels:

• Module Java API: A Java API to parse/create J2EE Modules (WAR, EAR, etc)
• Container Java API: A Java API to start/stop/configure Java Containers.
• Generic Java API: A Java API that sits on top of the Container API but allows writing generic code that works with any container. It consists mostly in a set of Factory classes to instantiate Container API objects by name.
• Ant tasks: A set of Ant tasks that wrap the Generic Java API
• Maven plugin: A Maven plugin that wraps the Ant tasks

The main Container API objects are:

• The Container is the top level interface wrapping a real physical container. Cargo supports local and remote containers. A Container is composed of a Configuration.
• A Configuration tells Cargo how the container is to be configured (whether it should create a standalone setup, whether it should be based on an existing configuration, etc). A Configuration can be configured to install Deployables before the Container is started.
• You can use a Deployer to deploy Deployables dynamically (i.e. after the Container is started).
• Deployables are archives to be deployed in the Container. They are WAR, EAR, etc.

Feature list

• Configuration — A Configuration specifies how the container is configured (logging, security, data sources, location where to put deployables, etc).
• Container — A top level interface wrapping a real physical container
• Debugging — Explain how to perform debugging when something doesn't work in Cargo
• Deployment — How to deploy components to a container
• Extensions — Extensions are additions to the Cargo core Java API such as build tool plugins, IDE plugins, etc
• Module API — API to manipulate J2EE archives, including vendor-specific deployment descriptors

Container support

List of supported containers and the integration points that are implemented for each container (Java API, Ant tasks and Maven plugin). The specified version is the Cargo version where the feature was first made available.

Quick Start

The following examples demonstrate how to configure Resin 3.0.8 to start in target/resin3x and deploy a WAR located in path/to/simple.war. The default port is 8080. Please note that the container.start() and container.stop() methods wait until the container is fully started and fully stopped before continuing. Thus, for any action you are executing after, you are assured the container is completely operational.

Static deployment

Static deployment means that the Deployabe is deployed before the container is started. Here's an example using the strongly type Java API:

Here's the same example using the generic untyped API:

Dynamic deployment

Dynamic deployment means that the Deployable is deployed after the container is started.