Package com.ultikits.ultitools.utils

Class PluginInstallUtils.StagingCatalogue

java.lang.Object

com.ultikits.ultitools.utils.PluginInstallUtils.StagingCatalogue

All Implemented Interfaces:

ModuleFileTransactions.Catalogue, ModuleFileTransactions.Downloader

Enclosing class:

PluginInstallUtils

static final class PluginInstallUtils.StagingCatalogue
extends Object
implements ModuleFileTransactions.Catalogue, ModuleFileTransactions.Downloader

The catalogue and downloader of one staging call (plan 22-26 fix round).

The catalogue contract makes a download.url an opaque address: it must not be built or parsed, and its shape may change inside a contract version. So the download is verified against the version this staging has just read through the contract's version route (the module's identifier and the version, CatalogueClient.version(String, String)), which is also where its link came from, and never against a route derived from the URL. A link this staging did not just obtain from the catalogue is not downloaded.

One instance serves one call of ModuleFileTransactions.stageUpdate(java.lang.String, java.util.List<com.ultikits.ultitools.abstracts.UltiToolsPlugin>, java.util.function.Function<com.ultikits.ultitools.abstracts.UltiToolsPlugin, java.io.File>, com.ultikits.ultitools.utils.ModuleFileTransactions.Catalogue, com.ultikits.ultitools.utils.ModuleFileTransactions.Downloader), which asks for the link and then downloads it on the same thread; it is not shared.

Field Summary

Fields

Modifier and Type	Field	Description
private CatalogueClient.Version	resolved
private String	resolvedLink

Constructor Summary

Constructors

Constructor	Description
StagingCatalogue()

Method Summary

Modifier and Type	Method	Description
void	download(String link, String fileName, File folder)	Downloads a file.
String	downloadLink(String identifyString, String version)	The download link of one version of a module.
String	latestVersion(String identifyString)	The latest version of a module.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

resolved

private volatile CatalogueClient.Version resolved

resolvedLink

private volatile String resolvedLink

Constructor Details

StagingCatalogue

StagingCatalogue()

Method Details

latestVersion

public String latestVersion(String identifyString)

Description copied from interface: ModuleFileTransactions.Catalogue

The latest version of a module.

Specified by:

latestVersion in interface ModuleFileTransactions.Catalogue

Parameters:

identifyString - the module's identify-string

Returns:

the version, or null when there is none

downloadLink

public String downloadLink(String identifyString,
 String version)

Description copied from interface: ModuleFileTransactions.Catalogue

The download link of one version of a module.

Specified by:

downloadLink in interface ModuleFileTransactions.Catalogue

Parameters:

identifyString - the module's identify-string

version - the version

Returns:

the link, or null when there is none

download

public void download(String link,
 String fileName,
 File folder)
              throws IOException

Description copied from interface: ModuleFileTransactions.Downloader

Downloads a file.

Specified by:

download in interface ModuleFileTransactions.Downloader

Parameters:

link - the link

fileName - the file name to write

folder - the folder to write it into

Throws:

IOException - when the download fails