- Direct Known Subclasses:
public abstract class DownloadFromUrlInstaller extends ToolInstallerPartial convenience implementation of
ToolInstallerthat just downloads an archive from the URL and extracts it.
Each instance of this is configured to download from a specific URL identified by an ID.
- Kohsuke Kawaguchi
Nested Class Summary
Nested Classes Modifier and Type Class Description
DownloadFromUrlInstaller.DescriptorImpl<T extends DownloadFromUrlInstaller>
DownloadFromUrlInstaller.InstallableDownloadable and installable tool.
DownloadFromUrlInstaller.InstallableListUsed for JSON databinding to parse the obtained list.
DownloadFromUrlInstaller.NodeSpecificInstallableConvenient abstract class to implement a NodeSpecificInstallable based on an existing Installable
Nested classes/interfaces inherited from class hudson.tools.ToolInstaller
All Methods Instance Methods Concrete Methods Modifier and Type Method Description
findPullUpDirectory(FilePath root)Often an archive contains an extra top-level directory that's unnecessary when extracted on the disk into the expected location.
isUpToDate(FilePath expectedLocation, DownloadFromUrlInstaller.Installable i)Checks if the specified expected location already contains the installed version of the tool.
performInstallation(ToolInstallation tool, Node node, TaskListener log)Ensure that the configured tool is really installed.
Methods inherited from class hudson.tools.ToolInstaller
appliesTo, getDescriptor, getLabel, preferredLocation, setTool
public final String id
protected DownloadFromUrlInstaller(String id)
protected boolean isUpToDate(FilePath expectedLocation, DownloadFromUrlInstaller.Installable i) throws IOException, InterruptedExceptionChecks if the specified expected location already contains the installed version of the tool. This check needs to run fairly efficiently. The current implementation uses the source URL of
DownloadFromUrlInstaller.Installable, based on the assumption that released bits do not change its content.
public DownloadFromUrlInstaller.Installable getInstallable() throws IOException
- null if no such ID is found.
public FilePath performInstallation(ToolInstallation tool, Node node, TaskListener log) throws IOException, InterruptedExceptionDescription copied from class:
ToolInstallerEnsure that the configured tool is really installed. If it is already installed, do nothing. Called only if
- Specified by:
tool- the tool being installed
node- the computer on which to install the tool
log- any status messages produced by the installation go here
- the (directory) path at which the tool can be found,
typically coming from
IOException- if installation fails
InterruptedException- if communication with a agent is interrupted
protected FilePath findPullUpDirectory(FilePath root) throws IOException, InterruptedExceptionOften an archive contains an extra top-level directory that's unnecessary when extracted on the disk into the expected location. If your installation sources provide that kind of archives, override this method to find the real root location.
The caller will "pull up" the discovered real root by throw away the intermediate directory, so that the user-configured "tool home" directory contains the right files.
The default implementation applies some heuristics to auto-determine if the pull up is necessary. This should work for typical archive files.
root- The directory that contains the extracted archive. This directory contains nothing but the extracted archive. For example, if the user installed jakarta-ant-1.1.zip , this directory would contain a single directory "jakarta-ant".
- Return the real top directory inside
rootthat contains the meat. In the above example,
root.child("jakarta-ant")should be returned. If there's no directory to pull up, return null.