Field Detail

• public static final boolean IS_MACOSX

• public static final boolean IS_WINDOWS

• protected final ConfigCacheSafeOperations configCacheSafeOperations

  Project operations that can used during downloading.

• protected final String distributionName

  Name of the distribution.

• protected final java.util.List<String> execPatterns

  Defined execution patterns.

  Since:

  5.5

Property Detail

• ArtifactRootVerification artifactRootVerification

• ArtifactUnpacker artifactUnpacker

• String sdkManCandidateName

Constructor Detail

• protected AbstractDistributionInstaller(String distributionName, String basePath, ConfigCacheSafeOperations taskComponents)

  Creates setup for installing to a local cache.

  Parameters:

  distributionName - Descriptive name of the distribution

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

  taskComponents - Gradle project operations that this downloader can use.

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 String extractFinalExtension(String filename)

  Extract the last extension in a file name.

  Parameters:

  filename - Filename

  Returns:

  The right-most extension.

  Since:

  5.0

• protected File getDistFromCache(String version)

  Creates a distribution if it does not exist already.

  Returns:

  Location of distribution

• protected File getDistFromSdkMan(String version)

  Attempts to locate distribution in the list of SdkMan candidates.

  Returns:

  Location of the distribution if found in the candidate area.

• @Override Provider<File> getDistributionFile(String version, String fileRelPath)

  Locates a file within the distribution

  Parameters:

  version - Version of distribution to search.

  fileRelPath - Relative path to the distribution root.

  Returns:

  Location of the file in the distribution.

• Provider<File> getDistributionRoot(String version)

  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.

• @Override String getSdkManCandidateName()

  SDKman candidate name for distribution.

  Returns:

  Name of SDKman candidate. Can be null.

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

  Provides a list of directories below an unpacked distribution

  Parameters:

  distDir - Unpacked distribution directory

  Returns:

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

• protected File resolveDistributionLocationForVersion(String version)

  Resolves distribution location by looking in various locations.

  Parameters:

  version - Version to resolve

  Returns:

  Location or null if nothing could be found.

• void setChecksum(String cs)

  Set a checksum that needs to be verified against downloaded archive

  Parameters:

  cs - SHA-256 Hex-encoded checksum

• void setDownloadRoot(Object 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.

• 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

  Parameters:

  srcArchive - The location of the download archive

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

• @javax.annotation.Nullable protected Parameters unpackParametersForExtension(String extension)

  Returns custom parameters for initialising an unpack engine.

  Implementors can override this to return specific parameters depending on the kind of extension to unpack.

  The default implementation sets a relative path for .dmg files and a basic environment for .msi files.

  Parameters:

  extension - Archive or compressed file extension.

  Returns:

  Custom parameters or null if no specific parameters exist.

  Since:

  5.0

• protected File verifyDistributionRoot(File distDir)

  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.

  Parameters:

  distDir - Directory where distribution was unpacked to.

  Returns:

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

  Throws:

  DistributionFailedException if distribution failed to meet criteria.

• 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