Payara Micro Maven Plugin
Payara Micro has a Maven plugin which can start and stop Payara Micro and create an Uber JAR bundle of the application and Payara Micro.
The plugin requires JDK 8 or higher and the latest version is currently
1.4.0
Configurable Goals
bundle
Aim: This goal bundles the attached project’s artifact into an Uber JAR with
the specified configurations. By default this goal is attached to the install
phase.
Usage: mvn payara-micro:bundle
Example:
<plugin>
<groupId>fish.payara.maven.plugins</groupId>
<artifactId>payara-micro-maven-plugin</artifactId>
<version>${payaramicro.maven.plugin.version}</version>
<executions>
<execution>
<goals>
<goal>bundle</goal>
</goals>
</execution>
</executions>
<configuration>
<startClass>my.custom.start.class.Main</startClass>
<deployArtifacts>
<artifactItem>
<groupId>org.mycompany</groupId>
<artifactId>my-project</artifactId>
<version>1.0</version>
<type>ear</type>
</artifactItem>
</deployArtifacts>
<customJars>
<artifactItem>
<groupId>org.primefaces</groupId>
<artifactId>primefaces</artifactId>
<version>6.0</version>
</artifactItem>
</customJars>
</configuration>
</plugin>
Element | Default | Notes |
---|---|---|
|
true |
If the extension of the produced artifact is |
|
none |
Sets context root of the deployed artifact if |
|
true |
Sets context root of the deployed artifact to |
|
(optional): |
Replaces the |
|
true |
Appends all system properties defined into the |
|
5.2021.10 |
By default bundle mojo fetches Payara Micro with version 5.2021.10 |
|
None |
Can contain a list of artifactItems, which defines the dependencies with their GAVs to be copied under MICRO-INF/deploy folder. |
|
None |
Can contain a list of artifactItems, which defines the dependencies with their GAVs to be copied under MICRO-INF/lib folder. |
|
microbundle |
Specifies the maven artifact classifier to use for the generated uber-jar. |
The bundle
goal always searches for domain configuration files in src/main/resources
to copy in to the MICRO-INF/domain
directory of the created uber jar.
The files which are currently included are:
-
domain.xml
-
hazelcast-config.xml
-
keystore.jks
-
login.conf
-
logging.properties
-
metrics.xml
Additionally boot command scripts will be included if they exist in src/main/resources
and transferred to the MICRO-INF
directory of the created uber jar artifact.
-
pre-boot-commands.txt
- provides a file of asadmin commands to run before booting the server. -
post-boot-commands.txt
- provides a file of asadmin commands to run after booting the server. -
post-deploy-commands.txt
- provides a file of asadmin commands to run after all deployments have completed.
start
Aim: This goal starts Payara Micro with the specified configuration.
Usage: mvn payara-micro:start
Example:
<plugin>
<groupId>fish.payara.maven.plugins</groupId>
<artifactId>payara-micro-maven-plugin</artifactId>
<version>${payaramicro.maven.plugin.version}</version>
<executions>
<execution>
<goals>
<goal>start</goal>
</goals>
</execution>
</executions>
<configuration>
<useUberJar>true</useUberJar>
<payaraMicroAbsolutePath>/path/to/payara-micro.jar</payaraMicroAbsolutePath>
<payaraVersion>5.2021.10</payaraVersion>
<artifactItem>
<groupId>fish.payara.extras</groupId>
<artifactId>payara-micro</artifactId>
<version>5.2021.10</version>
</artifactItem>
<daemon>true</daemon>
<javaPath>/path/to/Java/Executable</javaPath>
<deployWar>true</deployWar>
<contextRoot>myApp</contextRoot>
<javaCommandLineOptions>
<option>
<value>-Xdebug</value>
</option>
<option>
<key>-Xrunjdwp:transport</key>
<value>dt_socket,server=y,suspend=y,address=5005</value>
</option>
</javaCommandLineOptions>
<commandLineOptions>
<option>
<key>--domainconfig</key>
<value>/path/to/domain.xml</value>
</option>
<option>
<key>--autoBindHttp</key>
<value>true</value>
</option>
</commandLineOptions>
</configuration>
</plugin>
If you want to execute the payara-micro plugin along with maven-toolchains-plugin,
you need to execute the plugin as: mvn toolchains:toolchain payara-micro:start . See Using Toolchains for more information.
|
Element | Default | Notes |
---|---|---|
|
false |
Use the created uber-jar that resides in the target folder. The name of the JAR
artifact will be resolved automatically by evaluating its final name, artifact
ID and version. This configuration element has the higher precedence compared to
|
|
microbundle |
Specifies the maven artifact classifier to use for the generated uber-jar. |
|
none |
Absolute path to payara-micro executable. |
|
5.2021.10 |
By default start mojo fetches payara-micro with version 5.2021.10. |
|
none |
Defines payara-micro artifact with its coordinates. Specified artifact should be available in local maven repository. |
|
false |
Starts Payara Micro in separate JVM process and continues with the maven build. |
|
false |
If Payara Micro is executed in daemon mode, the executor thread will wait for
the ready message before shutting down its process. By setting |
|
|
Absolute path to the java executable. This has higher priority to the java executable identified via Maven toolchain. |
|
false |
If the attached project is of type WAR, it will automatically be deployed to
payara-micro if |
|
none |
Defines the context root of an application. |
|
none |
Defines a list of command line options that will be passed to |
|
none |
Defines a list of command line options that will be passed onto payara-micro. |
|
false |
Enables the Hot Deploy mode. |
stop
Aim: This goal stops Payara Micro with the specified configuration. By default
this goal tries to find the currently executing Payara Micro instance by
checking the running uberjar. If an artifactItem
is defined, it will take
precedence for identifying currently running instances. If processId
is
defined, this takes the highest precedence and the given processId
will
immediately kill the executing Payara Micro instance.
Usage: mvn payara-micro:stop
Example:
<plugin>
<groupId>fish.payara.maven.plugins</groupId>
<artifactId>payara-micro-maven-plugin</artifactId>
<version>${payaramicro.maven.plugin.version}</version>
<executions>
<execution>
<goals>
<goal>stop</goal>
</goals>
</execution>
</executions>
<configuration>
<processId>32333</processId>
<artifactItem>
<groupId>fish.payara.extras</groupId>
<artifactId>payara-micro</artifactId>
<version>{currentVersion}</version>
</artifactItem>
</configuration>
</plugin>
If you want to execute the payara-micro plugin along with maven-toolchains-plugin,
you need to execute the plugin as: mvn toolchains:toolchain payara-micro:start . See Using Toolchains for more information.
|
Element | Default | Notes |
---|---|---|
|
none |
Process id of the running Payara Micro instance. |
|
none |
Defines payara-micro artifact with its coordinates. This information is used to identify the process id of the running Payara Micro instance. |
|
false |
Use the name of the created uber-jar that resides in target folder to identify the process id of the running Payara Micro instance. |
|
microbundle |
Specifies the maven artifact classifier of the generated uber-jar to identify the process id of the running Payara Micro instance. |
|
5000 |
Defines the maximum timeout in milliseconds to wait for the process of Payara Micro Community instance to stop. |
reload
Aim: This goal reloads the Payara Micro application with the specified configuration.
By default, this goal performs the vanilla deployment of the application without restarting the
Payara Micro instance. If hotDeploy
is set to true then the Hot Deploy functionality
will be enabled.
This goal is specifically designed for integration with the IDEs and Editors. Payara Micro instance allows IDEs to deploy the application in Hot Deploy mode by reusing the existing application instance and updating its classloader & internal components relative to the modified source. This can lead to significant savings of time when an application is redeployed and boost developer productivity even more. |
Usage: mvn payara-micro:reload
Element | Default | Notes |
---|---|---|
|
false |
Enables the Hot Deploy mode. |
|
none |
Defines a list (comma separated) of the absolute paths to the source file which need to be reloaded via the Hot Deploy feature. |
|
false |
If set to true, reloads deployment descriptors metadata in Hot Deploy mode |
Using Toolchains
The Maven Toolchains provide a way for plugins to discover what JDK (or other tools) are to be used during the build and Payara Micro Maven Plugin also supports using toolchains with its configuration.
In order to use the toolchains with either payara-micro:start
or payara-micro:stop
, first toolchains plugin should be defined as:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-toolchains-plugin</artifactId>
<version>1.1</version>
<executions>
<execution>
<goals>
<goal>toolchain</goal>
</goals>
</execution>
</executions>
<configuration>
<toolchains>
<jdk>
<version>1.8</version>
<vendor>oracle</vendor>
</jdk>
</toolchains>
</configuration>
</plugin>
toolchains.xml is the file for configuring each toolchain and it should reside under the .m2 folder. A sample would be as:
<?xml version="1.0" encoding="UTF8"?>
<toolchains>
<toolchain>
<type>jdk</type>
<provides>
<version>1.7</version>
<vendor>oracle</vendor>
</provides>
<configuration>
<jdkHome>/Library/Java/JavaVirtualMachines/jdk1.7.0_80.jdk/Contents/Home</jdkHome>
</configuration>
</toolchain>
<toolchain>
<type>jdk</type>
<provides>
<version>1.8</version>
<vendor>oracle</vendor>
</provides>
<configuration>
<jdkHome>/Library/Java/JavaVirtualMachines/jdk1.8.0_131.jdk/Contents/Home</jdkHome>
</configuration>
</toolchain>
</toolchains>
The version and the vendor defined in the plugins section should match one of the entries defined in the toolchains.xml file.
After configuring the toolchain, the plugin can be executed with start
and stop
goals as:
mvn toolchains:toolchain payara-micro:start
mvn toolchains:toolchain payara-micro:stop