Field Detail

• public static final boolean IS_MACOSX

• public static final boolean IS_WINDOWS

• protected final ConfigCacheSafeOperations ccso

  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

Constructor Detail

• protected AbstractBaseDistributionInstaller(String distributionName, String basePath, ConfigCacheSafeOperations ccso)

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(URI distUri, String decorativeName)

  Creates a distribution if it does not exist already.

  Parameters:

  distUri - URI where distribution is located.

  decorativeName - A name to using during download process.

  Returns:

  Location of distribution

• 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.

• @Override 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.

• 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