com.cloudbees.jenkins.plugins.customtools

Class CustomToolInstallWrapper

java.lang.Object

hudson.model.AbstractDescribableImpl<BuildWrapper>

hudson.tasks.BuildWrapper

com.cloudbees.jenkins.plugins.customtools.CustomToolInstallWrapper

All Implemented Interfaces:

ExtensionPoint, Describable<BuildWrapper>

public class CustomToolInstallWrapper
extends BuildWrapper

Installs tools selected by the user. Exports configured paths and a home variable for each tool.

Author:

rcampbell, Oleg Nenashev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomToolInstallWrapper.DescriptorImpl
static class	CustomToolInstallWrapper.SelectedTool Ceremony needed to satisfy NoStaplerConstructionException: "There's no @DataBoundConstructor on any constructor of class java.lang.String"

Nested classes/interfaces inherited from class hudson.tasks.BuildWrapper

BuildWrapper.Environment

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static CustomToolInstallWrapper.DescriptorImpl	DESCRIPTOR

Constructor Summary

Constructors

Constructor and Description
CustomToolInstallWrapper(CustomToolInstallWrapper.SelectedTool[] selectedTools, MulticonfigWrapperOptions multiconfigOptions, boolean convertHomesToUppercase)

Method Summary

Modifier and Type	Method and Description
void	checkVersions(CustomTool tool, BuildListener listener, EnvVars buildEnv, Node node, EnvVars target) Checks versions and modify build environment if required.
void	CheckVersions(CustomTool tool, BuildListener listener, EnvVars buildEnv, Node node, EnvVars target) Deprecated. The method is deprecated. It will be removed in future versions.
Launcher	decorateLauncher(AbstractBuild build, Launcher launcher, BuildListener listener) The heart of the beast.
Descriptor<BuildWrapper>	getDescriptor()
MulticonfigWrapperOptions	getMulticonfigOptions() Gets multi-configuration job parameters.
CustomToolInstallWrapper.SelectedTool[]	getSelectedTools()
boolean	hasMulticonfigOptions() Check if build has specific multi-configuration options
boolean	isConvertHomesToUppercase()
BuildWrapper.Environment	setUp(AbstractBuild build, Launcher launcher, BuildListener listener)

Methods inherited from class hudson.tasks.BuildWrapper

all, decorateLogger, getProjectAction, getProjectActions, makeBuildVariables, makeSensitiveBuildVariables, preCheckout, setUp

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTOR

@Extension
public static final CustomToolInstallWrapper.DescriptorImpl DESCRIPTOR

Constructor Detail

CustomToolInstallWrapper

@DataBoundConstructor
public CustomToolInstallWrapper(CustomToolInstallWrapper.SelectedTool[] selectedTools,
                                                       MulticonfigWrapperOptions multiconfigOptions,
                                                       boolean convertHomesToUppercase)

Method Detail

isConvertHomesToUppercase

public boolean isConvertHomesToUppercase()

setUp

public BuildWrapper.Environment setUp(AbstractBuild build,
                                      Launcher launcher,
                                      BuildListener listener)
                               throws IOException,
                                      InterruptedException

Overrides:

setUp in class BuildWrapper

Throws:

IOException

InterruptedException

getSelectedTools

@Nonnull
public CustomToolInstallWrapper.SelectedTool[] getSelectedTools()

decorateLauncher

public Launcher decorateLauncher(AbstractBuild build,
                                 Launcher launcher,
                                 BuildListener listener)
                          throws IOException,
                                 InterruptedException,
                                 Run.RunnerAbortedException

The heart of the beast. Installs selected tools and exports their paths to the PATH and their HOMEs as environment variables.

Overrides:

decorateLauncher in class BuildWrapper

Returns:

A decorated launcher

Throws:

IOException

InterruptedException

Run.RunnerAbortedException

CheckVersions

public void CheckVersions(CustomTool tool,
                          BuildListener listener,
                          EnvVars buildEnv,
                          Node node,
                          EnvVars target)
                   throws CustomToolException

Deprecated. The method is deprecated. It will be removed in future versions.

Throws:

CustomToolException

checkVersions

public void checkVersions(@Nonnull
                          CustomTool tool,
                          @Nonnull
                          BuildListener listener,
                          @Nonnull
                          EnvVars buildEnv,
                          @Nonnull
                          Node node,
                          @Nonnull
                          EnvVars target)
                   throws CustomToolException

Checks versions and modify build environment if required.

Parameters:

tool - Custom Tool

listener - Build Listener

buildEnv - Build Environment (can be modified)

node - Target Node

target - Build Internal Environment (can be modified)

Throws:

CustomToolException

Since:

0.4

getDescriptor

public Descriptor<BuildWrapper> getDescriptor()

Specified by:

getDescriptor in interface Describable<BuildWrapper>

Overrides:

getDescriptor in class AbstractDescribableImpl<BuildWrapper>

hasMulticonfigOptions

public boolean hasMulticonfigOptions()

Check if build has specific multi-configuration options

Returns:

True if multi-configuration options are configured

Since:

0.3

getMulticonfigOptions

@Nonnull
public MulticonfigWrapperOptions getMulticonfigOptions()

Gets multi-configuration job parameters.

Returns:

Configured options. Returns default options if not specified.

Since:

0.3