tentackle-jlink:jlink

Full name:

org.tentackle:tentackle-jlink-maven-plugin:25.20.1.0:jlink

Description:

Creates a self-contained java application with the jlink tool.

This mojo works for modular, non-modular and even mixed applications. It's not just a wrapper for jlink, but analyzes the project's dependencies and finds the best strategy to invoke jlink to create a directory containing an application-specific jimage module. As a result, it requires only minimum configuration.

Basically, applications fall into one of 3 categories:

1. Full-blown modular applications: all module-infos must require real modules only. Jlink creates an image from those modules. Optional artifacts and runtime modules can still be added.
2. Modular applications with non-modular dependencies: jlink is used to create an image from the minimum necessary java runtime modules only, which are determined by the plugin either from the module-infos or via the jdeps tool. The application's dependencies are placed on the modulepath via the generated run-script.
3. Non-modular traditional classpath applications: same as 2, but all dependencies are placed on the classpath.

Artifacts not processed by jlink are copied to separate folders and passed to the java runtime explicitly via the module- and/or classpath. A platform-specific launch script will be generated according to the runTemplate. For applications using Tentackle's auto update feature, an update script is generated via the updateTemplate as well. Finally, the created directory is packed into a deployable zip file.

The minimum plugin configuration is very simple:

  ...
  <packaging>jlink</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>

The template model provides the following variables:

• mainModule: the name of the main module. Empty if classpath application.
• mainClass: the name of the main class.
• modulePath: the module path.
• classPath: the class path.
• phase: the mojo lifecycle phase.
• goal: the plugin goal (jlink or jpackage).
• id: the execution id.
• layered: whether isolated module layers are configured (see getLayers()). Only if layered: bootstrapModule and bootstrapClass, the module and class to launch instead of the main class, and layersConfigPath, the path of the generated layers configuration.
• runScript: the name of the generated run script (update template only).
• all system properties (dots in property names translated to camelCase, e.g. "os.name" becomes "osName").
• all maven properties (translated to camelCase as well).
• the plugin configuration getVariables().

Modules not passed to jlink and automatic modules are copied to the mp folder and added to the modulePath template variable. If no such modules are detected, no folder is created.
Non-modular classpath artifacts are copied to the cp folder and added to the classPath template variable. Again, the folder will only be created if necessary.
Additional project resources, such as property files or logger configurations, are copied to the conf directory and this directory prepended to the classpath.

The generation of the ZIP-file and attachment of the artifact for installation and deployment can be customized by an application-specific implementation. This allows further modification of the generated image or files in the jlink target directory. It is also possible to add more than one artifact, for example, each with a different configuration. To do so, provide a plugin dependency that contains a class annotated with @Service(ArtifactCreator).

Notice that you can create an image for a different java version than the one used for the maven build process by selecting a toolchain via <jdkToolchain> (see org.tentackle.maven.AbstractTentackleMojo.getToolchain()).

Attributes:

• Requires a Maven project to be executed.
• Requires dependency resolution of artifacts in scope: runtime.
• The goal is thread-safe and supports 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>

  <excludeResources>
    <excludeResource>**/OSGI-INF/**</excludeResource>
    <excludeResource>*.jcov</excludeResource>
  </excludeResources>

  <jdkToolchain>
    <version>25</version>
  </jdkToolchain>

  <jdkToolchain></jdkToolchain>

   <modulePathOnly>
       <!-- kwik 0.10.9 illegally requires automatic module io.whitfin:siphash -->
       <module>org.tentackle.quic</module>
       <module>tech.kwik.core</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>

  <excludeResources>
    <excludeResource>**/OSGI-INF/**</excludeResource>
    <excludeResource>*.jcov</excludeResource>
  </excludeResources>

  <jdkToolchain>
    <version>25</version>
  </jdkToolchain>

  <jdkToolchain></jdkToolchain>

   <modulePathOnly>
       <!-- kwik 0.10.9 illegally requires automatic module io.whitfin:siphash -->
       <module>org.tentackle.quic</module>
       <module>tech.kwik.core</module>
   </modulePathOnly>

  <modulePathOnly>all</modulePathOnly>

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

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