Maven2 Plugin Reference Guide

<configuration>

Definition of a Configuration

Defaults to a standalone configuration if the container is of type local and a runtime one if it's of type remote

<container>

Definition of a Container

Defaults to a Jetty 7.x installed container if not specified

<deployer>

Definition of a Deployer

Defaults to a deployer matching the container's type if none is specified (installed local deployer for an installed container, remote deployer for a remote container and embedded local deployer for an embedded container)

<deployables>

A list of deployables that are going to be deployed in the container when it is started or when cargo:deploy / cargo:undeploy is called.

If the project's packaging is war, ear or ejb, the generated artifact is added automatically to the list of deployables to deploy. If you wish the generated artifact not to be added to the deployables list, just add an empty <deployer/> element.

<skip>

Set this to true to bypass cargo execution

Defaults to false

<wait>

Decides if Cargo should wait after the container is started or not. If using Cargo for integration tests, set it to false, otherwise Cargo will start the container and show the following message: Press Ctrl-C to stop the container...

Important: This parameter has been deprecated and will be removed soon. If you want to do manual testing, please use the cargo:run MOJO.

false

<append>

If true, then the file specified by <output> will not be erased across different runs

false

<containerId>

Id of the container to use. Valid values can be found in the description page for each container

jetty6xjetty7x

<dependencies>

List of extra dependencies or shared dependencies that will be added to the container or applications execution classpath.

No default

<home>

Location where the container is installed. If specified in conjunction with the <zipUrlInstaller> or <artifactInstaller> element, it will override the home directory defined by the installer

No default, user must define either a home, a <zipUrlInstaller> or <artifactInstaller> element

<implementation>

Full classname of a custom container implementation to use. In that case, the custom container is registered with the <containerId> and <type> specified

Defaults to the Cargo-provided implementation if not specified

<log>

Path to a file where Cargo logs are saved

Logs to the Maven console if no log file is specified

<output>

Path to a file where container logs are saved

Logs to the file specified by the <log> element or to the Maven console if no such file has been specified

<systemProperties>

List of <key>value</key> pairs to be passed as System properties to the container when it is started.

You can also use the <systemPropertiesFile> element to load system properties from a file.

No default

<timeout>

The timeout after which Cargo reports an error if the container is not started or stopped

120000 ms (2 minutes)

<type>

The container's type. Valid values are installed, embedded and remote

Default value is installed unless the <containerId> has not been specified, in which case the default is to use the Jetty 7.x installed container

<zipUrlInstaller>

Defines the location of a container distribution zip that will be downloaded and installed

No default, user must define either a home, a <zipUrlInstaller> or <artifactInstaller> element

<artifactInstaller>

Defines the location of a container Maven artifact that will be downloaded and installed

No default, user must define either a home, a <zipUrlInstaller> or <artifactInstaller> element