Try Free

Deploying to Payara Server Using the Maven Cargo Plugin

Payara
Jonathan Coustick
Published: 31 May 2018
Updated: 21 Oct 2025

When creating a Java EE application it is important to deploy and test it on a server that is as close to the target production environment as possible. If you use Maven in your project, it is possible to do so using the Cargo plugin, which allows you to deploy an application to an instance of Payara Server either locally or remotely. A complete example is available at https://github.com/payara/Payara-Examples/blob/master/ecosystem/payara-maven/pom.xml.

 

The cargo plugin can be added to a Maven project by adding the following to the <plugins> section of the pom:

 

<plugin>
  <groupId>org.codehaus.cargo</groupId>
  <artifactId>cargo-maven2-plugin</artifactId>
  <version>1.7.16</version>
  <executions>
   ...
  </executions>
</plugin>

 

Execution Goals

There are four common goals you may use in your execution:

  • start
    runs goal start to start a local Payara server in background (not possible with remote deployment type)

  • redeploy
    runs goal redeploy to deploy the built application (will undeploy if needed)

  • undeploy
    runs goal undeploy to undeploy the built application

  • stop
    runs goal stop to stop the server running in background (not possible with remote deployment type)

An example of how you might use those goals to run an integration test:

 
<execution>
    <id>deploy</id>
    <phase>pre-integration-test</phase>
    <goals>
        <goal>start</goal
        <goal>redeploy</goal>
    </goals>
</execution>
<execution>
    <id>undeploy</id>
    <phase>post-integration-test</phase>
    <goals>
        <goal>undeploy</goal>
        <goal>stop</goal>
    </goals>
</execution>

 

Deploying to a Remote Instance of Payara Server

To deploy to a remote instance of Payara Server add the following configuration to the profile you are using:

 
<plugin>
  <groupId>org.codehaus.cargo</groupId>
  <artifactId>cargo-maven2-plugin</artifactId>
  <configuration>
    <container>
      <containerId>payara</containerId>
      <type>remote</type>
    </container>
    <configuration>
      <type>runtime</type>
      <properties>
        <username>admin</payara.username>
        <password></payara.password>
        <hostname>localhost</payara.hostname>
        <cargo.remote.username>${username}</cargo.remote.username>
        <cargo.remote.password>${password}</cargo.remote.password>
        <cargo.glassfish.admin.port>4848</cargo.glassfish.admin.port>
        <cargo.hostname>${hostname}</cargo.hostname>
      </properties>
    </configuration>
  </configuration>
  <!-- provides JSR88 client API to deploy on Payara Server -->
  <dependencies>
    <dependency>
      <groupId>org.glassfish.main.deployment</groupId>
      <artifactId>deployment-client</artifactId>
      <version>5.0</version>
    </dependency>           
  </dependencies>
</plugin>

 

A few important points to note about this configuration:

  • The default username for Cargo is admin.
  • The default password is adminadmin. If you have no password, then use “” as Cargo will throw an error if the password field is empty.
  • The default admin port is 4848.
  • The default hostname is localhost.
  • The start and stop execution goals cannot be used with a remote Payara Server instance; this means that the remote instance MUST be running, otherwise Maven will fail.

Deploying to a Local Instance of Payara Server

To deploy to a local instance of Payara Server add the following to the profile you are using:

 
<plugin>
  <groupId>org.codehaus.cargo</groupId>
  <artifactId>cargo-maven2-plugin</artifactId>
  <configuration>
    <container>
      <containerId>payara</containerId>
      <type>installed</type>
      <home>${payara.home}</home>
    </container>
    <configuration>
      <type>existing</type>
      <home>${payara.domainDir}</home>                 
      <properties>
        <cargo.glassfish.domain.name>${payara.domainName}</cargo.glassfish.domain.name>
      </properties>
    </configuration>
  </configuration>
  <!-- provides JSR88 client API to deploy on Payara -->
  <dependencies>
    <dependency>
      <groupId>org.glassfish.main.deployment</groupId>
      <artifactId>deployment-client</artifactId>
      <version>5.0</version>
    </dependency>
  </dependencies>
</plugin>

 

The full path to the Payara Server home, domains directory and domain name must be specified i.e.

  • payara.home=/path/to/payara5
  • payara.domainDir=/path/to/payara5/glassfish/domains
  • payara.domainName=domain1

 

Further information about the plugin is available at https://codehaus-cargo.github.io/cargo/Payara.html.

 

Share:

Contents
Download Payara Platform Community

Comments (9)

Post a comment

Your email address will not be published. Required fields are marked *

Payara needs the contact information you provide to us to contact you about our products and services. You may unsubscribe from these communications at any time. For information on how to unsubscribe, as well as our privacy practices and commitment to protecting your privacy, please review our Legal & Privacy Policy.

  1. payara user

    github link broken
    https://github.com/payara/Payara-Examples/blob/master/ecosystem/payara-maven/pom.xml

    Reply
    1. Jadon Ortlepp

      Many thanks, fixed now.

      Reply
  2. Ken Fogel

    Please review your samples more carefully. Please also assume that your reader has never used cargo in a maven project.

    Errors in tags:
    admin

    localhost

    You neglected to discuss the password.properties file when using a local server that, had you changed the admin password in Payara, still contains the original install password.

    You must also add cargo:deploy to your default goals. I like to avoid command line parameters favouring placing everything in the pom.xml that I can. This is especially important when using an IDE like NetBeans, etc.

    Reply
  3. Joni Niemi

    This doesn’t seem work on JDK 11. Any ideas on that?

    Cheers, Joni

    Reply
    1. Jonathan Coustick

      Have you tired the latest version of the cargo plugin (1.7.12)?

      Reply
      1. Joni Niemi

        Still not working, with cargo-maven3-plugin version 1.9.3, nor cargo-maven2-plugin version 1.7.12. Get ClassNotFoundException: javax/xml/bind/DatatypeConverter.

        Reply
  4. theirman

    Hello,
    With Maven, is it possible to copy by SFTP my WAR file to Payara’s autodeploy folder instead of deploying it directly in Payara-Server? (some cases of use in my company require me to go through this autodeploy folder)
    Thank you very much
    Thierry

    Reply
  5. Joni Niemi

    Failed to execute goal org.codehaus.cargo:cargo-maven3-plugin:1.9.8:redeploy (default) on project cbs: Execution default of goal org.codehaus.cargo:cargo-maven3-plugin:1.9.8:redeploy failed: error submitting remote command: org.glassfish.api.admin.CommandException: javax.net.ssl.SSLHandshakeException: Remote host closed connection during handshake: SSL peer shut down incorrectly -> [Help 1]

    Reply
    1. Ali Tokmen

      Joni, as explained on https://codehaus-cargo.github.io/cargo/JSR88.html the SSLHandshakeException happens because unfortunately even the latest version of the GlassFish Deployment Client dependency uses TLS version 1, and offers to ways to change it.

      Later versions of the Payara deployment client fix this issue by setting the default to a modern TLS version:
      – You can reference the proper version of the following (unfortunately, very large) artifact: https://repo.maven.apache.org/maven2/fish/payara/extras/payara-embedded-web/ instead of the org.glassfish.main.deployment:deployment-client
      – These newer versions also support a fish.payara.clientHttpsProtocol system variable you can set on the Java VM, enabling the choice between different TLS versions if needed

      Reply

Related Posts

payara qube logo 5 minutes
Payara
Chiara Civardi
28 Oct 2025

Payara Cloud Is Now part of Payara Qube family of Unified Platforms for Enterprise Java

Payara Cloud is becoming part of Payara Qube family of Java application deployment runtimes. This move reflects how the […]

Read More
Payara promotional graphic showing transition from Spring to Jakarta EE, including technology logos, a code icon and arrows leading from Spring to Jakarta EE. 6 minutes
Jakarta EE
Chiara Civardi
27 Oct 2025

From Spring Boot To Jakarta EE 11: How Payara Starter Eases The Transition

If you’ve been living in the Spring ecosystem, you’re used to fast project setup. Spring Initializr gives you a […]

Read More
Promotional graphic for a podcast episode titled “Why Open Source is the Future of Business Innovation - A conversation with Arun Gupta”. The podcast is hosted by Payara Community. The right side features a photo of the speaker, Arun Gupta, labeled as a “VP, Developer Experience at JetBrains”. The design uses dark blue and teal backgrounds with coral and fish illustrations. 2 minutes
Community
Dominika Tasarz
22 Oct 2025

Payara Podcast – Why Open Source is the Future of Business Innovation – A Conversation with Arun Gupta

Open source is no longer a developer-only concern — it’s at the heart of how modern businesses innovate, build […]

Read More