...

These are the various XML configuration elements that you can use to configure the Cargo Maven2 plugin. Make sure you also check the use cases which show how to use them.

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.

Top level configuration elements	Description	Default value
`<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.
`<daemon>`	Additional configuration that is used when deploying with the Cargo Daemon.	For more information, please read: Cargo Daemon.
`<skip>`	Set this to `true` to bypass cargo execution	Defaults to `false`	`<wait>`	`false`

Info

title	The wait parameter

Instead of tweaking your Maven project POM with the different values for the wait parameter, please use the cargo:run MOJO:

The cargo:start MOJO should be used to start the container and hand over to the next Maven execution; i.e. it should ONLY be used for integration testing.
The cargo:run MOJO will start the container and wait until the user decides to stop it by pressing CTRL + C, which implies that it should be used for manual testing.

Anchor

	configuration

<configuration> elements

Description

Mandatory?

Default value

<configfiles>

List of Configuration files that are to be added to a local container's configuration. Each file is specified using a <configfile> element. Cargo token replacement is applied to the files and any existing file is overwritten.

No default

<files>

List of files that are to be added to a local container's configuration. Each file is specified using a <file> element.

No default

<home>

For standalone configuration this is the location where Cargo will create the configuration and for existing configuration this is where it is located

${project.build.directory}/cargo/configurations/${containerId}

<implementation>

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

Defaults to the Cargo-provided implementation if not specified

<properties>

Values to use for various Configuration properties.

You can also use the <propertiesFile> element to load configuration properties from a file.

Default configuration properties

Note that these configuration properties can also be overriden using Java properties; for example:

Code Block
mvn -Dcargo.servlet.port=8082 cargo:start

In addition to this, properties can also be set using the Maven2 settings.xml file. See the setting configuration options via the Maven settings.xml section for details.

<type>

Configuration's type. Valid values are standalone, existing and runtime

standalone

...

`<container>` elements	Description	Default value
`<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	`jetty7x`
`<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 If the user has not defined any `home`, a `<zipUrlInstaller>` or nor `<artifactInstaller>` element then the plugin will automatically attempt to download the container using the URL used by its tests (see the Tested On section of each container).
`<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 If the user has not defined any `home`, a `<zipUrlInstaller>` or nor `<artifactInstaller>` element then the plugin will automatically attempt to download the container using the URL used by its tests (see the Tested On section of each container).
`<artifactInstaller>`	Defines the location of a container Maven artifact that will be downloaded and installed	No default, user must define either a If the user has not defined any `home`, a `<zipUrlInstaller>` or nor `<artifactInstaller>` element then the plugin will automatically attempt to download the container using the URL used by its tests (see the Tested On section of each container).

Anchor

	deployer

`<deployer>` elements	Description	Mandatory?	Default value
`<implementation>`	Deployer implementation class. Usage of this option is not recommended, please prefer `type` instead.		No default
`<type>`	The deployer's type.		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)

...

`<deployable>` elements	Description	Default value
`<artifactId>`	Maven artifact id for the module. This artifact id must match either the project's artifact id if your project generates a J2EE artifact (WAR, EAR, EJB and RAR) or it must match a specified `<project>/<dependencies>/<dependency>` artifact id	Defaults to the project's artifact id
`<groupId>`	Maven group id for the module. This group id must match either the project's group id if your project generates a J2EE artifact (WAR, EAR, EJB and RAR) or it must match a specified `<project>/<dependencies>/<dependency>` group id	Defaults to the project's group id
`<implementation>`	Deployable implementation class. Usage of this option is not recommended, please prefer `type` instead.	No default
`<location>`	Path location where the module can be found	Default's to the project's generated artifact location or to the specified `<project>/<dependencies>/<dependency>` location
`<pingURL>`	URL on which to ping the deployed or undeployed application (to check if deployment or undeployment is successful), that should return an HTTP OK response only after the deployment is complete. If not set, the deployed or undeployed application will not be pinged, hence the deployment considered as complete as soon as the target server's method returns successfully.	No default
`<pingTimeout>`	If `<pingURL>` is set, the number of milliseconds after which the ping fails the build if still not successful.	`20000` (i.e., `20` seconds)
`<properties>`	User-defined properties of a deployable.	No default
`<type>`	Maven type for the module. This type must match either the project's packaging if your project generates a J2EE artifact (WAR, EAR, EJB and RAR) or it must match a specified `<project>/<dependencies>/<dependency>` type	Defaults to the project's packaging

...

`<zipUrlInstaller>` elements	Description	Default value
`<url>`	URL from which to download the container's ZIP or TAR.GZ file.	No default
`<downloadDir>`	Directory in which the `zipUrlInstaller` should download the container's ZIP or TAR.GZ file.	`${java.io.tmpdir}/cargo/installs`
`<extractDir>`	Directory in which the `zipUrlInstaller` should extract the container's ZIP or TAR.GZ file.	`${project.build.directory}/cargo/installs`
`<proxy>`	Proxy server settings, if required.	No default

...

`<artifactInstaller>` elements	Description	Default value
`<groupId>`	Group id.	No default
`<artifactId>`	Artifact id.	No default
`<version>`	Version.	No default
`<type>`	Artifact type.	`zip`
`<classifier>`	Classifier.	No default
`<extractDir>`	Directory in which the `artifactInstaller` should extract the container's ZIP or TAR.GZ file.	`${project.build.directory}/cargo/installs`

Anchor

	settingsXMLdaemon

Daemon configuration

AnchordaemonThe Cargo Daemon is a Web-based application that uses the Cargo API to configure, start and stop containers on a remote machine. The daemon is meant to be listening 24/7, to allow users to deploy new containers and web applications at their command. For more information, please read: Cargo Daemon.

Info

title	Container configuration for the Daemon

For the Maven2/Maven3 plugin, the "daemonized server" is actually a local container with a hostname that points to a remote machine. This implies that:

You should not set the container type to a remote container nor add any remote deployers to the configuration; but instead define the container as a local container (with either a standalone or existing configuration)
When you define the home paths for the container and the configuration, remember these paths are for the machine where the Daemon is running (and, preferably, use absolute paths)

When you call cargo:daemon-start, the Maven2/Maven3 plugin will do the following:

If an installer is defined:
- Download the archive locally
- Send the archive over to the machine running the Daemon
- Instruct the Daemon to extract the archive
If a standalone local configuration is defined, instruct the Daemon to create it
In all cases:
- Send the configuration files and deployables to the machine running the Daemon
- Instruct the Daemon to deploy them
Finally, instruct the Daemon to start the container

`<daemon>` elements	Description	Mandatory?	Default value
`<classpaths>`	A list of `<classpath>myclasspath</classpath>` items, that will be added by the JVM launcher when starting a container.		No default
`<properties>`	A list of properties used to configure the Cargo Daemon.		No default

`<properties>` elements	Description	Default value
`<cargo.daemon.url>`	URL to connect with the daemon.	No default
`<cargo.daemon.handleid>`	The handle id to register this container with.	No default
`<cargo.daemon.autostart>`	When set to `true`, the dameon will automatically restart the container if the daemon notices it is stopped.	`false`
`<cargo.daemon.username>`	Username used when authenticating against the daemon host	`admin`
`<cargo.daemon.password>`	Password used when authenticating against the daemon host	`""` (empty String)

Anchor

	settingsXML

Setting configuration options via the Maven settings.xml

...

Maven2 Plugin Reference Guide

Versions Compared

Old Version 82

New Version Current

Key

Daemon configuration

Setting configuration options via the Maven settings.xml