Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

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.

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 7.x installed 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 cargo execution

(thumbs down)

Defaults to false

...

<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.

(thumbs down)

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.

(thumbs down)

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

(thumbs down)

${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

(thumbs down)

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.

(thumbs down)

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.

<xmlReplacements>

Values to use for various XML replacements.

(thumbs down)

No default

<type>

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

(thumbs down)

standalone

...

<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)

jetty7x

<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 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 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 7.x installed 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 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).

...

<deployable> elements

Description

Mandatory?

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

(thumbs down)

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

(thumbs down)

Defaults to the project's group id

<implementation>

Deployable implementation class. Usage of this option is not recommended, please prefer type instead.

(thumbs down)

No default

<location>

Path location where the module can be found

(thumbs down)

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.

(thumbs down)

No default

<pingTimeout>

If <pingURL> is set, the number of milliseconds after which the ping fails the build if still not successful.

(thumbs down)

20000 (i.e., 20 seconds)

<properties>

User-defined properties of a deployable.

(thumbs down)

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

(thumbs down)

Defaults to the project's packaging

...

<properties> elements

 Deployable Type

Description

Mandatory?

Default value

<context>

WAR

The context name to use when deploying the web application.

(thumbs down)If not specified, then the default context name is computed from the name of WAR itself (without the file extension) or <project>/<build>/<finalName>

Default's to the artifact's ${artifactId}

<war>

WAR

The path of the WAR being deployed.

(thumbs down)

Default's to the project's generated artifact location

<ear>

EAR

The path of the EAR being deployed.

(thumbs down)

Default's to the project's generated artifact location

<name>

EAR

The name of EAR deployable (it can be anything, there's no special rule).

(thumbs down)If

not specified, it is computed from the EARDefault's file name (removing the filename extension) or <project>/<build>/<finalName>to the artifact's ${artifactId}

<ejb>

EJB

The path of the EJB being deployed.

(thumbs down)

Default's to the project's generated artifact location

...

<zipUrlInstaller> elements

Description

Mandatory?

Default value

<url>

URL from which to download the container's ZIP or TAR.GZ file.

(thumbs up)

No default

<downloadDir>

Directory in which the zipUrlInstaller should download the container's ZIP or TAR.GZ file.

(thumbs down)

${java.io.tmpdir}/cargo/installs

<extractDir>

Directory in which the zipUrlInstaller should extract the container's ZIP or TAR.GZ file.

(thumbs down)

${project.build.directory}/cargo/installs

<proxy>

Proxy server settings, if required.

(thumbs down)

No default

...