Payara

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.

Users of Payara 6.x onwards 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 Payara 6.x and later.

Container Features

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

Configuration Features

Feature name	Java API	Ant tasks	Maven 3 plugin	Comment
Standalone Local Configuration for installed container	`o.c.c.c.payara.PayaraStandaloneLocalConfiguration`
Standalone Local Configuration for embedded container
Existing Local Configuration for installed container	`o.c.c.c.payara.PayaraExistingLocalConfiguration`
Existing Local Configuration for embedded container
Runtime Configuration	`o.c.c.c.payara.PayaraRuntimeConfiguration`
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.payara.PayaraInstalledLocalDeployer`
Embedded Deployer
Remote Deployer	`o.c.c.c.payara.PayaraRemoteDeployer`

Adding arguments to the Deployer

The Payara installed deployer allows for additional deployment and undeployment arguments by adding properties prefixed with GlassFishPropertySet.DEPLOY_ARG_PREFIX and GlassFishPropertySet.UNDEPLOY_ARG_PREFIX respectively followed by a number starting at 1.

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

Property name	Java Property	Default value
cargo.glassfish.admin.port	GlassFishPropertySet.ADMIN_PORT	`4848`
cargo.glassfish.domain.debug	GlassFishPropertySet.DEBUG_MODE	`false`
cargo.glassfish.domain.jmxPort	GlassFishPropertySet.JMX_ADMIN_PORT	`8686`
cargo.glassfish.domain.name	GlassFishPropertySet.DOMAIN_NAME	`cargo-domain`
cargo.glassfish.http.ssl.port	GlassFishPropertySet.HTTPS_PORT	`8181`
cargo.glassfish.java.debugger.port	GlassFishPropertySet.DEBUGGER_PORT	`9009`
cargo.glassfish.jms.port	GlassFishPropertySet.JMS_PORT	`7676`
cargo.glassfish.orb.listener.port	GlassFishPropertySet.IIOP_PORT	`3700`
cargo.glassfish.orb.mutualauth.port	GlassFishPropertySet.IIOP_MUTUAL_AUTH_PORT	`3920`
cargo.glassfish.orb.ssl.port	GlassFishPropertySet.IIOPS_PORT	`3820`
cargo.glassfish.osgi.shell.telnet.port	GlassFishPropertySet.OSGI_SHELL_PORT	`6666`
cargo.glassfish.portbase	GlassFishPropertySet.PORT_BASE	N/A
cargo.glassfish.removeDefaultDatasource	GlassFishPropertySet.REMOVE_DEFAULT_DATASOURCE	`true`
cargo.hostname	GeneralPropertySet.HOSTNAME	`localhost`
cargo.java.home	GeneralPropertySet.JAVA_HOME	JAVA_HOME version: 7 (Payara 4.x) 8 (Payara 5.x) 11 (Payara 6.x) 21 (Payara 7.x onwards) or newer Payara 4.x doesn't run on Java 9 and above
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.remote.password	RemotePropertySet.PASSWORD	`adminadmin`
cargo.remote.username	RemotePropertySet.USERNAME	`admin`
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.

Existing Local Configuration Properties

For installed container o.c.c.c.payara.PayaraInstalledLocalContainer

Property name	Java Property	Default value
cargo.glassfish.admin.port	GlassFishPropertySet.ADMIN_PORT	`4848`
cargo.glassfish.domain.debug	GlassFishPropertySet.DEBUG_MODE	`false`
cargo.glassfish.domain.name	GlassFishPropertySet.DOMAIN_NAME	`cargo-domain`
cargo.hostname	GeneralPropertySet.HOSTNAME	`localhost`
cargo.jvmargs	GeneralPropertySet.JVMARGS	N/A
cargo.port.offset	GeneralPropertySet.PORT_OFFSET	`0`
cargo.process.spawn	GeneralPropertySet.SPAWN_PROCESS	`false`
cargo.remote.password	RemotePropertySet.PASSWORD	`adminadmin`
cargo.remote.username	RemotePropertySet.USERNAME	`admin`
cargo.runtime.args	GeneralPropertySet.RUNTIME_ARGS	N/A
cargo.servlet.port	ServletPropertySet.PORT	`8080`
cargo.start.jvmargs	GeneralPropertySet.START_JVMARGS	N/A

Runtime Configuration Properties

Before using the Payara remote deployer, please read: JSR88

For remote container o.c.c.c.payara.PayaraRemoteContainer

Property name	Java Property	Default value
cargo.glassfish.admin.port	GlassFishPropertySet.ADMIN_PORT	`4848`
cargo.glassfish.target	GlassFishPropertySet.TARGET	N/A
cargo.hostname	GeneralPropertySet.HOSTNAME	`localhost`
cargo.remote.password	RemotePropertySet.PASSWORD	`adminadmin`
cargo.remote.timeout	RemotePropertySet.TIMEOUT	`120000`
cargo.remote.username	RemotePropertySet.USERNAME	`admin`

Recent versions of Payara might have issues getting deployables uploaded via JSR-88, resulting in errors such as:

Distributing failed: Action failed Deploying application to target server failed; File not found

Please follow the remote deployment instructions for recent Payara versions.

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/fish/payara/distributions/payara/6.2024.10/payara-6.2024.10.zip