Package org.jenkinsci.plugins.genexus

Class GeneXusInstallation

java.lang.Object

hudson.model.AbstractDescribableImpl<ToolInstallation>

hudson.tools.ToolInstallation

org.jenkinsci.plugins.genexus.GeneXusInstallation

All Implemented Interfaces:

ExtensionPoint, Describable<ToolInstallation>, EnvironmentSpecific<GeneXusInstallation>, NodeSpecific<GeneXusInstallation>, Serializable

public final class GeneXusInstallation
extends ToolInstallation
implements NodeSpecific<GeneXusInstallation>, EnvironmentSpecific<GeneXusInstallation>

Author:

jlr

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeneXusInstallation.DescriptorImpl

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

ToolInstallation.ToolConverter

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT	Constant DEFAULT="Default"

Constructor Summary

Constructors

Constructor	Description
GeneXusInstallation(String name, String home, String msBuildInstallationId)
GeneXusInstallation(String name, String home, String msBuildInstallationId, List<? extends ToolProperty<?>> properties)

Method Summary

Modifier and Type	Method	Description
void	buildEnvVars(EnvVars env)
GeneXusInstallation	forEnvironment(EnvVars environment)
GeneXusInstallation	forNode(Node node, TaskListener log)
static GeneXusInstallation	getDefaultInstallation()	Returns the default installation.
String	getExecutable(Launcher launcher)
String	getExecutable(GeneXusExecutable executable, Launcher launcher)
String	getFilePath(String fileName, Launcher launcher)
static GeneXusInstallation[]	getInstallations()
String	getMsBuildInstallationId()
static void	onLoaded()
static GeneXusInstallation	resolveGeneXusInstallation(String installationId, Node builtOn, EnvVars env, TaskListener listener)	Resolves GeneXus installation by name.

Methods inherited from class hudson.tools.ToolInstallation

all, getHome, getName, getProperties, readResolve, toString, translate, translate, translateFor, writeReplace

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final transient String DEFAULT

Constant DEFAULT="Default"

See Also:

Constant Field Values

Constructor Detail

GeneXusInstallation

public GeneXusInstallation(String name,
                           String home,
                           String msBuildInstallationId)

GeneXusInstallation

@DataBoundConstructor
public GeneXusInstallation(String name,
                           String home,
                           String msBuildInstallationId,
                           List<? extends ToolProperty<?>> properties)

Parameters:

name - Installation name

home - Path to GeneXus Installation

msBuildInstallationId - MSBuild installation id to be used

properties - Tool properties

Method Detail

getMsBuildInstallationId

public String getMsBuildInstallationId()

buildEnvVars

public void buildEnvVars(EnvVars env)

Overrides:

buildEnvVars in class ToolInstallation

getDefaultInstallation

public static GeneXusInstallation getDefaultInstallation()

Returns the default installation.

Returns:

default installation

forNode

public GeneXusInstallation forNode(Node node,
                                   TaskListener log)
                            throws IOException,
                                   InterruptedException

Specified by:

forNode in interface NodeSpecific<GeneXusInstallation>

Throws:

IOException

InterruptedException

forEnvironment

public GeneXusInstallation forEnvironment(EnvVars environment)

Specified by:

forEnvironment in interface EnvironmentSpecific<GeneXusInstallation>

getExecutable

public String getExecutable(GeneXusExecutable executable,
                            Launcher launcher)
                     throws IOException,
                            InterruptedException

Throws:

IOException

InterruptedException

getFilePath

public String getFilePath(String fileName,
                          Launcher launcher)
                   throws IOException,
                          InterruptedException

Throws:

IOException

InterruptedException

getExecutable

public String getExecutable(Launcher launcher)
                     throws IOException,
                            InterruptedException

Throws:

IOException

InterruptedException

getInstallations

public static GeneXusInstallation[] getInstallations()

resolveGeneXusInstallation

@CheckForNull
public static GeneXusInstallation resolveGeneXusInstallation(@CheckForNull
                                                             String installationId,
                                                             @CheckForNull
                                                             Node builtOn,
                                                             @CheckForNull
                                                             EnvVars env,
                                                             @NonNull
                                                             TaskListener listener)

Resolves GeneXus installation by name.

Parameters:

installationId - installation Id. If null, default installation will be used (if exists)

builtOn - Node for which the installation should be resolved Can be Jenkins.getInstance() when running on controller

env - Additional environment variables

listener - Event listener

Returns:

GeneXus installation or null if it cannot be resolved

onLoaded

@Initializer(after=EXTENSIONS_AUGMENTED)
public static void onLoaded()