java.lang.Object
- com.nirima.jenkins.plugins.docker.DockerTemplate

All Implemented Interfaces:: Describable<DockerTemplate>

public class DockerTemplate
extends Object
implements Describable<DockerTemplate>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DockerTemplate.DescriptorImpl

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DEFAULT_STOP_TIMEOUT`	The default timeout in seconds (10s) to wait during container shutdown until it will be forcefully terminated.
`int`	`instanceCap`
`String`	`remoteFs`

Constructor Summary

Constructors
Constructor	Description
`DockerTemplate()`	Deprecated. This gives an empty image name, which isn't valid.
`DockerTemplate(DockerTemplateBase dockerTemplateBase, DockerComputerConnector connector, String labelString, String instanceCapStr)`
`DockerTemplate(DockerTemplateBase dockerTemplateBase, DockerComputerConnector connector, String labelString, String remoteFs, String instanceCapStr)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`DockerTemplate`	`cloneWithLabel(String label)`
`boolean`	`equals(Object obj)`
`com.github.dockerjava.api.command.CreateContainerCmd`	`fillContainerConfig(com.github.dockerjava.api.command.CreateContainerCmd containerConfig)`
`List<String>`	`getCapabilitiesToAdd()`
`String`	`getCapabilitiesToAddString()`
`List<String>`	`getCapabilitiesToDrop()`
`String`	`getCapabilitiesToDropString()`
`DockerComputerConnector`	`getConnector()`
`Long`	`getCpuPeriod()`
`Long`	`getCpuQuota()`
`String`	`getCpus()`
`Integer`	`getCpuShares()`
`Descriptor<DockerTemplate>`	`getDescriptor()`
`DockerDisabled`	`getDisabled()`
`String`	`getDisplayName()`
`String`	`getDnsString()`
`String[]`	`getDockerCommandArray()`
`DockerTemplateBase`	`getDockerTemplateBase()`
`String`	`getEnvironmentsString()`
`List<String>`	`getExtraHosts()`
`String`	`getExtraHostsString()`
`String`	`getFullImageId()`
`String`	`getImage()`
`int`	`getInstanceCap()`
`String`	`getInstanceCapStr()`
`Set<LabelAtom>`	`getLabelSet()`
`String`	`getLabelString()`
`String`	`getMacAddress()`
`Integer`	`getMemoryLimit()`
`Integer`	`getMemorySwap()`
`Node.Mode`	`getMode()`
`String[]`	`getMounts()`
`String`	`getMountsString()`
`String`	`getName()`
`static String`	`getNodeNameFromContainerConfig(com.github.dockerjava.api.command.CreateContainerCmd containerConfig)`	Retrieves the `Node` name chosen by `fillContainerConfig(CreateContainerCmd)`.
`List<? extends NodeProperty<?>>`	`getNodeProperties()`
`int`	`getNumExecutors()`
`Iterable<com.github.dockerjava.api.model.PortBinding>`	`getPortMappings()`
`DockerImagePullStrategy`	`getPullStrategy()`
`int`	`getPullTimeout()`
`org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint`	`getRegistry()`
`String`	`getRemoteFs()`
`RetentionStrategy`	`getRetentionStrategy()`
`List<String>`	`getSecurityOpts()`
`String`	`getSecurityOptsString()`
`Integer`	`getShmSize()`
`String`	`getShortDescription()`
`int`	`getStopTimeout()`
`String`	`getVolumesFrom()`	Deprecated.
`String[]`	`getVolumesFrom2()`
`String`	`getVolumesFromString()`
`int`	`hashCode()`
`boolean`	`isRemoveVolumes()`
`DockerTransientNode`	`provisionNode(DockerAPI api, TaskListener listener)`
`protected Object`	`readResolve()`	Initializes data structure that we don't persist.
`void`	`setDisabled(DockerDisabled disabled)`
`void`	`setMode(Node.Mode mode)`
`void`	`setName(String name)`
`static void`	`setNodeNameInContainerConfig(com.github.dockerjava.api.command.CreateContainerCmd containerConfig, String nodeName)`
`void`	`setNodeProperties(List<? extends NodeProperty<?>> nodeProperties)`
`void`	`setPullStrategy(DockerImagePullStrategy pullStrategy)`
`void`	`setPullTimeout(int pullTimeout)`
`void`	`setRemoteFs(String remoteFs)`
`void`	`setRemoveVolumes(boolean removeVolumes)`
`void`	`setRetentionStrategy(DockerOnceRetentionStrategy retentionStrategy)`
`void`	`setStopTimeout(int timeout)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- DEFAULT_STOP_TIMEOUT
```
public static final int DEFAULT_STOP_TIMEOUT
```
  The default timeout in seconds (10s) to wait during container shutdown until it will be forcefully terminated.
  
  See Also:
  
  Constant Field Values
- remoteFs
```
@CheckForNull
public String remoteFs
```
- instanceCap
```
public final int instanceCap
```

Constructor Detail

DockerTemplate
```
@Deprecated
public DockerTemplate()
```
Deprecated.
This gives an empty image name, which isn't valid.

Default constructor; give an unusable instance.

DockerTemplate

public DockerTemplate(@NonNull
                      DockerTemplateBase dockerTemplateBase,
                      @NonNull
                      DockerComputerConnector connector,
                      String labelString,
                      String remoteFs,
                      String instanceCapStr)

DockerTemplate

@DataBoundConstructor
public DockerTemplate(@NonNull
                      DockerTemplateBase dockerTemplateBase,
                      @NonNull
                      DockerComputerConnector connector,
                      String labelString,
                      String instanceCapStr)

Method Detail

getImage
```
public String getImage()
```

getDnsString
```
public String getDnsString()
```

getMounts

@CheckForNull
public String[] getMounts()

getMountsString
```
public String getMountsString()
```

getVolumesFrom

@Deprecated
public String getVolumesFrom()

Deprecated.

getVolumesFrom2
```
public String[] getVolumesFrom2()
```

getVolumesFromString
```
public String getVolumesFromString()
```

getMacAddress

@CheckForNull
public String getMacAddress()

getDisplayName
```
public String getDisplayName()
```

getMemoryLimit
```
public Integer getMemoryLimit()
```

getMemorySwap
```
public Integer getMemorySwap()
```

getCpus
```
public String getCpus()
```

getCpuPeriod
```
public Long getCpuPeriod()
```

getCpuQuota
```
public Long getCpuQuota()
```

getCpuShares
```
public Integer getCpuShares()
```

getShmSize
```
public Integer getShmSize()
```

getDockerCommandArray

public String[] getDockerCommandArray()

getPortMappings

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

getEnvironmentsString
```
public String getEnvironmentsString()
```

getExtraHosts

@CheckForNull
public List<String> getExtraHosts()

getExtraHostsString
```
public String getExtraHostsString()
```

getSecurityOpts

@CheckForNull
public List<String> getSecurityOpts()

getSecurityOptsString
```
public String getSecurityOptsString()
```

getCapabilitiesToAdd

@CheckForNull
public List<String> getCapabilitiesToAdd()

getCapabilitiesToAddString

public String getCapabilitiesToAddString()

getCapabilitiesToDrop

@CheckForNull
public List<String> getCapabilitiesToDrop()

getCapabilitiesToDropString

public String getCapabilitiesToDropString()

getRegistry

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

fillContainerConfig

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

setNodeNameInContainerConfig

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static void setNodeNameInContainerConfig(com.github.dockerjava.api.command.CreateContainerCmd containerConfig,
                                                String nodeName)

getNodeNameFromContainerConfig
```
@NonNull
public static String getNodeNameFromContainerConfig(com.github.dockerjava.api.command.CreateContainerCmd containerConfig)
```
Retrieves the Node name chosen by fillContainerConfig(CreateContainerCmd).

Parameters:

containerConfig - The CreateContainerCmd previously returned by fillContainerConfig(CreateContainerCmd).

Returns:

The name that Node.getNodeName() should return for the node for the container that will be created by this command.

Throws:

IllegalStateException - if no label was found.

getFullImageId
```
public String getFullImageId()
```

getDockerTemplateBase

public DockerTemplateBase getDockerTemplateBase()

isRemoveVolumes
```
public boolean isRemoveVolumes()
```

setRemoveVolumes

@DataBoundSetter
public void setRemoveVolumes(boolean removeVolumes)

getStopTimeout
```
public int getStopTimeout()
```

setStopTimeout

@DataBoundSetter
public void setStopTimeout(int timeout)

getLabelString

@CheckForNull
public String getLabelString()

setMode

@DataBoundSetter
public void setMode(Node.Mode mode)

getMode
```
public Node.Mode getMode()
```

getNumExecutors
```
public int getNumExecutors()
```

setRetentionStrategy

@DataBoundSetter
public void setRetentionStrategy(DockerOnceRetentionStrategy retentionStrategy)

getRetentionStrategy

public RetentionStrategy getRetentionStrategy()

getConnector

@NonNull
public DockerComputerConnector getConnector()

getRemoteFs

@CheckForNull
public String getRemoteFs()

setRemoteFs

@DataBoundSetter
public void setRemoteFs(String remoteFs)

getInstanceCapStr
```
public String getInstanceCapStr()
```

getInstanceCap
```
public int getInstanceCap()
```

getLabelSet

@NonNull
public Set<LabelAtom> getLabelSet()

getPullStrategy

@NonNull
public DockerImagePullStrategy getPullStrategy()

setPullStrategy

@DataBoundSetter
public void setPullStrategy(DockerImagePullStrategy pullStrategy)

getPullTimeout
```
public int getPullTimeout()
```

setPullTimeout

@DataBoundSetter
public void setPullTimeout(int pullTimeout)

getNodeProperties

@CheckForNull
public List<? extends NodeProperty<?>> getNodeProperties()

setNodeProperties

@DataBoundSetter
public void setNodeProperties(List<? extends NodeProperty<?>> nodeProperties)

getDisabled
```
public DockerDisabled getDisabled()
```

setDisabled

@DataBoundSetter
public void setDisabled(DockerDisabled disabled)

setName

@DataBoundSetter
public void setName(String name)

getName
```
@NonNull
public String getName()
```

readResolve
```
protected Object readResolve()
```
Initializes data structure that we don't persist.

Returns:

this, but populated

cloneWithLabel

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public DockerTemplate cloneWithLabel(String label)

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

getShortDescription
```
public String getShortDescription()
```

getDescriptor
```
public Descriptor<DockerTemplate> getDescriptor()
```
Specified by:

getDescriptor in interface Describable<DockerTemplate>

provisionNode

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public DockerTransientNode provisionNode(DockerAPI api,
                                         TaskListener listener)
                                  throws IOException,
                                         Descriptor.FormException,
                                         InterruptedException

Throws:: IOException; Descriptor.FormException; InterruptedException

Class DockerTemplate

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_STOP_TIMEOUT

remoteFs

instanceCap

Constructor Detail

DockerTemplate

DockerTemplate

DockerTemplate

Method Detail

getImage

getDnsString

getMounts

getMountsString

getVolumesFrom

getVolumesFrom2

getVolumesFromString

getMacAddress

getDisplayName

getMemoryLimit

getMemorySwap

getCpus

getCpuPeriod

getCpuQuota

getCpuShares

getShmSize

getDockerCommandArray

getPortMappings

getEnvironmentsString

getExtraHosts

getExtraHostsString

getSecurityOpts

getSecurityOptsString

getCapabilitiesToAdd

getCapabilitiesToAddString

getCapabilitiesToDrop

getCapabilitiesToDropString

getRegistry

fillContainerConfig

setNodeNameInContainerConfig

getNodeNameFromContainerConfig

getFullImageId

getDockerTemplateBase

isRemoveVolumes

setRemoveVolumes

getStopTimeout

setStopTimeout

getLabelString

setMode

getMode

getNumExecutors

setRetentionStrategy

getRetentionStrategy

getConnector

getRemoteFs

setRemoteFs

getInstanceCapStr

getInstanceCap

getLabelSet

getPullStrategy

setPullStrategy

getPullTimeout

setPullTimeout

getNodeProperties

setNodeProperties

getDisabled

setDisabled

setName

getName

readResolve

cloneWithLabel

equals

hashCode

toString

getShortDescription