org.jenkinsci.test.acceptance.docker

Class DockerImage

java.lang.Object

org.jenkinsci.test.acceptance.docker.DockerImage

public class DockerImage
extends Object

Container image, a template to launch virtual machines from.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockerImage.Starter<T extends DockerContainer>

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DOCKER_HOST
String	tag

Constructor Summary

Constructors

Constructor and Description
DockerImage(String tag)

Method Summary

Modifier and Type	Method and Description
static String	getDockerHost() Get the string representation of the docker host as set by DOCKER_HOST environment variable or the localhost address if it is not set (or is a socket).
<T extends DockerContainer> DockerImage.Starter<T>	start(Class<T> type) Start container from this image.
<T extends DockerContainer> T	start(Class<T> type, org.jenkinsci.utils.process.CommandBuilder options, org.jenkinsci.utils.process.CommandBuilder cmd) Deprecated. Use DockerImage.Starter instead.
<T extends DockerContainer> T	start(Class<T> type, org.jenkinsci.utils.process.CommandBuilder options, org.jenkinsci.utils.process.CommandBuilder cmd, int portOffset) Deprecated. Use DockerImage.Starter instead.
<T extends DockerContainer> T	start(Class<T> type, int[] ports, org.jenkinsci.utils.process.CommandBuilder options, org.jenkinsci.utils.process.CommandBuilder cmd) Deprecated. Use DockerImage.Starter instead.
<T extends DockerContainer> T	start(Class<T> type, int[] ports, int localPortOffset, String ipAddress, org.jenkinsci.utils.process.CommandBuilder options, org.jenkinsci.utils.process.CommandBuilder cmd) Deprecated. Use DockerImage.Starter instead.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DOCKER_HOST

public static final String DEFAULT_DOCKER_HOST

See Also:

Constant Field Values

tag

public final String tag

Constructor Detail

DockerImage

public DockerImage(String tag)

Method Detail

start

public <T extends DockerContainer> DockerImage.Starter<T> start(Class<T> type)

Start container from this image.

start

@Deprecated
public <T extends DockerContainer> T start(Class<T> type,
                                                       org.jenkinsci.utils.process.CommandBuilder options,
                                                       org.jenkinsci.utils.process.CommandBuilder cmd,
                                                       int portOffset)
                                                throws InterruptedException,
                                                       IOException

Deprecated. Use DockerImage.Starter instead.

Throws:

InterruptedException

IOException

start

@Deprecated
public <T extends DockerContainer> T start(Class<T> type,
                                                       org.jenkinsci.utils.process.CommandBuilder options,
                                                       org.jenkinsci.utils.process.CommandBuilder cmd)
                                                throws InterruptedException,
                                                       IOException

Deprecated. Use DockerImage.Starter instead.

Throws:

InterruptedException

IOException

start

@Deprecated
public <T extends DockerContainer> T start(Class<T> type,
                                                       int[] ports,
                                                       org.jenkinsci.utils.process.CommandBuilder options,
                                                       org.jenkinsci.utils.process.CommandBuilder cmd)
                                                throws InterruptedException,
                                                       IOException

Deprecated. Use DockerImage.Starter instead.

Throws:

InterruptedException

IOException

start

@Deprecated
public <T extends DockerContainer> T start(Class<T> type,
                                                       int[] ports,
                                                       int localPortOffset,
                                                       String ipAddress,
                                                       org.jenkinsci.utils.process.CommandBuilder options,
                                                       org.jenkinsci.utils.process.CommandBuilder cmd)
                                                throws InterruptedException,
                                                       IOException

Deprecated. Use DockerImage.Starter instead.

Throws:

InterruptedException

IOException

getDockerHost

public static String getDockerHost()

Get the string representation of the docker host as set by DOCKER_HOST environment variable or the localhost address if it is not set (or is a socket).

Returns:

an IP Address or hostname of the docker host

toString

public String toString()

Overrides:

toString in class Object