io.jenkins.plugins.adobe.cloudmanager.step.execution

Class AbstractStepExecution

java.lang.Object

org.jenkinsci.plugins.workflow.steps.StepExecution

io.jenkins.plugins.adobe.cloudmanager.step.execution.AbstractStepExecution

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AdvancePipelineExecution, PipelineEndExecution, PipelineStepStateExecution, PollPipelineExecution

public abstract class AbstractStepExecution
extends org.jenkinsci.plugins.workflow.steps.StepExecution

Helper Step for interacting with Cloud Manager.

Standard functions used by all steps to ensure standard capabilities.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractStepExecution(org.jenkinsci.plugins.workflow.steps.StepContext context)

Method Summary

Modifier and Type	Method and Description
void	doResume() Subclasses should override this to provide specific logic after a restart operation.
void	doStart() Subclasses should override this to provide specific logic on step start.
void	doStop() Subclasses should override this to require specific logic during a stop operation.
protected AdobeIOProjectConfig	getAioProject() Retrieve the configured Adobe IO Project configured based on the information configured in the Run.
protected io.adobe.cloudmanager.CloudManagerApi	getApi() Build a Cloud Manager API based on the configured Adobe IO Project.
protected CloudManagerBuildAction	getBuildData() Get the Cloud Manager Build info from the run.
protected org.jenkinsci.plugins.workflow.graph.FlowNode	getFlowNode() Helper to get the FlowNode from the context.
String	getId()
protected Run<?,?>	getRun() Helper to get the Run from the context.
protected TaskListener	getTaskListener() Helper to get the TaskListener from the context.
boolean	isAsync() Subclasses should override this to indicate if it is an Async step.
void	onResume() Restart the Execution after a restart.
boolean	start() Starts the Execution.
void	stop(Throwable cause) Stop the Execution when an error occurs.
protected void	validateData() Validate that the data exists for the current run, any missing information will fail the run.

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

applyAll, applyAll, blocksRestart, getContext, getStatus, getStatusBounded

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStepExecution

public AbstractStepExecution(org.jenkinsci.plugins.workflow.steps.StepContext context)

Method Detail

getBuildData

@Nonnull
protected CloudManagerBuildAction getBuildData()
                                                 throws IOException,
                                                        InterruptedException

Get the Cloud Manager Build info from the run.

Throws:

IOException

InterruptedException

getId

@Nonnull
public String getId()

getAioProject

@Nonnull
protected AdobeIOProjectConfig getAioProject()
                                               throws IOException,
                                                      InterruptedException

Retrieve the configured Adobe IO Project configured based on the information configured in the Run.

Throws:

IOException

InterruptedException

validateData

protected void validateData()
                     throws IOException,
                            InterruptedException

Validate that the data exists for the current run, any missing information will fail the run.

Throws:

IOException

InterruptedException

getApi

@Nonnull
protected io.adobe.cloudmanager.CloudManagerApi getApi()
                                                         throws IOException,
                                                                InterruptedException

Build a Cloud Manager API based on the configured Adobe IO Project.

Throws:

IOException

InterruptedException

getRun

@Nonnull
protected Run<?,?> getRun()
                            throws IOException,
                                   InterruptedException

Helper to get the Run from the context.

Throws:

IOException

InterruptedException

getTaskListener

@Nonnull
protected TaskListener getTaskListener()
                                         throws IOException,
                                                InterruptedException

Helper to get the TaskListener from the context.

Throws:

IOException

InterruptedException

getFlowNode

@Nonnull
protected org.jenkinsci.plugins.workflow.graph.FlowNode getFlowNode()
                                                                      throws IOException,
                                                                             InterruptedException

Helper to get the FlowNode from the context.

Throws:

IOException

InterruptedException

start

public final boolean start()
                    throws Exception

Starts the Execution.

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.StepExecution

Throws:

Exception

onResume

public final void onResume()

Restart the Execution after a restart.

Overrides:

onResume in class org.jenkinsci.plugins.workflow.steps.StepExecution

stop

public final void stop(@Nonnull
                       Throwable cause)
                throws Exception

Stop the Execution when an error occurs.

Overrides:

stop in class org.jenkinsci.plugins.workflow.steps.StepExecution

Throws:

Exception

doStart

public void doStart()
             throws Exception

Subclasses should override this to provide specific logic on step start.

Throws:

Exception

doResume

public void doResume()
              throws IOException,
                     InterruptedException

Subclasses should override this to provide specific logic after a restart operation.

Throws:

IOException

InterruptedException

doStop

public void doStop()
            throws Exception

Subclasses should override this to require specific logic during a stop operation.

Throws:

Exception

isAsync

public boolean isAsync()

Subclasses should override this to indicate if it is an Async step. Default is true