Package org.jenkinsci.plugins.workflow.flow

Class FlowExecutionListener

java.lang.Object

org.jenkinsci.plugins.workflow.flow.FlowExecutionListener

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

FlowExecutionList.ResumeStepExecutionListener

public abstract class FlowExecutionListener
extends Object
implements ExtensionPoint

Listens for significant status updates for a FlowExecution, such as started running or completed.

Since:

2.14

Author:

Andrew Bayer

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
FlowExecutionListener()

Method Summary

Modifier and Type	Method	Description
static void	fireCompleted(FlowExecution execution)	Fires the onCompleted(FlowExecution) event.
static void	fireCreated(FlowExecution execution)	Fires the onCreated(FlowExecution) event.
static void	fireResumed(FlowExecution execution)	Fires the onResumed(FlowExecution) event.
static void	fireRunning(FlowExecution execution)	Fires the onRunning(FlowExecution) event.
void	onCompleted(FlowExecution execution)	Called when a FlowExecution has completed.
void	onCreated(FlowExecution execution)	Called when a FlowExecution has been created, but before it starts running.
void	onResumed(FlowExecution execution)	Called when a FlowExecution has resumed.
void	onRunning(FlowExecution execution)	Called when a FlowExecution has started running.

Methods inherited from class java.lang.Object

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

Constructor Details

FlowExecutionListener

public FlowExecutionListener()

Method Details

onCreated

public void onCreated(@NonNull
 FlowExecution execution)

Called when a FlowExecution has been created, but before it starts running. The FlowExecution will already have been added to the FlowExecutionList by this point. Methods relating to in-progress execution state such as FlowExecution.getCurrentHeads() will not work as intended and should not be used.

Parameters:

execution - The FlowExecution that has been created.

onRunning

public void onRunning(@NonNull
 FlowExecution execution)

Called when a FlowExecution has started running. The FlowExecution will already have been added to the FlowExecutionList by this point.

Parameters:

execution - The FlowExecution that has started running.

onResumed

public void onResumed(@NonNull
 FlowExecution execution)

Called when a FlowExecution has resumed.

Parameters:

execution - The FlowExecution that has resumed.

onCompleted

public void onCompleted(@NonNull
 FlowExecution execution)

Called when a FlowExecution has completed. The FlowExecution will already have been removed from the FlowExecutionList by this point, GraphListener.onNewHead(FlowNode) will have already been called for the FlowEndNode, FlowExecution.getCurrentHeads() will have one element, a FlowEndNode, and if the Pipeline has failed, FlowExecution.getCauseOfFailure() will return non-null.

Parameters:

execution - The FlowExecution that has completed.

fireCreated

public static void fireCreated(@NonNull
 FlowExecution execution)

Fires the onCreated(FlowExecution) event.

fireRunning

public static void fireRunning(@NonNull
 FlowExecution execution)

Fires the onRunning(FlowExecution) event.

fireResumed

public static void fireResumed(@NonNull
 FlowExecution execution)

Fires the onResumed(FlowExecution) event.

fireCompleted

public static void fireCompleted(@NonNull
 FlowExecution execution)

Fires the onCompleted(FlowExecution) event.