Building Payara Tools Eclipse IDE Plugin

The Payara Tools Eclipse IDE Plugin source code is available in the Eclipse Plugin repository.

Prerequisites

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

Clone the ecosystem-eclipse-plugin repository

You must first clone the repository where the plugin source code is stored. Eclipse Plugin repository

Set the JAVA_HOME environment variable

An environment variable named JAVA_HOME must be created and point to a valid JDK 17 installation.

Install Apache Maven

Apache Maven is the build tool for the Payara Tools Eclipse IDE Plugin and must be configured locally. Visit Apache Maven Installation to install Maven.

Build Payara Tools

To build Payara Tools for Eclipse, navigate to the root directory of the cloned repository and run the following command:

mvn clean install

This command will initiate the build process for the Payara Tools Eclipse plugin using Maven.

The build job will create both a zip and exploded-directory format. The zip format of this build can be found in the [project_root]/releng/fish.payara.eclipse.update/target directory, and the exploded-directory format can be found in the [project_root]/releng/fish.payara.eclipse.update/target/repository directory.

Install Payara Tools into Eclipse

After Payara Tools for Eclipse has been compiled successfully, you need to add it into the Eclipse IDE.

Adding Payara Tools to Eclipse
  1. Navigate to Help → Install New Software…​

  2. Click Add → Archive…​

  3. Select the zip format in [project_root]/releng/fish.payara.eclipse.update/target

  4. Select the Eclipse Payara Tools checkbox

  5. Click Next → Finish

  6. Select Install Anyway

  7. Restart Eclipse when prompted

Installing Payara Tools

Removing Payara Tools from Eclipse

Removing Payara Tools from Eclipse after installing using the method above is the same as removing any plugin from Eclipse.

Removing Payara Tools from Eclipse
  1. Navigate to Help → Eclipse Marketplace

  2. Open the Installed tab

  3. Locate Payara Tools and click Uninstall