com.cloudbees.jenkins.plugins.customtools

Class CustomToolInstallWrapper

java.lang.Object

hudson.model.AbstractDescribableImpl<hudson.tasks.BuildWrapper>

hudson.tasks.BuildWrapper

com.cloudbees.jenkins.plugins.customtools.CustomToolInstallWrapper

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.BuildWrapper>

public class CustomToolInstallWrapper
extends hudson.tasks.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

hudson.tasks.BuildWrapper.Environment

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.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

Methods

Modifier and Type	Method and Description
void	CheckVersions(CustomTool tool, hudson.model.BuildListener listener, hudson.EnvVars buildEnv, hudson.model.Node node, hudson.EnvVars target) Check versions and modify build environment if required.
hudson.Launcher	decorateLauncher(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener) The heart of the beast.
hudson.model.Descriptor<hudson.tasks.BuildWrapper>	getDescriptor()
MulticonfigWrapperOptions	getMulticonfigOptions() Gets multi-configuration job parameters.
CustomToolInstallWrapper.SelectedTool[]	getSelectedTools()
boolean	hasMulticonfigOptions() Check if build has specific multi-configuration options
boolean	isConvertHomesToUppercase()
hudson.tasks.BuildWrapper.Environment	setUp(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.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 hudson.tasks.BuildWrapper.Environment setUp(hudson.model.AbstractBuild build,
                                          hudson.Launcher launcher,
                                          hudson.model.BuildListener listener)
                                            throws IOException,
                                                   InterruptedException

Overrides:

setUp in class hudson.tasks.BuildWrapper

Throws:

IOException

InterruptedException

getSelectedTools

public CustomToolInstallWrapper.SelectedTool[] getSelectedTools()

decorateLauncher

public hudson.Launcher decorateLauncher(hudson.model.AbstractBuild build,
                               hudson.Launcher launcher,
                               hudson.model.BuildListener listener)
                                 throws IOException,
                                        InterruptedException,
                                        hudson.model.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 hudson.tasks.BuildWrapper

Throws:

IOException

InterruptedException

hudson.model.Run.RunnerAbortedException

CheckVersions

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

Check 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 hudson.model.Descriptor<hudson.tasks.BuildWrapper> getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.BuildWrapper>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<hudson.tasks.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

public MulticonfigWrapperOptions getMulticonfigOptions()

Gets multi-configuration job parameters.

Returns:

Since:

0.3