com.nirima.jenkins.plugins.docker

Class DockerTemplateBase

java.lang.Object

com.nirima.jenkins.plugins.docker.DockerTemplateBase

All Implemented Interfaces:

hudson.model.Describable<DockerTemplateBase>

Direct Known Subclasses:

DockerSimpleTemplate

public class DockerTemplateBase
extends Object
implements hudson.model.Describable<DockerTemplateBase>

Base for docker templates - does not include Jenkins items like labels.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockerTemplateBase.DescriptorImpl

Field Summary

Fields

Modifier and Type	Field and Description
boolean	bindAllPorts
String	bindPorts
Integer	cpuShares
String[]	dnsHosts
String	dockerCommand Field dockerCommand
String[]	environment
String	hostname
String	lxcConfString Field lxcConfString
Integer	memoryLimit
Integer	memorySwap
String	network
boolean	privileged
boolean	tty
String[]	volumes Every String is volume specification
String	volumesFrom Deprecated. use volumesFrom2
String[]	volumesFrom2 Every String is volumeFrom specification

Constructor Summary

Constructors

Constructor and Description

DockerTemplateBase(String image, org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint registry, String dnsString, String network, String dockerCommand, String volumesString, String volumesFromString, String environmentsString, String lxcConfString, String hostname, Integer memoryLimit, Integer memorySwap, Integer cpuShares, String bindPorts, boolean bindAllPorts, boolean privileged, boolean tty, String macAddress)

Method Summary

Modifier and Type	Method and Description
com.github.dockerjava.api.command.CreateContainerCmd	fillContainerConfig(com.github.dockerjava.api.command.CreateContainerCmd containerConfig)
static String[]	filterStringArray(String[] arr)
Integer	getCpuShares()
hudson.model.Descriptor<DockerTemplateBase>	getDescriptor()
String	getDisplayName()
String	getDnsString()
String[]	getDockerCommandArray()
String	getEnvironmentsString()
List<String>	getExtraHosts()
String	getExtraHostsString()
String	getImage()
List<com.github.dockerjava.api.model.LxcConf>	getLxcConf()
String	getMacAddress()
Integer	getMemoryLimit()
Integer	getMemorySwap()
Iterable<com.github.dockerjava.api.model.PortBinding>	getPortMappings()
org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint	getRegistry()
String[]	getVolumes()
String	getVolumesFrom() Deprecated. use getVolumesFrom2()
String[]	getVolumesFrom2()
String	getVolumesFromString()
String	getVolumesString()
protected Object	readResolve()
void	setExtraHosts(List<String> extraHosts)
void	setExtraHostsString(String extraHostsString)
void	setImage(String image)
void	setMacAddress(String macAddress)
void	setVolumes(String[] volumes)
void	setVolumesFrom2(String[] volumes)
void	setVolumesFromString(String volumesFromString)
static String[]	splitAndFilterEmpty(String s, String separator)
static List<String>	splitAndFilterEmptyList(String s, String separator)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

dockerCommand

public final String dockerCommand

Field dockerCommand

lxcConfString

public final String lxcConfString

Field lxcConfString

hostname

public final String hostname

dnsHosts

public final String[] dnsHosts

network

public final String network

volumes

public String[] volumes

Every String is volume specification

volumesFrom

@Deprecated
public String volumesFrom

Deprecated. use volumesFrom2

volumesFrom2

public String[] volumesFrom2

Every String is volumeFrom specification

environment

@CheckForNull
public final String[] environment

bindPorts

public final String bindPorts

bindAllPorts

public final boolean bindAllPorts

memoryLimit

public final Integer memoryLimit

memorySwap

public final Integer memorySwap

cpuShares

public final Integer cpuShares

privileged

public final boolean privileged

tty

public final boolean tty

Constructor Detail

DockerTemplateBase

@DataBoundConstructor
public DockerTemplateBase(String image,
                                                org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint registry,
                                                String dnsString,
                                                String network,
                                                String dockerCommand,
                                                String volumesString,
                                                String volumesFromString,
                                                String environmentsString,
                                                String lxcConfString,
                                                String hostname,
                                                Integer memoryLimit,
                                                Integer memorySwap,
                                                Integer cpuShares,
                                                String bindPorts,
                                                boolean bindAllPorts,
                                                boolean privileged,
                                                boolean tty,
                                                String macAddress)

Method Detail

readResolve

protected Object readResolve()

splitAndFilterEmpty

public static String[] splitAndFilterEmpty(String s,
                                           String separator)

splitAndFilterEmptyList

public static List<String> splitAndFilterEmptyList(String s,
                                                   String separator)

filterStringArray

public static String[] filterStringArray(String[] arr)

setImage

public void setImage(String image)

getImage

public String getImage()

getRegistry

public org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint getRegistry()

getDnsString

public String getDnsString()

getVolumes

@CheckForNull
public String[] getVolumes()

setVolumes

public void setVolumes(String[] volumes)

getVolumesString

public String getVolumesString()

getVolumesFrom

@Deprecated
public String getVolumesFrom()

Deprecated. use getVolumesFrom2()

getVolumesFrom2

public String[] getVolumesFrom2()

setVolumesFrom2

public void setVolumesFrom2(String[] volumes)

setVolumesFromString

public void setVolumesFromString(String volumesFromString)

getVolumesFromString

public String getVolumesFromString()

getMacAddress

@CheckForNull
public String getMacAddress()

setMacAddress

public void setMacAddress(String macAddress)

getDisplayName

public String getDisplayName()

getMemoryLimit

public Integer getMemoryLimit()

getMemorySwap

public Integer getMemorySwap()

getCpuShares

public Integer getCpuShares()

getDockerCommandArray

public String[] getDockerCommandArray()

getPortMappings

public Iterable<com.github.dockerjava.api.model.PortBinding> getPortMappings()

getLxcConf

public List<com.github.dockerjava.api.model.LxcConf> getLxcConf()

getEnvironmentsString

public String getEnvironmentsString()

getExtraHosts

@CheckForNull
public List<String> getExtraHosts()

setExtraHosts

public void setExtraHosts(List<String> extraHosts)

setExtraHostsString

@DataBoundSetter
public void setExtraHostsString(String extraHostsString)

getExtraHostsString

public String getExtraHostsString()

fillContainerConfig

public com.github.dockerjava.api.command.CreateContainerCmd fillContainerConfig(com.github.dockerjava.api.command.CreateContainerCmd containerConfig)

toString

public String toString()

Overrides:

toString in class Object

getDescriptor

public hudson.model.Descriptor<DockerTemplateBase> getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<DockerTemplateBase>