com.openshift.jenkins.plugins.pipeline

Class OpenShiftBuildCanceller

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

com.openshift.jenkins.plugins.pipeline.OpenShiftBuildCanceller

All Implemented Interfaces:

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

public class OpenShiftBuildCanceller
extends hudson.tasks.Recorder
implements jenkins.tasks.SimpleBuildStep, Serializable

OpenShift Builder.

When the user configures the project and enables this builder, Descriptor.newInstance(StaplerRequest) is invoked and a new OpenShiftBuildCanceller is created. The created instance is persisted to the project configuration XML by using XStream, so this allows you to use instance fields (like #name) to remember the configuration.

When a build is performed, the perform(AbstractBuild, Launcher, BuildListener) method will be invoked.

Author:

Gabe Montero

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenShiftBuildCanceller.DescriptorImpl Descriptor for OpenShiftBuildCanceller.

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

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 inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
OpenShiftBuildCanceller(String apiURL, String namespace, String authToken, String verbose, String buildConfig)

Method Summary

Modifier and Type	Method and Description
protected boolean	coreLogic(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.TaskListener listener)
String	getApiURL() We'll use this from the config.jelly.
String	getAuthToken()
OpenShiftBuildCanceller.DescriptorImpl	getDescriptor()
String	getNamespace()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
String	getVerbose()
protected HashMap<String,String>	inspectBuildEnvAndOverrideFields(hudson.model.AbstractBuild build, hudson.model.TaskListener listener, boolean chatty)
boolean	needsToRunAfterFinalized()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
protected void	restoreOverridenFields(HashMap<String,String> overrides, hudson.model.TaskListener listener)
void	setVerbose(String verbose)

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, 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, prebuild

Constructor Detail

OpenShiftBuildCanceller

@DataBoundConstructor
public OpenShiftBuildCanceller(String apiURL,
                                                     String namespace,
                                                     String authToken,
                                                     String verbose,
                                                     String buildConfig)

Method Detail

getApiURL

public String getApiURL()

We'll use this from the config.jelly.

getNamespace

public String getNamespace()

getAuthToken

public String getAuthToken()

getVerbose

public String getVerbose()

setVerbose

public void setVerbose(String verbose)

getDescriptor

public OpenShiftBuildCanceller.DescriptorImpl getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.tasks.Recorder

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

needsToRunAfterFinalized

public boolean needsToRunAfterFinalized()

Overrides:

needsToRunAfterFinalized in class hudson.tasks.Publisher

inspectBuildEnvAndOverrideFields

protected HashMap<String,String> inspectBuildEnvAndOverrideFields(hudson.model.AbstractBuild build,
                                                                  hudson.model.TaskListener listener,
                                                                  boolean chatty)

restoreOverridenFields

protected void restoreOverridenFields(HashMap<String,String> overrides,
                                      hudson.model.TaskListener listener)

coreLogic

protected boolean coreLogic(hudson.model.AbstractBuild<?,?> build,
                            hudson.Launcher launcher,
                            hudson.model.TaskListener listener)

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

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws InterruptedException,
                       IOException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException