Versions Compared

Key

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

...

Top level configuration elements

Description

Mandatory?

Default value

<action>

Action to execute. These can be:

  • Container actions: configure, start, restartrun or stop
  • Deployer actions: deploy, undeploy or redeploy
  • Cargo Daemon actions: daemon-start or daemon-stop

(thumbs up)

No default

<containerId>

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

(thumbs up)

No default

<containerType>

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

(thumbs down)

Default value is installed

<home>

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

(thumbs down)

No default

If the user has not defined any home nor <zipUrlInstaller> element then the Ant task will automatically attempt to download the container using the URL used by its tests (see the Tested On section of each 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 nor <zipUrlInstaller> element then the Ant task will automatically attempt to download the container using the URL used by its tests (see the Tested On section of each container).

<timeout>

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

(thumbs down)

120000 ms (2 minutes)

<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

<extraClasspath>

Additional classpath entries for the classpath that will be used to start the containers.

(thumbs down)

No default

<sharedClasspath>

Classpath entries for the classpath that will be shared the applications deployed in a container. Shared application classpath deployment is only available for local containers which support shared Application Classpaths.

(thumbs down)

No default

<log>

Path to a file where Cargo logs are saved

(thumbs down)

Logs to the Ant 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 Ant console if no such file has been specified

<append>

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

(thumbs down)

false

<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

<daemon>

Additional configuration that is used when deploying with the Cargo Daemon.

(thumbs down)

For more information, please read: Cargo Daemon.

...

<configuration> elements

Description

Mandatory?

Default value

<type>

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

(thumbs down)

standalone

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

No default

<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
ant -Dcargo.servlet.port=8082


<deployables>

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

(thumbs down)

No default

<fileConfigs>

List of Configuration files that are to be added to a local container's configuration. Each file is specified using a <fileConfig> 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

<xmlReplacements>

Values to use for various XML replacements.

(thumbs down)

No default

<users>List of users to be created in container configuration.

(thumbs down)

No default

<datasources>List of datasources to be created in container configuration.

(thumbs down)

No default

...

<datasource> elementsDescriptionMandatory?Default value
<jndiName>JNDI name where to find this DataSource.

(thumbs up)

No default
<connectionType>Type of this DataSource ex. ", for example: javax.sql.XADataSource".

(thumbs down)

No default
<transactionSupport>Transaction support of the datasource ex. "DataSource, for example: XA_TRANSACTION"

(thumbs down)

No default
<driverClass>The class name of the Driver. Example: "driver, for example: org.hsqldb.jdbcDriver".

(thumbs down)

No default
<url>DataSource connection URL.

(thumbs down)

No default
<username>DataSource username.

(thumbs down)

No default
<password>DataSource password.

(thumbs down)

Empty string
<id>Id Identifier used in configuration files.

(thumbs down)

No default
<connectionProperties>Extra properties passed to the DataSource.

(thumbs down)

No default

...