Package org.jenkinsci.plugins.docker.commons.tools

Class DockerTool

java.lang.Object

hudson.tools.ToolInstallation

org.jenkinsci.plugins.docker.commons.tools.DockerTool

All Implemented Interfaces:

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

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

An installation of Docker. If nonempty, expected to have an executable file bin/docker. Use <d:selectDockerTool field="toolName" xmlns:d="/lib/docker/commons/"/> to customize.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DockerTool.DescriptorImpl

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
DockerTool(String name, String home, List<? extends ToolProperty<?>> properties)

Method Summary

Modifier and Type	Method	Description
void	buildEnvVars(EnvVars env)
DockerTool	forEnvironment(EnvVars environment)
DockerTool	forNode(Node node, TaskListener log)
static String	getExecutable(String name, Node node, TaskListener listener, EnvVars env)	Gets the executable name to use for a given launcher.

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

Constructor Details

DockerTool

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

Method Details

getExecutable

@NonNull
public static String getExecutable(@CheckForNull
 String name,
 @CheckForNull
 Node node,
 @Nullable
 TaskListener listener,
 @CheckForNull
 EnvVars env)
                            throws IOException,
InterruptedException

Gets the executable name to use for a given launcher. Suitable for the first item in ArgumentListBuilder.

Parameters:

name - the name of the selected tool, or null for the default

node - optionally, a node (such as an agent) on which we are running Docker

listener - a listener, required in case node is not null

env - optionally, environment variables to use when expanding the home directory

Returns:

docker or an absolute path

Throws:

IOException

InterruptedException

forEnvironment

public DockerTool forEnvironment(EnvVars environment)

Specified by:

forEnvironment in interface EnvironmentSpecific<DockerTool>

forNode

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

Specified by:

forNode in interface NodeSpecific<DockerTool>

Throws:

IOException

InterruptedException

buildEnvVars

public void buildEnvVars(EnvVars env)

Overrides:

buildEnvVars in class ToolInstallation