View Source

This page has been automatically generated by Cargo's build. Do not edit it directly as it'll be overwritten next time it's generated again.

Container Features

Feature name	Java API	Ant tasks	Maven 3 plugin
Container Instantiation	`ContainerFactory.createContainer("jetty9x"...)`	`<cargo containerId="jetty9x".../>`	`<containerId>jetty9x</containerId>`
Local Container
Container Classpath
Container Start
Container Stop
Container Timeout
Embedded Container	`o.c.c.c.jetty.Jetty9xEmbeddedLocalContainer`
Installed Container	`o.c.c.c.jetty.Jetty9xInstalledLocalContainer`
Passing system properties
Installer
Remote Container	`o.c.c.c.jetty.Jetty9xRemoteContainer`

Configuration Features

Feature name	Java API	Ant tasks	Maven 3 plugin	Comment
Standalone Local Configuration for installed container	`o.c.c.c.jetty.Jetty9xStandaloneLocalConfiguration`
Standalone Local Configuration for embedded container	`o.c.c.c.jetty.Jetty9xEmbeddedStandaloneLocalConfiguration`
Existing Local Configuration for installed container	`o.c.c.c.jetty.Jetty9xExistingLocalConfiguration`
Existing Local Configuration for embedded container
Runtime Configuration	`o.c.c.c.jetty.JettyRuntimeConfiguration`
Static deployment of WAR
Static deployment of expanded WAR
Static deployment of EJB
Static deployment of EAR
Static deployment of RAR
Static deployment of files
Static deployment of OSGi Bundles

Deployer Features

Feature name	Java API	Ant tasks	Maven 3 plugin	Comment
Installed Deployer	`o.c.c.c.jetty.Jetty9x10x11xInstalledLocalDeployer`
Embedded Deployer	`o.c.c.c.jetty.Jetty7x8x9x10x11xEmbeddedLocalDeployer`
Remote Deployer	`o.c.c.c.jetty.JettyRemoteDeployer`

Other Features

Feature name	Java API	Ant tasks	Maven 3 plugin	Comment
Debugging

Supported Configuration properties

The tables below list both the general configuration properties as well as the container-specific ones.

Standalone Local Configuration Properties

For installed container o.c.c.c.jetty.Jetty9xInstalledLocalContainer

Property name	Java Property	Default value
cargo.hostname	GeneralPropertySet.HOSTNAME	`localhost`
cargo.java.home	GeneralPropertySet.JAVA_HOME	JAVA_HOME version 7 (Jetty 9.0.x, 9.1.x and 9.2.x) or 8 (Jetty 9.3.x and 9.4.x) or newer
cargo.jetty.deployer.createContextXml	JettyPropertySet.DEPLOYER_CREATE_CONTEXT_XML	`true`
cargo.jetty.realm.name	JettyPropertySet.REALM_NAME	`Cargo Test Realm`
cargo.jetty.servlet.default.useFileMappedBuffer	JettyPropertySet.USE_FILE_MAPPED_BUFFER	`true`
cargo.jetty.session.path	JettyPropertySet.SESSION_PATH	N/A
cargo.jvmargs	GeneralPropertySet.JVMARGS	N/A
cargo.logging	GeneralPropertySet.LOGGING	`medium`
cargo.port.offset	GeneralPropertySet.PORT_OFFSET	`0`
cargo.process.spawn	GeneralPropertySet.SPAWN_PROCESS	`false`
cargo.protocol	GeneralPropertySet.PROTOCOL	`http`
cargo.runtime.args	GeneralPropertySet.RUNTIME_ARGS	N/A
cargo.servlet.port	ServletPropertySet.PORT	`8080`
cargo.servlet.users	ServletPropertySet.USERS	N/A
cargo.standalone.ignoreNonExistingProperties	GeneralPropertySet.IGNORE_NON_EXISTING_PROPERTIES	N/A
cargo.start.jvmargs	GeneralPropertySet.START_JVMARGS	N/A

In addition to the forementioned properties, this container configuration can also set up datasources and/or resources.

For more details, please read: DataSource and Resource Support.

Jetty 9.x and above can be configured to run under a Java Security Manager.

For further information on how to achieve this, please refer to the associated tip in the Maven 3 Plugin Tips page.

For embedded container o.c.c.c.jetty.Jetty9xEmbeddedLocalContainer

Property name	Java Property	Default value
cargo.hostname	GeneralPropertySet.HOSTNAME	`localhost`
cargo.java.home	GeneralPropertySet.JAVA_HOME	JAVA_HOME version 7 (Jetty 9.0.x, 9.1.x and 9.2.x) or 8 (Jetty 9.3.x and 9.4.x) or newer
cargo.jetty.deployer.createContextXml	JettyPropertySet.DEPLOYER_CREATE_CONTEXT_XML	`true`
cargo.jetty.realm.name	JettyPropertySet.REALM_NAME	`Cargo Test Realm`
cargo.jetty.servlet.default.useFileMappedBuffer	JettyPropertySet.USE_FILE_MAPPED_BUFFER	`true`
cargo.jetty.session.path	JettyPropertySet.SESSION_PATH	N/A
cargo.jvmargs	GeneralPropertySet.JVMARGS	N/A
cargo.logging	GeneralPropertySet.LOGGING	`medium`
cargo.port.offset	GeneralPropertySet.PORT_OFFSET	`0`
cargo.protocol	GeneralPropertySet.PROTOCOL	`http`
cargo.runtime.args	GeneralPropertySet.RUNTIME_ARGS	N/A
cargo.servlet.port	ServletPropertySet.PORT	`8080`
cargo.servlet.users	ServletPropertySet.USERS	N/A
cargo.standalone.ignoreNonExistingProperties	GeneralPropertySet.IGNORE_NON_EXISTING_PROPERTIES	N/A
cargo.start.jvmargs	GeneralPropertySet.START_JVMARGS	N/A

Existing Local Configuration Properties

For installed container o.c.c.c.jetty.Jetty9xInstalledLocalContainer

Property name	Java Property	Default value
cargo.hostname	GeneralPropertySet.HOSTNAME	`localhost`
cargo.java.home	GeneralPropertySet.JAVA_HOME	JAVA_HOME version 7 (Jetty 9.0.x, 9.1.x and 9.2.x) or 8 (Jetty 9.3.x and 9.4.x) or newer
cargo.jvmargs	GeneralPropertySet.JVMARGS	N/A
cargo.port.offset	GeneralPropertySet.PORT_OFFSET	`0`
cargo.process.spawn	GeneralPropertySet.SPAWN_PROCESS	`false`
cargo.protocol	GeneralPropertySet.PROTOCOL	`http`
cargo.runtime.args	GeneralPropertySet.RUNTIME_ARGS	N/A
cargo.servlet.port	ServletPropertySet.PORT	`8080`
cargo.start.jvmargs	GeneralPropertySet.START_JVMARGS	N/A

If you specify cargo.runtime.args with --ini=anyfile.ini (where anyfile.ini points to a Jetty INI file), any property set in the Codehaus Cargo Jetty container will be ignored and the ones read from the INI file used instead.

Please note that the Jetty INI file concept doesn't exist anymore with Jetty 9.1.x onwards.

Runtime Configuration Properties

Before using the Jetty remote deployer, please read: Jetty Remote Deployer

For remote container o.c.c.c.jetty.Jetty9xRemoteContainer

Property name	Java Property	Default value
cargo.hostname	GeneralPropertySet.HOSTNAME	`localhost`
cargo.jetty.deployer.url	JettyPropertySet.DEPLOYER_URL	N/A
cargo.remote.password	RemotePropertySet.PASSWORD	N/A
cargo.remote.timeout	RemotePropertySet.TIMEOUT	`120000`
cargo.remote.username	RemotePropertySet.USERNAME	N/A
cargo.servlet.port	ServletPropertySet.PORT	`8080`

Tested On

This container is automatically tested by the Continous Integration system every time there is a code change.
The server used for tests is downloaded from: https://repo.maven.apache.org/maven2/org/eclipse/jetty/jetty-home/9.4.53.v20231009/jetty-home-9.4.53.v20231009.tar.gz