io.jenkins.plugins.extratoolinstallers.installers

Class AuthenticatedZipExtractionInstaller

java.lang.Object

hudson.tools.ToolInstaller

io.jenkins.plugins.extratoolinstallers.installers.AuthenticatedZipExtractionInstaller

All Implemented Interfaces:

ExtensionPoint, Describable<ToolInstaller>

public class AuthenticatedZipExtractionInstaller
extends ToolInstaller

A ToolInstaller that downloads a zip or tar.gz and unpacks it in order to install a tool. If the tool is already present, it will only be re-downloaded/re-unpacked if the URL is newer than the existing content. The download supports HTTP basic authentication.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthenticatedZipExtractionInstaller.DescriptorImpl Descriptor for the AuthenticatedZipExtractionInstaller.

Nested classes/interfaces inherited from class hudson.tools.ToolInstaller

ToolInstaller.ToolInstallerEntry, ToolInstaller.ToolInstallerList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.tools.ToolInstaller

tool

Constructor Summary

Constructors

Constructor and Description
AuthenticatedZipExtractionInstaller(String label) Constructor that sets mandatory fields.

Method Summary

Modifier and Type	Method and Description
protected Date	downloadOnFromMaster(org.apache.commons.httpclient.URI uri, Long timestampOfLocalContents, String usernameOrNull, String passwordOrNull, FilePath dir, TaskListener logOrNull, String nodeName)
protected Date	downloadOnRemoteNode(org.apache.commons.httpclient.URI uri, Long timestampOfLocalContents, String usernameOrNull, String passwordOrNull, FilePath dir, TaskListener logOrNull, String nodeName)
String	getCredentialsId() ID of the credentials to use when doing the download.
String	getSubdir() Subdirectory within the zip/tar.gz where the tool's binaries are located.
String	getUrl() URL of a zip/tar.gz file which should be downloaded and unpacked if the tool is missing or out of date.
protected com.cloudbees.plugins.credentials.common.StandardCredentials	lookupConfiguredCredentials(String urlHostOrNullOrEmpty)
FilePath	performInstallation(ToolInstallation tool, Node node, TaskListener log)
void	setCredentialsId(String credentialsId) Sets getCredentialsId().
void	setSubdir(String subdir) Sets getSubdir().
void	setUrl(String url) Sets getUrl().

Methods inherited from class hudson.tools.ToolInstaller

appliesTo, getDescriptor, getLabel, preferredLocation, setTool

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticatedZipExtractionInstaller

@DataBoundConstructor
public AuthenticatedZipExtractionInstaller(String label)

Constructor that sets mandatory fields.

Parameters:

label - The ToolInstaller.getLabel().

Method Detail

getUrl

@CheckForNull
public String getUrl()

URL of a zip/tar.gz file which should be downloaded and unpacked if the tool is missing or out of date.

Returns:

URL, or null if none has been set.

setUrl

@DataBoundSetter
public void setUrl(@Nullable
                                    String url)

Sets getUrl().

Parameters:

url - New value.

getCredentialsId

@CheckForNull
public String getCredentialsId()

ID of the credentials to use when doing the download.

Returns:

The credentials ID, or null if none has been set.

setCredentialsId

@DataBoundSetter
public void setCredentialsId(@Nullable
                                              String credentialsId)

Sets getCredentialsId().

Parameters:

credentialsId - New value.

getSubdir

@CheckForNull
public String getSubdir()

Subdirectory within the zip/tar.gz where the tool's binaries are located. It is this folder that's added to the path (etc). Can be null/empty if the binaries are at the base of the zip/tar.gz.

Returns:

The subdirectory, or null if no subdirectory has been set.

setSubdir

@DataBoundSetter
public void setSubdir(@Nullable
                                       String subdir)

Sets getSubdir().

Parameters:

subdir - New value.

performInstallation

public FilePath performInstallation(@Nonnull
                                    ToolInstallation tool,
                                    @Nonnull
                                    Node node,
                                    @CheckForNull
                                    TaskListener log)
                             throws IOException,
                                    InterruptedException

Specified by:

performInstallation in class ToolInstaller

Throws:

IOException

InterruptedException

lookupConfiguredCredentials

protected com.cloudbees.plugins.credentials.common.StandardCredentials lookupConfiguredCredentials(@CheckForNull
                                                                                                   String urlHostOrNullOrEmpty)
                                                                                            throws ExtraToolInstallersException

Throws:

ExtraToolInstallersException

downloadOnFromMaster

protected Date downloadOnFromMaster(@Nonnull
                                    org.apache.commons.httpclient.URI uri,
                                    @CheckForNull
                                    Long timestampOfLocalContents,
                                    @CheckForNull
                                    String usernameOrNull,
                                    @CheckForNull
                                    String passwordOrNull,
                                    @Nonnull
                                    FilePath dir,
                                    @CheckForNull
                                    TaskListener logOrNull,
                                    @Nonnull
                                    String nodeName)
                             throws IOException,
                                    InterruptedException

Throws:

IOException

InterruptedException

downloadOnRemoteNode

protected Date downloadOnRemoteNode(@Nonnull
                                    org.apache.commons.httpclient.URI uri,
                                    @CheckForNull
                                    Long timestampOfLocalContents,
                                    @CheckForNull
                                    String usernameOrNull,
                                    @CheckForNull
                                    String passwordOrNull,
                                    @Nonnull
                                    FilePath dir,
                                    @CheckForNull
                                    TaskListener logOrNull,
                                    @Nonnull
                                    String nodeName)
                             throws IOException,
                                    InterruptedException

Throws:

IOException

InterruptedException