public abstract class Step extends hudson.model.AbstractDescribableImpl<Step> implements hudson.ExtensionPoint
Step
is merely the definition of how this task is configured;
StepExecution
represents any state associated with one actual run of it.
Extends from Describable
to support UI-based instantiation.
Your step should have a config.jelly
allowing a user to configure its properties,
and may have a help.html
and/or help-fieldName.html
,
plus doEtc
methods on the StepDescriptor
for form validation, completion, and so on.
It should have a DataBoundConstructor
specifying mandatory properties.
It may also use DataBoundSetter
for optional properties.
All properties also need public getters (or to be public fields) for data binding to work.
Constructor and Description |
---|
Step() |
Modifier and Type | Method and Description |
---|---|
StepDescriptor |
getDescriptor() |
abstract StepExecution |
start(StepContext context)
Start execution of something and report the end result back to the given callback.
|
public abstract StepExecution start(StepContext context) throws Exception
StepContext.onSuccess(Object)
or FutureCallback.onFailure(Throwable)
.
false if the asynchronous execution has started and that StepContext
will be notified when the result comes in. (Note that the nature of asynchrony is such that it is possible
for the StepContext
to be already notified before this method returns.)Exception
- if any exception is thrown, Step
is assumed to have completed abnormally synchronously
(as if FutureCallback.onFailure(java.lang.Throwable)
is called and the method returned true.)public StepDescriptor getDescriptor()
Copyright © 2016–2017. All rights reserved.