jre:jre-bundler

Full name:

io.github.samurai016.plugins:jre-maven-plugin:1.0.0:jre-bundler

Description:

Bundles a JRE inside the project.
It can download the JRE and (optionally) unzip it to a specified directory.

Attributes:

Requires a Maven project to be executed.
The goal is not marked as thread-safe and thus does not support parallel builds.
Binds by default to the lifecycle phase: package.

Optional Parameters

Name	Type	Since	Description
`<architecture>`	`Architecture`	`-`	The architecture of the JRE to download. Default: `x64`
`<imagetype>`	`ImageType`	`-`	The type of image to download. It is suggested to use the jre image type (it is the smallest one). Default: `jre`
`<jvmImpl>`	`JVMImpl`	`-`	The JVM implementation to download. Currently, only hotspot is supported. Default: `hotspot`
`<movetoroot>`	`boolean`	`-`	If true, the contents of the first-level folder in the JRE zip will be moved to the root. If false, the contents will be extracted in the first-level folder. e.g. * unzipto = `{{project.build.directory}}/jre` * movetoroot = `true` * JRE zip contents: `jdk-16.0.1/bin`, `jdk-16.0.1/lib`, ... * Output: `{{project.build.directory}}/jre/bin`, `{{project.build.directory}}/jre/lib`, ... e.g. * unzipto = `{{project.build.directory}}/jre` * movetoroot = `false` * JRE zip contents: `jdk-16.0.1/bin`, `jdk-16.0.1/lib`, ... * Output: `{{project.build.directory}}/jre/jdk-16.0.1/bin`, `{{project.build.directory}}/jre/jdk-16.0.1/lib`, ... Default: `true`
`<os>`	`OperatingSystem`	`-`	The operating system of the JRE to download. Default: `windows`
`<outputdir>`	`String`	`-`	The directory where the JRE will be downloaded. If not specified, it will use the project build directory. The path can contain variables in the form `{{variable}}`. See [the documentation]() for the list of available variables. Default: `${project.build.directory}/jre`
`<outputfilename>`	`String`	`-`	The name of the output file. If not specified, it will use the release name of the JRE. If the name does not end with ".zip", it will be appended. The path can contain variables in the form `{{variable}}`. See the documentation for the list of available variables.
`<unzipto>`	`String`	`-`	The directory where the JRE will be unzipped. If not specified, the JRE will not be unzipped. The path can contain variables in the form `{{variable}}`. See the documentation for the list of available variables.
`<vendor>`	`Vendor`	`-`	The vendor of the JRE to download. Currently, only Eclipse is supported. Default: `eclipse`
`<version>`	`int`	`-`	The version of the JRE to download. If not specified, it will use the Maven compiler source version. It should be a valid Java feature release (e.g. 8, 11, 16). Default: `${maven.compiler.source}`

Parameter Details

<architecture>

The architecture of the JRE to download.

Type: io.github.samurai016.plugins.adoptium.models.Architecture
Required: No
Default: x64

<imagetype>

The type of image to download.
It is suggested to use the jre image type (it is the smallest one).

Type: io.github.samurai016.plugins.adoptium.models.ImageType
Required: No
Default: jre

<jvmImpl>

The JVM implementation to download.
Currently, only hotspot is supported.

Type: io.github.samurai016.plugins.adoptium.models.JVMImpl
Required: No
Default: hotspot

<movetoroot>

If true, the contents of the first-level folder in the JRE zip will be moved to the root.
If false, the contents will be extracted in the first-level folder.

e.g.
* unzipto = {{project.build.directory}}/jre
* movetoroot = true
* JRE zip contents: jdk-16.0.1/bin, jdk-16.0.1/lib, ...
* Output: {{project.build.directory}}/jre/bin, {{project.build.directory}}/jre/lib, ...

e.g.
* unzipto = {{project.build.directory}}/jre
* movetoroot = false
* JRE zip contents: jdk-16.0.1/bin, jdk-16.0.1/lib, ...
* Output: {{project.build.directory}}/jre/jdk-16.0.1/bin, {{project.build.directory}}/jre/jdk-16.0.1/lib, ...

Type: boolean
Required: No
Default: true

<os>

The operating system of the JRE to download.

Type: io.github.samurai016.plugins.adoptium.models.OperatingSystem
Required: No
Default: windows

<outputdir>

The directory where the JRE will be downloaded.
If not specified, it will use the project build directory.

The path can contain variables in the form {{variable}}.
See [the documentation]() for the list of available variables.

Type: java.lang.String
Required: No
Default: ${project.build.directory}/jre

<outputfilename>

The name of the output file.
If not specified, it will use the release name of the JRE.
If the name does not end with ".zip", it will be appended.

The path can contain variables in the form {{variable}}.
See the documentation for the list of available variables.

Type: java.lang.String
Required: No

<unzipto>

The directory where the JRE will be unzipped.
If not specified, the JRE will not be unzipped.

The path can contain variables in the form {{variable}}.
See the documentation for the list of available variables.

Type: java.lang.String
Required: No

<vendor>

The vendor of the JRE to download.
Currently, only Eclipse is supported.

Type: io.github.samurai016.plugins.adoptium.models.Vendor
Required: No
Default: eclipse

<version>

The version of the JRE to download.
If not specified, it will use the Maven compiler source version.
It should be a valid Java feature release (e.g. 8, 11, 16).

Type: int
Required: No
Default: ${maven.compiler.source}