Package org.jenkinsci.plugins.workflow.flow

Class FlowDefinition

java.lang.Object

hudson.model.AbstractDescribableImpl<FlowDefinition>

org.jenkinsci.plugins.workflow.flow.FlowDefinition

All Implemented Interfaces:

ExtensionPoint, Describable<FlowDefinition>

public abstract class FlowDefinition
extends AbstractDescribableImpl<FlowDefinition>
implements ExtensionPoint

Actual executable script.

Author:

Kohsuke Kawaguchi, Jesse Glick

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
FlowDefinition()

Method Summary

Modifier and Type	Method	Description
FlowExecution	create(FlowExecutionOwner handle, TaskListener listener, List<? extends Action> actions)	Starts a brand new execution of this definition from the beginning.
FlowExecution	create(FlowExecutionOwner handle, List<? extends Action> actions)	Deprecated.
FlowDefinitionDescriptor	getDescriptor()
Collection<? extends SCM>	getSCMs()	Returns a list of all SCMs that are part of the static configuration of the FlowDefinition.

Methods inherited from class java.lang.Object

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

Constructor Details

FlowDefinition

public FlowDefinition()

Method Details

create

public FlowExecution create(FlowExecutionOwner handle,
 TaskListener listener,
 List<? extends Action> actions)
                     throws Exception

Starts a brand new execution of this definition from the beginning.

Parameters:

actions - Additional parameters to how

Throws:

Exception

create

@Deprecated
public FlowExecution create(FlowExecutionOwner handle,
 List<? extends Action> actions)
                     throws IOException

Deprecated.

Throws:

IOException

getDescriptor

public FlowDefinitionDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<FlowDefinition>

getSCMs

public Collection<? extends SCM> getSCMs()

Returns a list of all SCMs that are part of the static configuration of the FlowDefinition. Subclasses of FlowDefinition may override this method to return statically configured SCMs that they may be aware of. For example, CpsScmFlowDefinition returns SCM used to retrieve Jenkinsfile. Does not include any SCMs used dynamically during Pipeline execution. May be empty (or not overridden) if the Pipeline does not include any statically configured SCMs. This method is used in WorkflowJob class which will combine lists of static and dynamic SCMs.