Aqua Help

Add Maven support to an existing project

You can open an existing non-Maven project (plain Java project) and add a Maven support via Aqua UI.

Before you start adding Maven to your project, please read Maven documentation to familiarize yourself with Maven concepts and components.

Add Maven support

  1. Open an existing project, for example, a Java project.

  2. In the Project tool window Alt+1, select the module or the project directory to which you want to add Maven.

  3. Press Ctrl+Shift+A and type Add Framework Support.

    Once the action is found, click it to open the Add Framework Support dialog.

  4. In the dialog that opens, select Maven from the options on the left and click OK.

    Add Maven support

    Aqua adds a default POM to the project and generates the standard Maven layout in Project tool window.

    Maven project view

    Aqua also creates a corresponding structure with Lifecycle and Plugins in the Maven tool window.

    Maven tool window
  5. Open the generated POM and specify a groupId. The artifactId and version are specified automatically.

    Generated POM

    Every time you change the POM, Aqua displays a popup suggesting to import your changes.

At this point you can further develop your project using Maven. We recommend making all your project changes in POM since Aqua considers pom.xml as a single source of truth.

Create an executable JAR

You can conclude the following optional steps to create an executable JAR.

  1. From the main menu, select Build | Build Project (the Build Project icon) to build project. Aqua generates target folder. Note that Aqua only compiles sources and doesn't create either JAR file or Manifest file.

  2. Create a Manifest file in the resources directory.

    Right-click the directory, select New | Directory to create the META-INF subdirectory. Then right-click the subdirectory, select New | File to create the MANIFEST.MF file.

    the Manifest file
  3. Open the MANIFEST.MF file in the editor and add information about your main class.

    Check the following code:

    Main-Class: Main

    Alternatively, we can ask Maven to add this line of code into the MANIFEST.MF file with the following code in pom.xml:

    <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <configuration> <archive> <manifest> <mainClass> Main </mainClass> </manifest> </archive> </configuration> </plugin>
  4. In your POM specify the Manifest file information, so you can use Maven to generate an executable jar file.

    POM with manifest
  5. In the Maven tool window, in the Lifecycle list, double-click the install command to generate the jar file. Aqua generates the appropriate information in the target folder and an executable JAR in the Project tool window.

    Generated JAR

    You can right-click the generated JAR and select Run to execute the file.

If the existing project contains more than one module, converting such a project into the Maven project becomes quite challenging. In this case we recommend that you create an external POM where you describe your project and open your POM as you would open a regular Maven project.

Last modified: 24 April 2024