com.synopsys.arc.jenkinsci.plugins.extratoolinstallers.installers

Class AbstractExtraToolInstaller

java.lang.Object

hudson.tools.ToolInstaller

com.synopsys.arc.jenkinsci.plugins.extratoolinstallers.installers.AbstractExtraToolInstaller

All Implemented Interfaces:

ExtensionPoint, Describable<ToolInstaller>

Direct Known Subclasses:

BatchCommandInstaller, SharedDirectoryInstaller, StubInstaller

public abstract class AbstractExtraToolInstaller
extends ToolInstaller

Abstract class, which encapsulates common methods for installers.

Since:

0.2.1

Author:

Oleg Nenashev

Nested Class Summary

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
AbstractExtraToolInstaller(String label, String toolHome, boolean failOnSubstitution) Constructor that sets all fields.

Method Summary

Modifier and Type	Method and Description
String	getToolHome()
boolean	isFailOnSubstitution()
protected String	substituteNodeVariablesValidated(String stringName, String macroString, Node node) Substitute variables and fail on errors.

Methods inherited from class hudson.tools.ToolInstaller

appliesTo, getDescriptor, getLabel, performInstallation, preferredLocation, setTool

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExtraToolInstaller

public AbstractExtraToolInstaller(String label,
                                  String toolHome,
                                  boolean failOnSubstitution)

Constructor that sets all fields.

Parameters:

label - The ToolInstaller.getLabel().

toolHome - Our getToolHome().

failOnSubstitution - Our isFailOnSubstitution().

Method Detail

isFailOnSubstitution

public final boolean isFailOnSubstitution()

getToolHome

public final String getToolHome()

substituteNodeVariablesValidated

protected String substituteNodeVariablesValidated(String stringName,
                                                  String macroString,
                                                  Node node)
                                           throws ExtraToolInstallersException

Substitute variables and fail on errors.

Parameters:

stringName - Name of the field

macroString - String to be checked

node - Node, where tool is being installed

Returns:

Substituted string

Throws:

ExtraToolInstallersException - Substitution error