Interface PipelineListener

All Known Implementing Classes:
AbstractPipelineListener, MonitoringPipelineListener

public interface PipelineListener
  • Method Summary

    Modifier and Type
    Method
    Description
    all()
     
    void
    onAfterAtomicStep(org.jenkinsci.plugins.workflow.cps.nodes.StepAtomNode stepAtomNode, org.jenkinsci.plugins.workflow.graph.FlowNode nextNode, org.jenkinsci.plugins.workflow.job.WorkflowRun run)
    Just after the atomic step
    void
    onAfterStartNodeStep(org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode stepStartNode, String nodeLabel, org.jenkinsci.plugins.workflow.job.WorkflowRun run)
    Just after the `node` step starts.
    void
    onAtomicStep(org.jenkinsci.plugins.workflow.cps.nodes.StepAtomNode node, org.jenkinsci.plugins.workflow.job.WorkflowRun run)
    Just before the atomic step starts
    void
    onEndNodeStep(org.jenkinsci.plugins.workflow.cps.nodes.StepEndNode nodeStepEndNode, String nodeName, org.jenkinsci.plugins.workflow.graph.FlowNode nextNode, org.jenkinsci.plugins.workflow.job.WorkflowRun run)
    Just after the `node` step ends
    void
    onEndParallelStepBranch(org.jenkinsci.plugins.workflow.cps.nodes.StepEndNode stepStepNode, String branchName, org.jenkinsci.plugins.workflow.graph.FlowNode nextNode, org.jenkinsci.plugins.workflow.job.WorkflowRun run)
    Just before the `parallel` branch ends
    void
    onEndPipeline(org.jenkinsci.plugins.workflow.graph.FlowNode node, org.jenkinsci.plugins.workflow.job.WorkflowRun run)
    Just after the pipeline ends
    void
    onEndStageStep(org.jenkinsci.plugins.workflow.cps.nodes.StepEndNode stageStepEndNode, String stageName, org.jenkinsci.plugins.workflow.graph.FlowNode nextNode, org.jenkinsci.plugins.workflow.job.WorkflowRun run)
    Just after the `stage` step ends
    void
    onEndWithNewSpanStep(org.jenkinsci.plugins.workflow.cps.nodes.StepEndNode nodeStepEndNode, org.jenkinsci.plugins.workflow.graph.FlowNode nextNode, org.jenkinsci.plugins.workflow.job.WorkflowRun run)
    Just before the `withNewSpan` step ends
    void
    onStartNodeStep(org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode stepStartNode, String nodeLabel, org.jenkinsci.plugins.workflow.job.WorkflowRun run)
    Just before the `node` step starts.
    void
    onStartParallelStepBranch(org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode stepStartNode, String branchName, org.jenkinsci.plugins.workflow.job.WorkflowRun run)
    Just before the `parallel` branch starts
    void
    onStartPipeline(org.jenkinsci.plugins.workflow.graph.FlowNode node, org.jenkinsci.plugins.workflow.job.WorkflowRun run)
    Just before the pipeline starts
    void
    onStartStageStep(org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode stepStartNode, String stageName, org.jenkinsci.plugins.workflow.job.WorkflowRun run)
    Just before the `stage`step starts
    void
    onStartWithNewSpanStep(org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode stepStartNode, org.jenkinsci.plugins.workflow.job.WorkflowRun run)
    Just before the `withNewSpan` step starts
  • Method Details

    • all

      @NonNull static List<PipelineListener> all()
    • onStartPipeline

      void onStartPipeline(@NonNull org.jenkinsci.plugins.workflow.graph.FlowNode node, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)
      Just before the pipeline starts
    • onStartNodeStep

      void onStartNodeStep(@NonNull org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode stepStartNode, @Nullable String nodeLabel, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)
      Just before the `node` step starts.
    • onAfterStartNodeStep

      void onAfterStartNodeStep(@NonNull org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode stepStartNode, @Nullable String nodeLabel, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)
      Just after the `node` step starts.
    • onEndNodeStep

      void onEndNodeStep(@NonNull org.jenkinsci.plugins.workflow.cps.nodes.StepEndNode nodeStepEndNode, @NonNull String nodeName, org.jenkinsci.plugins.workflow.graph.FlowNode nextNode, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)
      Just after the `node` step ends
    • onStartStageStep

      void onStartStageStep(@NonNull org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode stepStartNode, @NonNull String stageName, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)
      Just before the `stage`step starts
    • onEndStageStep

      void onEndStageStep(@NonNull org.jenkinsci.plugins.workflow.cps.nodes.StepEndNode stageStepEndNode, @NonNull String stageName, org.jenkinsci.plugins.workflow.graph.FlowNode nextNode, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)
      Just after the `stage` step ends
    • onStartParallelStepBranch

      void onStartParallelStepBranch(@NonNull org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode stepStartNode, @NonNull String branchName, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)
      Just before the `parallel` branch starts
    • onEndParallelStepBranch

      void onEndParallelStepBranch(@NonNull org.jenkinsci.plugins.workflow.cps.nodes.StepEndNode stepStepNode, @NonNull String branchName, org.jenkinsci.plugins.workflow.graph.FlowNode nextNode, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)
      Just before the `parallel` branch ends
    • onStartWithNewSpanStep

      void onStartWithNewSpanStep(@NonNull org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode stepStartNode, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)
      Just before the `withNewSpan` step starts
    • onEndWithNewSpanStep

      void onEndWithNewSpanStep(@NonNull org.jenkinsci.plugins.workflow.cps.nodes.StepEndNode nodeStepEndNode, org.jenkinsci.plugins.workflow.graph.FlowNode nextNode, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)
      Just before the `withNewSpan` step ends
    • onAtomicStep

      void onAtomicStep(@NonNull org.jenkinsci.plugins.workflow.cps.nodes.StepAtomNode node, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)
      Just before the atomic step starts
    • onAfterAtomicStep

      void onAfterAtomicStep(@NonNull org.jenkinsci.plugins.workflow.cps.nodes.StepAtomNode stepAtomNode, org.jenkinsci.plugins.workflow.graph.FlowNode nextNode, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)
      Just after the atomic step
    • onEndPipeline

      void onEndPipeline(@NonNull org.jenkinsci.plugins.workflow.graph.FlowNode node, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)
      Just after the pipeline ends