The org.gradle.toolchains.foojay-resolver
plugin provides a repository for downloading JVMs.
It is based on the foojay DiscoAPI, therefore, the foojay API's Swagger UI can be used to explore what distributions are available. See the Matching Toolchain Specifications section below for how to select specific distributions.
TAKE HEED!
Requires Gradle 7.6 or later to work.
As opposed to most of the Gradle plugins, which are Project plugins and must be applied in
build.gradle[.kts]
files, this is a SETTINGS PLUGIN and must be applied insettings.gradle[.kts]
files.
Note
Versions prior to 1.0.0 require Java 8 or later and Gradle 7.6 or later. Versions 1.0.0 and after require Java 17 or later and Gradle 7.6 or later.
To make use of the plugin add following to your settings.gradle[.kts]
file.
// settings.gradle.kts plugins { id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0" }Groovy DSL
// settings.gradle plugins { id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0" }
This is a convention plugin meant to simplify configuration. What it does is equivalent to applying the base plugin and some extra configuration:
Kotlin DSL// settings.gradle.kts plugins { id("org.gradle.toolchains.foojay-resolver") version "1.0.0" } toolchainManagement { jvm { javaRepositories { repository("foojay") { resolverClass.set(org.gradle.toolchains.foojay.FoojayToolchainResolver::class.java) } } } }Groovy DSL
// settings.gradle plugins { id("org.gradle.toolchains.foojay-resolver") version "1.0.0" } toolchainManagement { jvm { javaRepositories { repository("foojay") { resolverClass = org.gradle.toolchains.foojay.FoojayToolchainResolver } } } }
Feel free to use either approach.
For further information about using Toolchain Download Repositories consult the Gradle Manual.
Matching Toolchain SpecificationsThe main thing the plugin does is to match Gradle's toolchain specifications to foojay DiscoAPI distributions and packages.
nativeImageCapable
criteria
When set, it is used to filter out distributions that are not capable of creating native images with GraalVM.
There is mostly a 1-to-1 relationship between the DiscoAPI's distributions and Gradle vendors. The plugin works with the following mapping:
Gradle JVM Vendor Foojay Distribution ADOPTIUM Temurin ADOPTOPENJDK AOJ AMAZON Corretto APPLE - AZUL Zulu BELLSOFT Liberica GRAAL_VM Graal VM CE 8/11/16/17/19 HEWLETT_PACKARD - IBM Semeru IBM_SEMERU* Semeru JETBRAINS JetBrains MICROSOFT Microsoft ORACLE Oracle OpenJDK SAP SAP MachineTo note: Not all Gradle vendors have an equivalent DiscoAPI distribution, empty cells indicate that no toolchain will be provisioned. If no vendor is specified, distributions are iterated in the order they are provided by the DiscoAPI, and the first one that has a compatible installation package available is selected. The exception to the Foojay ordering of distributions is that "Temurin" (ADOPTIUM) and then "AOJ" (ADOPTOPENJDK) come first, due to the history of the auto-provisioning feature in Gradle, specifically that AdoptOpenJDK/Adoptium have been the default sources for downloading JVMs.
Warning
IBM_SEMERU
is deprecated in Gradle for a while and removed in Gradle 9+.
When specifying toolchains Gradle distinguishes between J9
JVMs and VENDOR_SPECIFIC
ones (ie. any other). What this criteria does in the plugin is to influence the Vendor-to-Distribution matching table. VENDOR_SPECIFICATION
doesn't change it at all, while J9
alter it like this:
Empty cells indicate that no toolchain will be provisioned
Warning
IBM_SEMERU
is deprecated in Gradle for a while and removed in Gradle 9+.
Once the vendor and the implementation values of the toolchain spec have been used to select a DiscoAPI distribution, a specific package of that distribution needs to be picked by the plugin, in order for it to obtain a download link. The inputs it uses to do this are:
Additional criteria used for selection:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4