tentackle-jlink:jpackage

Full name:

org.tentackle:tentackle-jlink-maven-plugin:21.16.1.0:jpackage

Description:

Creates a java application installer with the jpackage tool.

The mojo works in 4 phases:

1. Invokes the jlink tool as described in JLinkMojo. This will generate a directory holding the runtime image. However, no run or update scripts and no zip file will be created.
2. Invokes the jpackage tool to generate the application image from the previously created runtime image. Application- and platform specific options can be configured via the packageImageTemplate.
3. If the runtime image contains extra classpath- or modulepath-elements, the generated config files will be patched. This is especially necessary to provide the correct classpath order according to the maven/module dependency tree, which usually differs from the one determined by jpackage, because jpackage has no idea about the maven project structure and does its own guess according to the packages referenced from within the jars. This may become an issue if the classpath order is critical, such as configurations overridden in META-INF.
4. Finally, the installer will be generated from the application image. The packageInstallerTemplate is used to provide additional options to the jpackage tool.

  ...
  <packaging>jpackage</packaging>
  ...
      <plugin>
        <groupId>org.tentackle</groupId>
        <artifactId>tentackle-jlink-maven-plugin</artifactId>
        <version>${tentackle.version}</version>
        <extensions>true</extensions>
        <configuration>
          <mainModule>com.example</mainModule>
          <mainClass>com.example.MyApp</mainClass>
        </configuration>
      </plugin>

If the application is built with Tentackle's update feature, please keep in mind that applications deployed by an installer are maintained by a platform specific package manager. If the installation is system-wide, the installation files cannot be changed by a regular user. Some platforms, however, also provide per-user installations that can be updated. For Windows, the jpackage tool provides the option --win-per-user-install. MacOS allows the user to decide whether to install system-wide or for the current user only. See isWithUpdater() for more details.

If both jlink zip-files and jpackage installers are required, change the packaging type to jar and add executions, like this:

        <executions>
          <execution>
            <id>both</id>
            <goals>
              <goal>jlink</goal>
              <goal>jpackage</goal>
            </goals>
          </execution>
        </executions>

The contents of the application image and attachment of the artifacts for installation and deployment can be customized by an application-specific implementation. To do so, provide a plugin dependency that contains a class annotated with @Service(ArtifactCreator).

Important: the jpackage tool is available since Java 14.

Notice that you can create an image for a different java version than the one used by the maven build process via org.tentackle.maven.AbstractTentackleMojo.getToolchain(). Furthermore, you can select the jpackage tool explicitly from another JDK via jpackageToolchain or jpackageTool.

Attributes:

• Requires a Maven project to be executed.
• Requires dependency resolution of artifacts in scope: runtime.
• The goal is not marked as thread-safe and thus does not support parallel builds.
• Binds by default to the lifecycle phase: package.

<addModules>
  <addModule>jdk.localedata</addModule>
  <addModule>jdk.jcmd</addModule>
</addModules>

<excludeModules>
  <excludeModule>jdk8internals</excludeModule>
</excludeModules>

  <jdkToolchain>
    <version>14</version>
  </jdkToolchain>

  <jdkToolchain></jdkToolchain>

  <jpackageToolchain>
    <version>14</version>
  </jpackageToolchain>

  <jpackageToolchain></jpackageToolchain>

   <modulePathOnly>
       <module>tentackle.log.log4j2v</module>
       <module>org.apache.logging.log4j</module>
   </modulePathOnly>

  <modulePathOnly>all</modulePathOnly>

 <variables>
   <project>${project.basedir}</project>
 </variables>

  --icon ${project}/src/pkg/myapp.ico

<addModules>
  <addModule>jdk.localedata</addModule>
  <addModule>jdk.jcmd</addModule>
</addModules>

<excludeModules>
  <excludeModule>jdk8internals</excludeModule>
</excludeModules>

  <jdkToolchain>
    <version>14</version>
  </jdkToolchain>

  <jdkToolchain></jdkToolchain>

  <jpackageToolchain>
    <version>14</version>
  </jpackageToolchain>

  <jpackageToolchain></jpackageToolchain>

   <modulePathOnly>
       <module>tentackle.log.log4j2v</module>
       <module>org.apache.logging.log4j</module>
   </modulePathOnly>

  <modulePathOnly>all</modulePathOnly>

 <variables>
   <project>${project.basedir}</project>
 </variables>

  --icon ${project}/src/pkg/myapp.ico