Payara Community Documentation

Currently Viewing Skip version selector. Download Enterprise Documentation

Payara Platform
Edit this Page

Building Payara IntelliJ Tools

The process of building and testing the IntelliJ IDEA IDE Plugin, is the same for both the Ultimate and Community versions of the plugin. After cloning the appropriate repository, the following steps can be applied to either plugin.

The Payara IntelliJ Community Tools source code is available in the Ecosystem IntelliJ Community repository.

The Payara IntelliJ Ultimate Tools source code is available in the Ecosystem IntelliJ Ultimate repository.

Prerequisites

Before building the Payara IntelliJ Tools, you will need to configure your local environment. Subsequent builds will not require these steps.

Clone the relevant repository

You must first clone the appropriate repository for the IntelliJ IDEA plugin you are trying to build.

JDK 11

JDK 11 is required to build and test the IntelliJ IDEA plugin.

Install Gradle

Gradle is the build tool for the Payara IntelliJ Tools. You can either download and configure Gradle locally or use the Gradle wrapper in the source code.

Build Payara IntelliJ Tools

To build the Payara IntelliJ Tools, run the following command from the root directory where the project was cloned:

If you installed Gradle

  1. gradle build

If you are using the Gradle wrapper

  1. ./gradlew build

After a successful build, the final ZIP distribution will be located in the /build/distributions directory. This ZIP file can be installed into IntelliJ IDEA.

Install Payara Tools into IntelliJ IDEA

After the Payara Tools plugin has been built, you can install it in IntelliJ IDEA as follows:

  1. Open the Settings menu (Ctrl + Alt + S)

  2. Open the Plugins panel

  3. Click the ⚙️ cog icon and select Install Plugin from Disk

  4. Select the compiled ZIP file from the /build/distributions directory

Install Compiled Plugin

Removing Payara Tools from IntelliJ IDEA

To uninstall the plugin:

  1. Open the Settings menu (Ctrl + Alt + S)

  2. Open the Plugins panel

  3. Right-click the Payara Tools plugin

  4. Click Uninstall

Remove Complied Plugin

Test Payara Tools

Instead of manually installing the plugin each time, you can run a test instance of IntelliJ IDEA with the plugin pre-installed using the following:

If you installed Gradle

  1. gradle runIde

If you are using the Gradle wrapper

  1. ./gradlew runIde

This will launch a sandboxed IntelliJ IDEA environment with the plugin enabled for testing purposes.