WebSphere Liberty

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.

The Codehaus Cargo WebSphere Liberty container is also compatible with Open Liberty.

WebSphere Liberty 22.x onwards comes with multiple versions, some tagged as Java EE and others as Jakarta EE. Users of the Jakarta EE 9 versions should be aware that, as a result of the move from Java EE to Jakarta EE as part of the transfer of Java EE to the Eclipse Foundation, the primary package for all implemented APIs has changed from javax.* to jakarta.*. This will almost certainly require code changes to enable applications to migrate to EE 9 and later.

Container Features

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

Configuration Features

Feature name	Java API	Ant tasks	Maven 3 plugin	Comment
Standalone Local Configuration for installed container	`o.c.c.c.liberty.LibertyStandaloneLocalConfiguration`
Standalone Local Configuration for embedded container
Existing Local Configuration for installed container
Existing Local Configuration for embedded container
Runtime Configuration
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.liberty.LibertyInstalledLocalDeployer`
Embedded Deployer
Remote Deployer

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

Property name	Java Property	Default value
cargo.hostname	GeneralPropertySet.HOSTNAME	`localhost`
cargo.java.home	GeneralPropertySet.JAVA_HOME	JAVA_HOME version 7 (Java EE 7 version) or 8 (Java EE 8 version) 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.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

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.

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/com/ibm/websphere/appserver/runtime/wlp-javaee8/24.0.0.12/wlp-javaee8-24.0.0.12.zip