Package io.jenkins.plugins.har.cli

Class HarnessCliInstallation

java.lang.Object

hudson.tools.ToolInstallation

io.jenkins.plugins.har.cli.HarnessCliInstallation

All Implemented Interfaces:

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

public class HarnessCliInstallation
extends ToolInstallation
implements NodeSpecific<HarnessCliInstallation>, EnvironmentSpecific<HarnessCliInstallation>

Represents a Harness CLI (hc) tool installation in Jenkins.

Admins configure this under Manage Jenkins → Tools → Harness CLI installations. The installation directory is exposed as the "HARNESS_CLI_PATH" environment variable so that HcStep can locate the binary at runtime.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HarnessCliInstallation.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 final String	HARNESS_CLI_PATH	Environment variable set to the directory that contains the hc binary.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	buildEnvVars(EnvVars env)
HarnessCliInstallation	forEnvironment(EnvVars environment)
HarnessCliInstallation	forNode(Node node, TaskListener log)

Methods inherited from class hudson.tools.ToolInstallation

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Describable

getDescriptor

Field Details

HARNESS_CLI_PATH

public static final String HARNESS_CLI_PATH

Environment variable set to the directory that contains the hc binary.

See Also:

• Constant Field Values

Constructor Details

HarnessCliInstallation

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

Method Details

forEnvironment

public HarnessCliInstallation forEnvironment(EnvVars environment)

Specified by:

forEnvironment in interface EnvironmentSpecific<HarnessCliInstallation>

forNode

public HarnessCliInstallation forNode(@NonNull
 Node node,
 TaskListener log)
                               throws IOException,
InterruptedException

Specified by:

forNode in interface NodeSpecific<HarnessCliInstallation>

Throws:

IOException

InterruptedException

buildEnvVars

public void buildEnvVars(EnvVars env)

Overrides:

buildEnvVars in class ToolInstallation