Maven Support

This section describes Apache Maven support for Payara Micro.

Artifacts in Maven Central

Payara Micro Community has been uploaded to Maven Central, allowing you to include it as a dependency in your POM.

This allows you to easily add the required Payara Micro classes and methods to your application to use Payara Micro Community programmatically.

In your project’s POM, include the following dependency:

<dependency>
    <groupId>fish.payara.extras</groupId>
    <artifactId>payara-micro</artifactId>
    <version>${payara.version}</version>
</dependency>

${payara.version} is a Maven property, which specifies the version of the Maven artifact, e.g. 5.2020.3.

Public API Reference

Since Payara Micro 4.1.1.171

Starting from this release, you need to add a dependency to the Public API when developing applications that use proprietary features (@Clustered or @NamedCache for example)

Run Payara Micro using the Maven Plugin

There is a maven plugin built specifically for use with Payara Micro. It has goals to bundle the application into an Uber JAR, start and stop Payara Micro. This plugin is fully documented in the Ecosystem section.

Run Payara Micro using the NetBeans IDE

There is a NetBeans IDE plugin - payara.micro module built specifically for Payara Micro to create and manage the application actions (e.g run, reload & debug). This plugin is fully documented in the Ecosystem - Payara Plugin section.