Page Comparison

...

Feature name	Java API	Ant tasks	Maven 2 / Maven 3 plugin
Container Instantiation	`ContainerFactory.createContainer("tomcat9x"...)`	`<cargo containerId="tomcat9x".../>`	`<containerId>tomcat9x</containerId>`
Local Container
Container Classpath
Container Start
Container Stop
Container Timeout
Embedded Container	`o.c.c.c.tomcat.Tomcat9xEmbeddedLocalContainer`
Installed Container	`o.c.c.c.tomcat.Tomcat9xInstalledLocalContainer`
Passing system properties
Installer
Remote Container	`o.c.c.c.tomcat.Tomcat9xRemoteContainer`

Info

title	Running multiple Tomcat 7.x / Tomcat 8.x / Tomcat 9.x / Tomcat 10.x embedded containers within the same JVM

Tomcat 7.x has introduced a class called TomcatURLStreamHandlerFactory where the singleton has a static instance field and a final registered attribute which are not always in sync and cause unexpected exceptions. Due to this, it is not possible to execute Tomcat 7.x, Tomcat 8.x, Tomcat 9.x and / or Tomcat 910.x embedded in the same JVM, in addition running one of these Tomcat embedded versions one after the other within the same JVM but different classpaths might also fail.

If you want to be safe, prefer using the Installed Container. Also note that Tomcat 11.x onwards has gotten rid of that class.

Configuration Features

Feature name	Java API	Ant tasks	Maven 2 / Maven 3 plugin	Comment
Standalone Local Configuration for installed container	`o.c.c.c.tomcat.Tomcat9xStandaloneLocalConfiguration`
Standalone Local Configuration for embedded container	`o.c.c.c.tomcat.Tomcat9xStandaloneLocalConfiguration`
Existing Local Configuration for installed container	`o.c.c.c.tomcat.TomcatExistingLocalConfiguration`
Existing Local Configuration for embedded container	`o.c.c.c.tomcat.TomcatExistingLocalConfiguration`
Runtime Configuration	`o.c.c.c.tomcat.TomcatRuntimeConfigurationTomcat9xRuntimeConfiguration`
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

...

Feature name	Java API	Ant tasks	Maven 2 / Maven 3 plugin	Comment
Installed Deployer	`o.c.c.c.tomcat.TomcatCopyingInstalledLocalDeployer`
Embedded Deployer	`o.c.c.c.tomcat.TomcatEmbeddedLocalDeployer`
Remote Deployer	`o.c.c.c.tomcat.Tomcat9xRemoteDeployer`

...

Feature name	Java API	Ant tasks	Maven 2 / Maven 3 plugin	Comment
Debugging

...

Property name	Java Property	Supported?	Default value
cargo.hostname	GeneralPropertySet.HOSTNAME		`localhost`
cargo.java.home	GeneralPropertySet.JAVA_HOME		JAVA_HOME version 8 or newer
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.rmi.port	GeneralPropertySet.RMI_PORT		`8205`
cargo.runtime.args	GeneralPropertySet.RUNTIME_ARGS		N/A
cargo.servlet.port	ServletPropertySet.PORT		`8080`
cargo.servlet.users	ServletPropertySet.USERS		`admin::manager-script`
cargo.standalone.ignoreNonExistingProperties	GeneralPropertySet.IGNORE_NON_EXISTING_PROPERTIES		N/A
cargo.start.jvmargs	GeneralPropertySet.START_JVMARGS		N/A
cargo.tomcat.ajp.port	TomcatPropertySet.AJP_PORT		`8009`
cargo.tomcat.connector.clientAuth	TomcatPropertySet.CONNECTOR_CLIENT_AUTH		N/A
cargo.tomcat.connector.keyAliashttpUpgradeProtocol	TomcatPropertySet.CONNECTOR_KEYHTTP_UPGRADE_ALIASPROTOCOL		N/A
cargo.tomcat.connector.keystoreFilekeyAlias	TomcatPropertySet.CONNECTOR_KEY_STORE_FILE ALIAS		N/A
cargo.tomcat.connector.keystorePasskeystoreFile	TomcatPropertySet.CONNECTOR_KEY_STORE_PASSWORDFILE		N/A
cargo.tomcat.connector.keystoreTypekeystorePass	TomcatPropertySet.CONNECTOR_KEY_STORE_TYPEPASSWORD		N/A
cargo.tomcat.connector.sslProtocolkeystoreType	TomcatPropertySet.CONNECTOR_KEY_SSLSTORE_PROTOCOLTYPE		N/A
cargo.tomcat.connector.truststoreFilemaxHttpHeaderSize	TomcatPropertySet.CONNECTOR_MAX_TRUSTHTTP_STOREHEADER_FILESIZE		N/A
cargo.tomcat.connector.truststorePassprotocolClass	TomcatPropertySet.CONNECTOR_TRUSTPROTOCOL_STORE_PASSWORDCLASS		N/A
cargo.tomcat.connector.truststoreTypesslImplementationName	TomcatPropertySet.CONNECTOR_TRUSTSSL_STOREIMPLEMENTATION_TYPENAME		N/A
cargo.tomcat.contextconnector.allowCasualMultipartParsingsslProtocol	TomcatPropertySet.CONTEXTCONNECTOR_SSL_ALLOWMULTIPARTPROTOCOL	`true`	N/A
cargo.tomcat.contextconnector.reloadabletruststoreFile	TomcatPropertySet.CONTEXT_RELOADABLECONNECTOR_TRUST_STORE_FILE	`false`	N/A
cargo.tomcat.connector.copywarstruststorePass	TomcatPropertySet.COPY_WARSCONNECTOR_TRUST_STORE_PASSWORD	`true`	N/A
cargo.tomcat.connector.httpSecuretruststoreType	TomcatPropertySet.HTTP_SECURECONNECTOR_TRUST_STORE_TYPE	`false`	N/A
cargo.tomcat.context.uriencodingallowCasualMultipartParsing	TomcatPropertySet.URICONTEXT_ALLOW_ENCODINGMULTIPART		`ISO-8859-1true`
cargo.tomcat.useHttpOnlycontext.mapJarToWebinfClasses	TomcatPropertySet.USE_HTTP_ONLYCONTEXT_MAP_JARS_TO_WEBINF_CLASSES		N/A`false`
cargo.tomcat.valvecontext.reloadable	TomcatPropertySet.CUSTOMCONTEXT_VALVERELOADABLE		N/A`false`
cargo.tomcat.webappsDirectorycopywars	TomcatPropertySet.WEBAPPSCOPY_DIRECTORYWARS		`webappstrue`

Info

title	Datasource and Resource configuration

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.

For embedded container o.c.c.c.tomcat.Tomcat9xEmbeddedLocalContainer

Property name	Java Property	Supported?	Default value	Javadoc
cargo.hostname	GeneralPropertySet.HOSTNAME		`localhost`
cargo.java.home	GeneralPropertySet.JAVA_HOME		JAVA_HOME version 8 or newer
cargo.jvmargs	GeneralPropertySet.JVMARGS		N/A
cargo.logging	GeneralPropertySet.LOGGING		`medium`
cargo.port.offset	GeneralPropertySet.PORT_OFFSET		`0`
cargo.protocol	GeneralPropertySet.PROTOCOL		`http`
cargo.rmi.port	GeneralPropertySet.RMI_PORT		`8205`
cargo.runtime.args	GeneralPropertySet.RUNTIME_ARGS cargo.tomcat.host.startStopThreads	TomcatPropertySet.HOST_START_STOP_THREADS		N/A
cargo.tomcat.httpSecure	TomcatPropertySet.HTTP_SECURE		`false`
cargo.tomcat.uriencoding	TomcatPropertySet.URI_ENCODING		`UTF-8`
cargo.tomcat.useHttpOnly	TomcatPropertySet.USE_HTTP_ONLY		N/A
cargo.tomcat.valve	TomcatPropertySet.CUSTOM_VALVE		N/A
cargo.tomcat.webappsDirectory	TomcatPropertySet.WEBAPPS_DIRECTORY		`webapps`

Info

title	Datasource and Resource configuration

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.

Info

title	Configuring HTTP/2 for Tomcat 8.5 and above

Tomcat 8.5 and above support HTTP/2.

For further information on how to enable this, please refer to Configuring HTTP/2 for Tomcat 8.5 and above.

For embedded container o.c.c.c.tomcat.Tomcat9xEmbeddedLocalContainer

Property name	Java Property	Supported?	Default value
cargo.hostname	GeneralPropertySet.HOSTNAME		`localhost`
cargo.java.home	GeneralPropertySet.JAVA_HOME		JAVA_HOME version 8 or newer
cargo.jvmargs	GeneralPropertySet.JVMARGS		N/A
cargo.logging	GeneralPropertySet.LOGGING		`medium`
cargo.port.offset	GeneralPropertySet.PORT_OFFSET		`0`
cargo.protocol	GeneralPropertySet.PROTOCOL		`http`
cargo.rmi.port	GeneralPropertySet.RMI_PORT		`8205`
cargo.runtime.args	GeneralPropertySet.RUNTIME_ARGS		N/A
cargo.servlet.port	ServletPropertySet.PORT		`8080`
cargo.servlet.users	ServletPropertySet.USERS		`admin::manager-script`
cargo.standalone.ignoreNonExistingProperties	GeneralPropertySet.IGNORE_NON_EXISTING_PROPERTIES		N/A
cargo.start.jvmargs	GeneralPropertySet.START_JVMARGS		N/A
cargo.tomcat.ajp.port	TomcatPropertySet.AJP_PORT		`8009`
cargo.tomcat.connector.clientAuth	TomcatPropertySet.CONNECTOR_CLIENT_AUTH		N/A
cargo.tomcat.connector.httpUpgradeProtocol	TomcatPropertySet.CONNECTOR_HTTP_UPGRADE_PROTOCOL		N/A
cargo.tomcat.servletconnector.portkeyAlias	ServletPropertySet.PORT TomcatPropertySet.CONNECTOR_KEY_ALIAS	`8080`	N/A
cargo.tomcat.servletconnector.userskeystoreFile	ServletPropertySet.USERS TomcatPropertySet.CONNECTOR_KEY_STORE_FILE	`admin::manager-script`	N/A
cargo.standalonetomcat.connector.ignoreNonExistingPropertieskeystorePass	GeneralPropertySetTomcatPropertySet.IGNORECONNECTOR_NONKEY_EXISTINGSTORE_PROPERTIESPASSWORD		N/A
cargo.tomcat.startconnector.jvmargskeystoreType	GeneralPropertySet.START_JVMARGS TomcatPropertySet.CONNECTOR_KEY_STORE_TYPE		N/A
cargo.tomcat.ajpconnector.portmaxHttpHeaderSize	TomcatPropertySet.AJP_PORTCONNECTOR_MAX_HTTP_HEADER_SIZE	`8009`	N/A
cargo.tomcat.connector.clientAuthprotocolClass	TomcatPropertySet.CONNECTOR_CLIENTPROTOCOL_AUTHCLASS		N/A
cargo.tomcat.connector.keyAliassslImplementationName	TomcatPropertySet.CONNECTOR_SSL_KEYIMPLEMENTATION_ALIASNAME		N/A
cargo.tomcat.connector.keystoreFilesslProtocol	TomcatPropertySet.CONNECTOR_KEYSSL_STORE_FILEPROTOCOL		N/A
cargo.tomcat.connector.keystorePasstruststoreFile	TomcatPropertySet.CONNECTOR_KEYTRUST_STORE_PASSWORDFILE		N/A
cargo.tomcat.connector.keystoreTypetruststorePass	TomcatPropertySet.CONNECTOR_KEYTRUST_STORE_TYPEPASSWORD		N/A
cargo.tomcat.connector.sslProtocoltruststoreType	TomcatPropertySet.CONNECTOR_TRUST_SSLSTORE_PROTOCOLTYPE		N/A
cargo.tomcat.connectorcontext.truststoreFileallowCasualMultipartParsing	TomcatPropertySet.CONNECTORCONTEXT_TRUSTALLOW_STORE_FILEMULTIPART		N/A`true`
cargo.tomcat.connectorcontext.truststorePassmapJarToWebinfClasses	TomcatPropertySet.CONNECTOR_TRUST_STORE_PASSWORDCONTEXT_MAP_JARS_TO_WEBINF_CLASSES		N/A`false`
cargo.tomcat.connectorcontext.truststoreTypereloadable	TomcatPropertySet.CONNECTOR_TRUST_STORE_TYPECONTEXT_RELOADABLE		N/A`false`
cargo.tomcat.context.allowCasualMultipartParsingcopywars	TomcatPropertySet.CONTEXTCOPY_ALLOWMULTIPARTWARS		`true`
cargo.tomcat.contextembedded.reloadableoverrideJavaLogging	TomcatPropertySet.CONTEXT_RELOADABLEEMBEDDED_OVERRIDE_JAVA_LOGGING		`false`
cargo.tomcat.host.copywarsstartStopThreads	TomcatPropertySet.COPY_WARSHOST_START_STOP_THREADS	`true`	N/A
cargo.tomcat.httpSecure	TomcatPropertySet.HTTP_SECURE		`false`
cargo.tomcat.uriencoding	TomcatPropertySet.URI_ENCODING		`ISOUTF-8859-18`
cargo.tomcat.useHttpOnly	TomcatPropertySet.USE_HTTP_ONLY		N/A
cargo.tomcat.valve	TomcatPropertySet.CUSTOM_VALVE		N/A
cargo.tomcat.webappsDirectory	TomcatPropertySet.WEBAPPS_DIRECTORY		`webapps`

Info

title	Datasource and Resource configuration

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 Supportand/or resources.

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

Info

title	Configuring HTTP/2 for Tomcat 8.5 and above

Tomcat 8.5 and above support HTTP/2.

For further information on how to enable this, please refer to Configuring HTTP/2 for Tomcat 8.5 and above.

Existing Local Configuration Properties

...

Property name	Java Property	Default value
cargo.hostname	GeneralPropertySet.HOSTNAME	`localhost`
cargo.java.home	GeneralPropertySet.JAVA_HOME	JAVA_HOME version 8 or newer
cargo.jvmargs	GeneralPropertySet.JVMARGS	N/A
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.start.jvmargs	GeneralPropertySet.START_JVMARGS	N/A/A
cargo.tomcat.embedded.overrideJavaLogging	TomcatPropertySet.EMBEDDED_OVERRIDE_JAVA_LOGGING	`false`

Runtime Configuration Properties

...

Property name	Java Property	Default value
cargo.hostname	GeneralPropertySet.HOSTNAME	`localhost`
cargo.protocol	GeneralPropertySet.PROTOCOL	`http`
cargo.remote.password	RemotePropertySet.PASSWORD	N/A
cargo.remote.timeout	RemotePropertySet.TIMEOUT	`7200000`
cargo.remote.uri	RemotePropertySet.URI	N/A
cargo.remote.uri RemotePropertySet.URI .username	RemotePropertySet.USERNAME	N/A
cargo.servlet.port	ServletPropertySet.PORT	N/A`8080`
cargo.tomcat.remotedeploy.usernameupdate	RemotePropertySetTomcatPropertySet.USERNAMEDEPLOY_UPDATE	N/A`false`
cargo.servlettomcat.undeploy.portallVersions	ServletPropertySet.PORT TomcatPropertySet.UNDEPLOY_ALL_VERSIONS	`8080false`

Info

With Tomcat 9, the Tomcat manager has multiple aspects to be careful about:

Your browser by default accesses the HTML-based manager whereas CARGO Codehaus Cargo needs to use the text-based manager. As a result, if you want to set the RemotePropertySet.URI manually, please make sure you set the URL for the text-based manager, for example http://production27:8080/manager/text
The text-based manager requires to be accessed by a user with the manager-script role; and by default no user has that role. As a result, please make sure you modify your tomcat-users.xml file to give that role to a user.
You can read more in the Tomcat documentation: http https://tomcat.apache.org/tomcat-9.0-doc/manager-howto.html

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: httphttps://repo.maven.apache.org/maven2/org/apache/tomcat/tomcat/9.0.0.M2688/tomcat-9.0.0.M2688.zip

Versions Compared

Old Version 16

New Version 131

Key

Configuration Features

For embedded container o.c.c.c.tomcat.Tomcat9xEmbeddedLocalContainer

For embedded container o.c.c.c.tomcat.Tomcat9xEmbeddedLocalContainer

Existing Local Configuration Properties

Runtime Configuration Properties

Tested On