Package org.jenkinsci.plugins.workflow.flow

Interface StepListener

All Superinterfaces:
ExtensionPoint
public interface StepListener extends ExtensionPoint
StepListeners are fired before invoking a step but after the FlowNode has been created and the StepContext has been populated. A StepListener can perform actions before the Step is executed, such as calling FutureCallback.onFailure(java.lang.Throwable) to make the step fail before it starts.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface hudson.ExtensionPoint

    ExtensionPoint.LegacyInstancesAreScopedToHudson

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    notifyOfNewStep(org.jenkinsci.plugins.workflow.steps.Step step, org.jenkinsci.plugins.workflow.steps.StepContext context)
    Called before a Step is invoked, but after its FlowNode and StepContext have been created.

  • Method Details

    • notifyOfNewStep

      void notifyOfNewStep(@NonNull org.jenkinsci.plugins.workflow.steps.Step step, @NonNull org.jenkinsci.plugins.workflow.steps.StepContext context)
      Called before a Step is invoked, but after its FlowNode and StepContext have been created. Listeners can make the step fail by calling FutureCallback.onFailure(java.lang.Throwable).