com.nirima.jenkins.plugins.docker.builder

Class DockerBuilderPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.nirima.jenkins.plugins.docker.builder.DockerBuilderPublisher

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep, Serializable, jenkins.tasks.SimpleBuildStep

public class DockerBuilderPublisher
extends hudson.tasks.Builder
implements Serializable, jenkins.tasks.SimpleBuildStep

Builder extension to build / publish an image from a Dockerfile. TODO automatic migration to https://wiki.jenkins.io/display/JENKINS/CloudBees+Docker+Build+and+Publish+plugin

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockerBuilderPublisher.DescriptorImpl

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
boolean	cleanImages
boolean	cleanupWithJenkinsJobDelete
String	cloud
String	dockerFileDirectory
boolean	pushOnSuccess
String	tag Deprecated. use tags

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
DockerBuilderPublisher(String dockerFileDirectory, org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint fromRegistry, String cloud, String tagsString, boolean pushOnSuccess, org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint registry, boolean cleanImages, boolean cleanupWithJenkinsJobDelete)

Method Summary

Modifier and Type	Method and Description
static List<String>	filterStringToList(String str)
protected DockerCloud	getCloud(hudson.Launcher launcher)
DockerBuilderPublisher.DescriptorImpl	getDescriptor()
org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint	getFromRegistry()
org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint	getRegistry()
List<String>	getTags()
String	getTagsString()
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setTags(List<String> tags)
void	setTagsString(String tagsString)
static void	verifyTags(String tagsString)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, getRequiredMonitorService, perform, prebuild

Field Detail

dockerFileDirectory

public final String dockerFileDirectory

tag

@Deprecated
public String tag

Deprecated. use tags

pushOnSuccess

public final boolean pushOnSuccess

cleanImages

public final boolean cleanImages

cleanupWithJenkinsJobDelete

public final boolean cleanupWithJenkinsJobDelete

cloud

public final String cloud

Constructor Detail

DockerBuilderPublisher

@DataBoundConstructor
public DockerBuilderPublisher(String dockerFileDirectory,
                                                    org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint fromRegistry,
                                                    String cloud,
                                                    String tagsString,
                                                    boolean pushOnSuccess,
                                                    org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint registry,
                                                    boolean cleanImages,
                                                    boolean cleanupWithJenkinsJobDelete)

Method Detail

getRegistry

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

getTags

public List<String> getTags()

setTags

public void setTags(List<String> tags)

getTagsString

public String getTagsString()

setTagsString

public void setTagsString(String tagsString)

getFromRegistry

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

filterStringToList

public static List<String> filterStringToList(String str)

verifyTags

public static void verifyTags(String tagsString)

getCloud

protected DockerCloud getCloud(hudson.Launcher launcher)

perform

public void perform(hudson.model.Run<?,?> run,
                    hudson.FilePath workspace,
                    hudson.Launcher launcher,
                    hudson.model.TaskListener listener)
             throws InterruptedException,
                    IOException

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

InterruptedException

IOException

getDescriptor

public DockerBuilderPublisher.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder