Property Detail

• static final String INSTALLER_VERSION

• static final boolean IS_WINDOWS

Constructor Detail

• protected AbstractDistributionInstaller(String distributionName, String distributionVersion, String basePath, Project project)

  Creates setup for installing to a local cache.

  Parameters:

  distributionName - Descriptive name of the distribution

  distributionVersion - Version of the distribution to obtain

  basePath - Relative path below Gradle User Home to create cache for all version of this distribution type.

  project - Gradle project that this downloader is attached to.

Method Detail

• void addExecPattern(String... relPaths)

  Add patterns for files to be marked exe, Calling this method multiple times simply appends for patterns

  Parameters:

  relPaths - One or more ANT-stype include patterns

• protected File getAndVerifyDistributionRoot(File distDir, String distributionDescription)

  Validates that the unpacked distribution is good.

  The default implementation simply checks that only one directory should exist and then uses that. You should override this method if your distribution in question does not follow the common practice of one top-level directory.

  Returns:

  The directory where the real distribution now exists. In the default implementation it will be the single directory that exists below distDir.

  Parameters:

  distDir - Directory where distribution was unpacked to.

  distributionDescription - A descriptive name of the distribution

  Throws:

  DistributionFailedException if distribution failed to meet criteria.

• File getDistributionRoot()

  Returns the location which is the top or home folder for a distribution. This value is affected by setDownloadRoot(java.io.File) and the parameters passed in during construction time.

  Returns:

  Location of the distribution.

• protected BaseProgressLogger getLogger()

  Returns the logger currently in use.

  Returns:

  Wrapper logger instance

• protected Project getProject()

  Returns the attached project

  Returns:

  Attached project instance

• protected java.util.List<File> listDirs(File distDir)

  Provides a list of directories below an unpacked distribution

  Returns:

  List of directories. Can be empty is nothing was unpacked or only files exist within the supplied directory.

  Parameters:

  distDir - Unpacked distribution directory

• File locateDistributionInCustomLocation(String version)

  Override this method to provide alternative means to look for distributions.

  Returns:

  Location of distribution or null if none were found.

  Version:

  Version of distribution to locate

• void setChecksum(String cs)

  Set a checksum that needs to be verified against downloaded archive

  Parameters:

  cs - SHA-256 Hex-encoded checksum

• void setDownloadRoot(File downloadRootDir)

  Sets a download root directory for the distribution. If not supplied the default is to use the Gradle User Home. This method is provided for convenience and is mostly only used for testing purposes. The folder will be created at download time if it does not exist.

  Parameters:

  downloadRootDir - Any writeable directory on the filesystem.

• void setSdkManCandidateName(String sdkCandidateName)

  Set candidate name for SdkMan if the latter should be searched for installed versions

  Parameters:

  sdkCandidateName - SDK Candidate name. This is the same names that will be shown when running sdk list candidates on the script-line.

• @groovy.transform.CompileDynamic protected void unpack(File srcArchive, File destDir)

  Unpacks a downloaded archive.

  The default implementation supports the following formats:

  • zip
  • tar
  • tar.gz & tgz
  • tar.bz2 & tbz
  • tar.xz

  If you need MSI support you need to override this method and call out to the provided unpackMSI method yourself.

  Parameters:

  srcArchive - The location of the download archive

  destDir - The directory where the archive needs to be unpacked into

• protected void unpackMSI(File srcArchive, File destDir, java.util.Map<String, String> env)

  Provides the capability of unpacking an MSI file under Windows by calling out to msiexec.

  msiexec will be located via the system search path.

  Parameters:

  srcArchive - The location of the download MSI

  destDir - The directory where the MSI needs to be unpacked into

  env - Environment to use. Can be null or empty inwhich case a default environment will be used

• URI uriFromVersion(String version)

  Creates a download URI from a given distribution version

  Returns:

  Parameters:

  version - Version of the distribution to download

• protected void verifyDownloadChecksum(String sourceUrl, File localCompressedFile, String expectedSum)

  Verifies the checksum (if provided) of a newly downloaded distribution archive.

  Only SHA-256 is supported at this point in time.

  Parameters:

  sourceUrl - The URL/URI where it was downloaded from

  localCompressedFile - The location of the downloaded archive

  expectedSum - The expected checksum. Can be null in which case no checks will be performed.

  Throws:

  ChecksumFailedException if the checksum did not match