Package de.tracetronic.jenkins.plugins.ecutest.tool.installation

Class ETInstallation

java.lang.Object

hudson.model.AbstractDescribableImpl<ToolInstallation>

hudson.tools.ToolInstallation

de.tracetronic.jenkins.plugins.ecutest.tool.installation.AbstractToolInstallation

de.tracetronic.jenkins.plugins.ecutest.tool.installation.ETInstallation

All Implemented Interfaces:

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

public class ETInstallation
extends AbstractToolInstallation

Represents a ecu.test installation specified by name and home directory.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ETInstallation.DescriptorImpl	DescriptorImpl of ETInstallation.

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

ToolInstallation.ToolConverter

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ETInstallation(ETInstallation source, String home, List<? extends ToolProperty<?>> properties)	Instantiates a new ETInstallation.
ETInstallation(String name, String home, List<? extends ToolProperty<?>> properties)	Instantiates a new ETInstallation.

Method Summary

Modifier and Type	Method	Description
ETInstallation	forEnvironment(EnvVars env)
ETInstallation	forNode(Node node, TaskListener log)
static ETInstallation	get(String name)	Gets the ecu.test installation by name.
String	getComExecutable(Launcher launcher)	Gets the ecu.test COM server executable path on the given target system.
String	getExecutable(Launcher launcher)	Gets the ecu.test executable path on the given target system.
String	getProgId()	Gets the programmatic identifier from tool properties.
int	getTimeout()	Gets the COM timeout from tool properties.
String	getTSExecutable(Launcher launcher)	Gets the executable path of the Tool-Server on the given target system.
static ETInstallation[]	installs()	Gets all ecu.test installations.
boolean	isRegisterComServer()	Returns whether to register the COM server before each start of ecu.test.

Methods inherited from class hudson.tools.ToolInstallation

all, buildEnvVars, 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

Constructor Detail

ETInstallation

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

Instantiates a new ETInstallation.

Parameters:

name - the name of the ecu.test installation

home - the home directory of the ecu.test installation

properties - the ecu.test properties

ETInstallation

public ETInstallation(ETInstallation source,
                      String home,
                      List<? extends ToolProperty<?>> properties)

Instantiates a new ETInstallation.

Parameters:

source - the source to install the ecu.test installation

home - the home directory of the ecu.test installation

properties - the ecu.test properties

Method Detail

forEnvironment

public ETInstallation forEnvironment(EnvVars env)

forNode

public ETInstallation forNode(@Nonnull
                              Node node,
                              TaskListener log)
                       throws IOException,
                              InterruptedException

Throws:

IOException

InterruptedException

getExecutable

public String getExecutable(Launcher launcher)
                     throws IOException,
                            InterruptedException

Gets the ecu.test executable path on the given target system.

Specified by:

getExecutable in class AbstractToolInstallation

Parameters:

launcher - the launcher

Returns:

the ecu.test executable

Throws:

IOException - signals that an I/O exception has occurred

InterruptedException - if the current thread is interrupted while waiting for the completion

getComExecutable

public String getComExecutable(Launcher launcher)
                        throws IOException,
                               InterruptedException

Gets the ecu.test COM server executable path on the given target system.

Parameters:

launcher - the launcher

Returns:

the ecu.test COM server executable

Throws:

IOException - signals that an I/O exception has occurred

InterruptedException - if the current thread is interrupted while waiting for the completion

getTSExecutable

public String getTSExecutable(Launcher launcher)
                       throws IOException,
                              InterruptedException

Gets the executable path of the Tool-Server on the given target system. According to ecu.test 6.5 and above the Tool-Server executable is directly located in ecu.test installation path, otherwise in sub directory 'ToolServer'.

Parameters:

launcher - the launcher

Returns:

the Tool-Server executable path

Throws:

IOException - signals that an I/O exception has occurred

InterruptedException - if the current thread is interrupted while waiting for the completion

getProgId

public String getProgId()

Gets the programmatic identifier from tool properties.

Returns:

the progId, default progId if tool property does not exist

getTimeout

public int getTimeout()

Gets the COM timeout from tool properties.

Returns:

the COM timeout, default timeout if tool property does not exist

isRegisterComServer

public boolean isRegisterComServer()

Returns whether to register the COM server before each start of ecu.test.

Returns:

true if option enabled, false otherwise

installs

public static ETInstallation[] installs()

Gets all ecu.test installations.

Returns:

all available installations, never null

get

@CheckForNull
public static ETInstallation get(String name)

Gets the ecu.test installation by name.

Parameters:

name - the name

Returns:

installation by name, null if not found