org.jenkinsci.plugins.docker.commons.tools

Class DockerTool

java.lang.Object

hudson.model.AbstractDescribableImpl<hudson.tools.ToolInstallation>

hudson.tools.ToolInstallation

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

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tools.ToolInstallation>, hudson.model.EnvironmentSpecific<DockerTool>, hudson.slaves.NodeSpecific<DockerTool>, Serializable

public class DockerTool
extends hudson.tools.ToolInstallation
implements hudson.model.EnvironmentSpecific<DockerTool>, hudson.slaves.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 and Description
static class	DockerTool.DescriptorImpl

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

hudson.tools.ToolInstallation.ToolConverter

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
DockerTool(String name, String home, List<? extends hudson.tools.ToolProperty<?>> properties)

Method Summary

Modifier and Type	Method and Description
void	buildEnvVars(hudson.EnvVars env)
DockerTool	forEnvironment(hudson.EnvVars environment)
DockerTool	forNode(hudson.model.Node node, hudson.model.TaskListener log)
static String	getExecutable(String name, hudson.model.Node node, hudson.model.TaskListener listener, hudson.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

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

DockerTool

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

Method Detail

getExecutable

@Nonnull
public static String getExecutable(@CheckForNull
                                             String name,
                                             @CheckForNull
                                             hudson.model.Node node,
                                             @Nullable
                                             hudson.model.TaskListener listener,
                                             @CheckForNull
                                             hudson.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 a slave) 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(hudson.EnvVars environment)

Specified by:

forEnvironment in interface hudson.model.EnvironmentSpecific<DockerTool>

forNode

public DockerTool forNode(hudson.model.Node node,
                          hudson.model.TaskListener log)
                   throws IOException,
                          InterruptedException

Specified by:

forNode in interface hudson.slaves.NodeSpecific<DockerTool>

Throws:

IOException

InterruptedException

buildEnvVars

public void buildEnvVars(hudson.EnvVars env)

Overrides:

buildEnvVars in class hudson.tools.ToolInstallation