AbstractSingleFileInstaller (Grolifant Core API)

org.ysb33r.grolifant5.api.core.downloader.AbstractSingleFileInstaller

All Implemented Interfaces and Traits:: VersionBasedSingleFileInstaller

@groovy.transform.InheritConstructors
@groovy.transform.CompileStatic
abstract class AbstractSingleFileInstaller
extends AbstractDistributionInstaller
implements VersionBasedSingleFileInstaller

Installer for single files. Works really well for single GO-based executables.

Authors:: Schalk W. Cronjé

Since:: 2.0

Inherited fields
Fields inherited from class	Fields
`class AbstractBaseDistributionInstaller`	`IS_MACOSX, IS_WINDOWS, ccso, distributionName, execPatterns`

Constructor Summary

Constructors
Constructor and description
`AbstractSingleFileInstaller ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Provider<File>`	`getSingleFile(String version)` Returns the path to the `terraform` executable.
	`protected abstract String`	`getSingleFileName()` Gets the name of the single file as it should be on local disk
	`protected void`	`unpack(File singleFile, File destDir)` Changes the behaviour to not unpack, but simply mark file as executable if the file pattern matches.
	`protected File`	`verifyDistributionRoot(File distDir)` Validates that the downloaded file is good.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractDistributionInstaller`	`getDistFromCache, getDistFromSdkMan, getDistributionFile, getDistributionRoot, getSdkManCandidateName, resolveDistributionLocationForVersion, setSdkManCandidateName`
`class AbstractBaseDistributionInstaller`	`addExecPattern, extractFinalExtension, getDistFromCache, listDirs, setChecksum, setDownloadRoot, unpack, unpackParametersForExtension, verifyDistributionRoot, verifyDownloadChecksum`

- Constructor Detail
  - AbstractSingleFileInstaller()
- Method Detail
  - @Override Provider<File> getSingleFile(String version)
    
    Returns the path to the terraform executable. Will force a download if not already downloaded.
    Returns:
    Provider to a specific version of the file. Will be empty if not supported on the current operating system.
  - protected abstract String getSingleFileName()
    
    Gets the name of the single file as it should be on local disk
    Returns:
    File name.
  - @Override protected void unpack(File singleFile, File destDir)
    
    Changes the behaviour to not unpack, but simply mark file as executable if the file pattern matches.
    Parameters:
    singleFile - Incoming file
    destDir - Destination directory to copy to if different from the parent of the incoming file.
    Since:
    5.5
  - @Override protected File verifyDistributionRoot(File distDir)
    
    Validates that the downloaded file is good.
    Parameters:
    distDir - Directory where the file was downloaded to.
    Returns:
    The directory where the real files now exists.
    Throws:
    DistributionFailedException if distribution failed to meet criteria.

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractSingleFileInstaller

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

AbstractSingleFileInstaller()

Method Detail

@Override Provider<File> getSingleFile(String version)

protected abstract String getSingleFileName()

@Override protected void unpack(File singleFile, File destDir)

@Override protected File verifyDistributionRoot(File distDir)