com.openshift.jenkins.plugins.pipeline.dsl

Class OpenShiftBaseStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.workflow.steps.AbstractStepImpl

com.openshift.jenkins.plugins.pipeline.dsl.OpenShiftBaseStep

All Implemented Interfaces:

IOpenShiftParameterOverrides, IOpenShiftPlugin, hudson.ExtensionPoint, hudson.model.Describable<org.jenkinsci.plugins.workflow.steps.Step>, hudson.tasks.BuildStep, Serializable, jenkins.tasks.SimpleBuildStep

Direct Known Subclasses:

OpenShiftCreator, OpenShiftDeleterJsonYaml, OpenShiftDeleterLabels, OpenShiftDeleterList, OpenShiftImageTagger, OpenShiftServiceVerifier, TimedOpenShiftBaseStep

public abstract class OpenShiftBaseStep
extends org.jenkinsci.plugins.workflow.steps.AbstractStepImpl
implements jenkins.tasks.SimpleBuildStep, Serializable, IOpenShiftPlugin

See Also:

Serialized Form

Nested Class Summary

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
protected String	apiURL
protected Auth	auth
protected String	authToken
protected String	namespace
protected String	verbose

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Fields inherited from interface com.openshift.jenkins.plugins.pipeline.model.IOpenShiftPlugin

ANNOTATION_FAILURE, BUILD_NUMBER, BUILD_URL_ANNOTATION, BUILD_URL_ENV_KEY, JOB_NAME, KUBERNETES_MASTER_ENV_KEY, KUBERNETES_SERVICE_HOST_ENV_KEY, KUBERNETES_SERVICE_PORT_ENV_KEY, NAMESPACE_ENV_VAR, NAMESPACE_FILE, NAMESPACE_SYNC_BUILD_CAUSE, STATE_CANCELLED, STATE_COMPLETE, STATE_ERROR, STATE_FAILED, STATE_RUNNING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OpenShiftBaseStep()

Method Summary

Modifier and Type	Method and Description
String	getApiURL()
Auth	getAuth()
String	getAuthToken()
String	getBaseClassName()
String	getNamespace()
String	getVerbose()
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)
void	setApiURL(String apiURL)
void	setAuth(Auth auth)
void	setAuthToken(String authToken)
void	setNamespace(String namespace)
void	setVerbose(String verbose)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.AbstractStepImpl

prepareInjector, start

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

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

Methods inherited from interface com.openshift.jenkins.plugins.pipeline.model.IOpenShiftPlugin

annotateJobInfoToResource, consolidateEnvVars, constructBuildUrl, coreLogic, didAllImagesChangeIfNeeded, didICTCauseDeployment, didImageChangeFromPreviousVersion, doesDCTriggerOnImageTag, doIt, doIt, doItCore, getApiURL, getAuthToken, getClient, getClient, getDisplayName, getLatestReplicationController, getNamespace, getReplicationControllerState, getVerbose, httpGet, isBuildFinished, isBuildRunning, isDeployFinished, isReplicationControllerScaledAppropriately, verifyBuild

Methods inherited from interface com.openshift.jenkins.plugins.pipeline.model.IOpenShiftParameterOverrides

getOverride, pruneKey

Field Detail

apiURL

protected String apiURL

namespace

protected String namespace

authToken

protected String authToken

verbose

protected String verbose

auth

protected transient Auth auth

Constructor Detail

OpenShiftBaseStep

protected OpenShiftBaseStep()

Method Detail

getApiURL

public String getApiURL()

Specified by:

getApiURL in interface IOpenShiftPlugin

setApiURL

@DataBoundSetter
public void setApiURL(String apiURL)

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface IOpenShiftPlugin

setNamespace

@DataBoundSetter
public void setNamespace(String namespace)

getAuthToken

public String getAuthToken()

Specified by:

getAuthToken in interface IOpenShiftPlugin

setAuthToken

@DataBoundSetter
public void setAuthToken(String authToken)

getVerbose

public String getVerbose()

Specified by:

getVerbose in interface IOpenShiftPlugin

setVerbose

@DataBoundSetter
public void setVerbose(String verbose)

setAuth

public void setAuth(Auth auth)

Specified by:

setAuth in interface IOpenShiftPlugin

getAuth

public Auth getAuth()

Specified by:

getAuth in interface IOpenShiftPlugin

getBaseClassName

public String getBaseClassName()

Specified by:

getBaseClassName in interface IOpenShiftPlugin

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 IOException,
                       InterruptedException

Specified by:

perform in interface hudson.tasks.BuildStep

Throws:

IOException

InterruptedException