Package org.jenkinsci.plugins.workflow.steps

Class AbstractStepExecutionImpl

java.lang.Object

org.jenkinsci.plugins.workflow.steps.StepExecution

org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractSynchronousNonBlockingStepExecution, AbstractSynchronousStepExecution

public abstract class AbstractStepExecutionImpl
extends StepExecution

Partial implementation of StepExecution that injects StepContextParameter upon resume. Declare any transient fields with StepContextParameter that you might need.

The originating Step may also be Injected. It must be marked Inject.optional(). Normally it is only used for the benefit of StepExecution.start(), so it should be transient. Beware that injecting a step this way does not currently work if that step has a no-argument (“default”) constructor (typically a DataBoundConstructor).

If you need any information from the step definition after a restart, make sure the Step is Serializable and do not mark it transient. (For a AbstractSynchronousStepExecution these considerations are irrelevant.)

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractStepExecutionImpl()	Deprecated. Directly extend StepExecution and avoid Guice for a new step.
protected	AbstractStepExecutionImpl(StepContext context)	Constructor for compatibility.

Method Summary

Modifier and Type	Method	Description
protected void	inject()	Deprecated.
void	onResume()	Reinject StepContextParameters.

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

applyAll, applyAll, blocksRestart, getContext, getStatus, getStatusBounded, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStepExecutionImpl

@Deprecated
protected AbstractStepExecutionImpl()

Deprecated.

Directly extend StepExecution and avoid Guice for a new step. Or see AbstractStepExecutionImpl(StepContext) for an existing step.

AbstractStepExecutionImpl

protected AbstractStepExecutionImpl(StepContext context)

Constructor for compatibility. Retain this constructor and override onResume() (do not call the super implementation) if your execution historically extended AbstractStepExecutionImpl, for serial form compatibility. For new steps, extend StepExecution directly.

Method Detail

onResume

public void onResume()

Reinject StepContextParameters. The Step will not be reinjected.

Overrides:

onResume in class StepExecution

See Also:

SynchronousResumeNotSupportedException

inject

@Deprecated
protected void inject()

Deprecated.