Class SynchronousNonBlockingStepExecution<T>
java.lang.Object
org.jenkinsci.plugins.workflow.steps.StepExecution
org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution<T>
- Type Parameters:
T
- the type of the return value (may beVoid
)
- All Implemented Interfaces:
Serializable
Similar to
SynchronousStepExecution
(it executes synchronously too) but it does not block the CPS VM thread.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Allows a step to indicate thatAsynchronousExecution.blocksRestart()
should be true.May be overridden to provide specific information about what a step is currently doing, for diagnostic purposes.void
onResume()
Called whenStepExecution
is brought back into memory after restart.protected abstract T
run()
Meat of the execution.final boolean
start()
Start execution of something and report the end result back to the given callback.void
If the computation is going synchronously, try to cancel that.Methods inherited from class org.jenkinsci.plugins.workflow.steps.StepExecution
applyAll, applyAll, getContext, getStatusBounded
-
Constructor Details
-
SynchronousNonBlockingStepExecution
-
-
Method Details
-
run
Meat of the execution. When this method returns, a step execution is over.- Throws:
Exception
-
start
Description copied from class:StepExecution
Start execution of something and report the end result back to the given callback.Arguments are passed when instantiating steps.
This method will run in the CPS VM thread and as such should not perform I/O or block. Use
SynchronousNonBlockingStepExecution
orGeneralNonBlockingStepExecution
as needed.- Specified by:
start
in classStepExecution
- Returns:
- true if the execution of this step has synchronously completed before this method returns.
It is the callee's responsibility to set the return value via
StepContext.onSuccess(Object)
orFutureCallback.onFailure(Throwable)
. false if the asynchronous execution has started and thatStepContext
will be notified when the result comes in. (Note that the nature of asynchrony is such that it is possible for theStepContext
to be already notified before this method returns.) - Throws:
Exception
- if any exception is thrown,Step
is assumed to have completed abnormally synchronously (as ifFutureCallback.onFailure(java.lang.Throwable)
is called and the method returned true.)
-
stop
If the computation is going synchronously, try to cancel that.- Overrides:
stop
in classStepExecution
- Parameters:
cause
- Contextual information that lets the step know what resulted in stopping an executing step, passed in the hope that this will assist diagnostics.- Throws:
Exception
-
onResume
public void onResume()Description copied from class:StepExecution
Called whenStepExecution
is brought back into memory after restart. Convenient for re-establishing the polling.Currently not permitted to throw exceptions, but may report errors via
FutureCallback.onFailure(java.lang.Throwable)
.- Overrides:
onResume
in classStepExecution
- See Also:
-
getStatus
Description copied from class:StepExecution
May be overridden to provide specific information about what a step is currently doing, for diagnostic purposes. Typical format should be a short, lowercase phrase. It should not be localized as this is intended for use by developers as well as users. May include technical details about Jenkins internals if relevant.- Overrides:
getStatus
in classStepExecution
- Returns:
- current status, or null if unimplemented
- See Also:
-
blocksRestart
public boolean blocksRestart()Description copied from class:StepExecution
Allows a step to indicate thatAsynchronousExecution.blocksRestart()
should be true. Typically this would be true ifStepExecution.getStatus()
indicates that the step is in the middle of something active, as opposed to waiting for an external event or a body to complete.Note that activity in the CPS VM thread automatically blocks restart, so overriding this is only necessary for steps using a background thread, such as
SynchronousNonBlockingStepExecution
orGeneralNonBlockingStepExecution
.- Overrides:
blocksRestart
in classStepExecution
- Returns:
- false by default
-