Package org.jenkinsci.plugins.workflow.flow

Class FlowExecutionList

java.lang.Object

org.jenkinsci.plugins.workflow.flow.FlowExecutionList

All Implemented Interfaces:

Iterable<FlowExecution>

@Extension
public class FlowExecutionList
extends Object
implements Iterable<FlowExecution>

Enumerates running builds and ensures they resume after Jenkins is restarted.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FlowExecutionList.DefaultStorage
static class	FlowExecutionList.ItemListenerImpl	When Jenkins starts up and everything is loaded, be sure to proactively resurrect all the ongoing FlowExecutions so that they start running again.
static class	FlowExecutionList.ResumeStepExecutionListener	Whenever a Pipeline resumes, resume all incomplete steps in its FlowExecution.
static class	FlowExecutionList.StepExecutionIteratorImpl	Enumerates StepExecutions running inside FlowExecution.
static interface	FlowExecutionList.Storage	Alternate mechanism for implementing the storage of the set of builds.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXECUTIONS_SUSPENDED	Milestone for Terminator between TermMilestone.STARTED and LIST_SAVED.
static final String	LIST_SAVED	Milestone for Terminator between EXECUTIONS_SUSPENDED and TermMilestone.COMPLETED.

Constructor Summary

Constructors

Constructor	Description
FlowExecutionList()

Method Summary

Modifier and Type	Method	Description
static FlowExecutionList	get()
boolean	isResumptionComplete()	Returns true if all executions that were present in this FlowExecutionList have been loaded.
Iterator<FlowExecution>	iterator()	Lists all the current FlowExecutions.
void	register(FlowExecutionOwner self)	It is the responsibility of the FlowExecutionOwner to register itself before it starts executing.
static void	saveAll()
void	unregister(FlowExecutionOwner self)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

EXECUTIONS_SUSPENDED

public static final String EXECUTIONS_SUSPENDED

Milestone for Terminator between TermMilestone.STARTED and LIST_SAVED. All running builds have been suspended and their FlowExecutionOwner.getListener()s closed.

See Also:

• Constant Field Values

LIST_SAVED

public static final String LIST_SAVED

Milestone for Terminator between EXECUTIONS_SUSPENDED and TermMilestone.COMPLETED. FlowExecutionList itself has been saved.

See Also:

• Constant Field Values

Constructor Details

FlowExecutionList

public FlowExecutionList()

Method Details

iterator

public Iterator<FlowExecution> iterator()

Lists all the current FlowExecutions.

Specified by:

iterator in interface Iterable<FlowExecution>

register

public void register(FlowExecutionOwner self)

It is the responsibility of the FlowExecutionOwner to register itself before it starts executing. And likewise, unregister itself after it is completed, even though this class does clean up entries that are no longer running.

unregister

public void unregister(FlowExecutionOwner self)

get

public static FlowExecutionList get()

isResumptionComplete

@Restricted(org.kohsuke.accmod.restrictions.Beta.class)
public boolean isResumptionComplete()

Returns true if all executions that were present in this FlowExecutionList have been loaded.

This takes place slightly after InitMilestone.COMPLETED is reached during Jenkins startup.

Useful to avoid resuming Pipelines in contexts that may lead to deadlock.

It is not guaranteed that FlowExecution.afterStepExecutionsResumed() has been called at this point.

saveAll

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@Terminator(requires="FlowExecutionList.EXECUTIONS_SUSPENDED",
            attains="FlowExecutionList.LIST_SAVED")
public static void saveAll()
                    throws InterruptedException

Throws:

InterruptedException