Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Top level configuration elements

Description

Mandatory?

Default value

<configuration>

Definition of a Configuration

(thumbs down)

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

(thumbs down)

Defaults to a Jetty 109.x installed local container if not specified

<deployer>

Definition of a Deployer

(thumbs down)

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:deploycargo:undeploy is called.

(thumbs down)

If the project's packaging is warear 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.

(thumbs down)

For more information, please read: Cargo Daemon.

<skip>

Set this to true to bypass the executions of the Codehaus Cargo Maven 3 plugin.

(thumbs down)

Defaults to false, you can also steer it using the system property cargo.maven.skip

<ignoreFailures>

Set this to true to make the mojo ignore failures, so that Maven 3 can still progress through on integration tests with more than one container domain started.

(thumbs down)

Defaults to false, you can also steer it using the system property cargo.ignore.failures
<useLogCategoryPrefix>

Set this to true to display the log message category prefixes, which could help diagnosing issues.

Since Codehaus Cargo Maven 3 Plugin version 1.10.11 onwards.

(thumbs down)Defaults to false, you can also steer it using the system property cargo.maven.useLogCategoryPrefix

...

<container> elements

Description

Mandatory?

Default value

<append>

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

(thumbs down)

false

<containerId>

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

(thumbs down)

jetty10xjetty9x

<contextKey>

Container context key, which can be used for two purposes:

  1. Start, stop, configure or deploy to the same Cargo container (together with its configuration) from different Maven artifacts.
  2. Inject configuration properties via the Maven settings.xml file, as explained in the setting configuration options via the Maven 3 settings.xml section.

(thumbs down)

No reusable default

The Cargo Maven 3 plugin will actually generate a unique context key for each container based on the container and configuration's type and home - Which is not meant to be reused by end users.

<dependencies>

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

(thumbs down)

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.

(thumbs down)

No default

If the user has not defined any home, <zipUrlInstaller> 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.

(thumbs down)

Defaults to the Cargo-provided implementation if not specified

<log>

Path to a file where Cargo logs are saved.

(thumbs down)

Logs to the Maven 3 console if no log file is specified

<output>

Path to a file where container logs are saved.

(thumbs down)

Logs to the file specified by the <log> element or to the Maven 3 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.

(thumbs down)

No default

<timeout>

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

(thumbs down)

120000 ms (2 minutes)

<type>

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

(thumbs down)

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

<zipUrlInstaller>

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

(thumbs down)

No default

If the user has not defined any home, <zipUrlInstaller> 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 3 artifact that will be downloaded and installed.

(thumbs down)

No default

If the user has not defined any home, <zipUrlInstaller> 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).

...