Extension Points defined in Pipeline: API Plugin

Table of Contents

DurabilityHintProvider
ErrorCondition
FlowCopier
FlowDefinition
FlowExecutionListener
FlowNodeViewColumn
FlowNodeViewColumnDescriptor
GraphListener
LogStorageFactory
PickleFactory
StashManager.StashBehavior
StepListener
TaskListenerDecorator.Factory

Pipeline: API Plugin

DurabilityHintProvider

org.jenkinsci.plugins.workflow.flow.DurabilityHintProvider in workflow-api

Provides a way to indirectly register durability settings to apply to pipelines.

Implementations:

Pipeline: Job Plugin: org.jenkinsci.plugins.workflow.job.properties.DisableResumeJobProperty.DescriptorImpl (view on GitHub)
Pipeline: Job Plugin: org.jenkinsci.plugins.workflow.job.properties.DurabilityHintJobProperty.DescriptorImpl (view on GitHub)
Pipeline: Multibranch Plugin: org.jenkinsci.plugins.workflow.multibranch.DurabilityHintBranchProperty.DescriptorImpl (view on GitHub)

ErrorCondition

org.jenkinsci.plugins.workflow.flow.ErrorCondition in workflow-api

User-configurable predicate for errors that may occur during a build. Implementations could check for agent-related outages, for example. Step callers could use a condition to decide whether to ignore or report an error, retry, etc.

Implementations:

Kubernetes Plugin: org.csanchez.jenkins.plugins.kubernetes.pipeline.KubernetesAgentErrorCondition (view on GitHub)
Pipeline: Basic Steps Plugin: org.jenkinsci.plugins.workflow.steps.SynchronousResumeNotSupportedErrorCondition (view on GitHub)
Pipeline: Nodes and Processes Plugin: org.jenkinsci.plugins.workflow.support.steps.AgentErrorCondition (view on GitHub)

FlowCopier

org.jenkinsci.plugins.workflow.flow.FlowCopier in workflow-api

A way for plugins to copy metadata and associated files from one flow execution to another. Useful when a new execution is not being created from scratch, but is a kind of clone of another.

Implementations:

Pipeline: API Plugin: org.jenkinsci.plugins.workflow.flow.FlowCopier.ByRun (view on GitHub)
Pipeline: API Plugin: org.jenkinsci.plugins.workflow.flow.FlowCopier.StandardActions (view on GitHub)
Pipeline: API Plugin: org.jenkinsci.plugins.workflow.flow.StashManager.CopyStashesAndArtifacts (view on GitHub)
Pipeline: Groovy Libraries Plugin: org.jenkinsci.plugins.workflow.libs.LibraryAdder.Copier (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.EnvActionImpl.Copier (view on GitHub)
Pipeline: Job Plugin: org.jenkinsci.plugins.workflow.job.WorkflowRun.Checkouts (view on GitHub)

FlowDefinition

org.jenkinsci.plugins.workflow.flow.FlowDefinition in workflow-api

Actual executable script.

Implementations:

Config-Driven Pipeline Plugin: org.jenkinsci.plugins.workflow.multibranch.template.ConfigFileSCMBinder (view on GitHub)
Multibranch Pipeline Inline Definition Plugin: org.jenkinsci.plugins.inlinepipeline.InlineFlowDefinition (view on GitHub)
OES Template Plugin: cn.opsbox.jenkinsci.plugins.cps.CpsTemplateFlowDefinition (view on GitHub)
OES Template Plugin: cn.opsbox.jenkinsci.plugins.cps.OesTemplateFlowDefinition (view on GitHub)
Pipeline As YAML (Incubated) Plugin: io.jenkins.plugins.pipeline.scm.ExtendedSCMBinder (view on GitHub)
Pipeline As YAML (Incubated) Plugin: io.jenkins.plugins.pipeline.PipelineAsYamlScmFlowDefinition (view on GitHub)
Pipeline As YAML (Incubated) Plugin: io.jenkins.plugins.pipeline.PipelineAsYamlScriptFlowDefinition (view on GitHub)
Pipeline As YAML (Incubated) Plugin: io.jenkins.plugins.pipeline.cps.PipelineCpsFlowDefinition (view on GitHub)
Pipeline As YAML (Incubated) Plugin: io.jenkins.plugins.pipeline.cps.PipelineCpsScmFlowDefinition (view on GitHub)
Pipeline restFul API Plugin: io.jenkins.plugins.pipeline.restful.api.HttpFlowDefinition (view on GitHub)
Pipeline: Groovy HTTP Plugin: org.jenkinsci.plugins.workflowhttp.cps.CpsHttpFlowDefinition (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.CpsScmFlowDefinition (view on GitHub)
Pipeline: Multibranch Plugin: org.jenkinsci.plugins.workflow.multibranch.SCMBinder (view on GitHub)
Pipeline: Multibranch with defaults Plugin: org.jenkinsci.plugins.pipeline.multibranch.defaults.DefaultsBinder (view on GitHub)
Remote Jenkinsfile Provider Plugin: org.jenkinsci.plugins.workflow.multibranch.extended.scm.ExtendedSCMBinder (view on GitHub)

FlowExecutionListener

org.jenkinsci.plugins.workflow.flow.FlowExecutionListener in workflow-api

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

Implementations:

Events API for Blue Ocean Plugin: io.jenkins.blueocean.events.PipelineEventListener.StartPublisher (view on GitHub)
JFrog Plugin: io.jenkins.plugins.jfrog.WorkflowListener (view on GitHub)
Pipeline Configuration History Plugin: org.jenkinsci.plugins.pipelineConfigHistory.model.PipelineConfigHistoryFlowExecutionListener (view on GitHub)
Pipeline: API Plugin: org.jenkinsci.plugins.workflow.flow.FlowExecutionList.ResumeStepExecutionListener (view on GitHub)

FlowNodeViewColumn

org.jenkinsci.plugins.workflow.visualization.table.FlowNodeViewColumn in workflow-api

Extension point for adding a column to a table rendering of FlowNode s.

Implementations:

Better Pipeline Flow Graph Table Plugin: io.jenkins.plugins.better_pipeline_flowgraph_table.StatusFormatterColumn (view on GitHub)
Pipeline: Supporting APIs Plugin: org.jenkinsci.plugins.workflow.support.visualization.table.ArgumentsColumn (view on GitHub)
Pipeline: Supporting APIs Plugin: org.jenkinsci.plugins.workflow.support.visualization.table.ConsoleColumn (view on GitHub)
Pipeline: Supporting APIs Plugin: org.jenkinsci.plugins.workflow.support.visualization.table.StatusColumn (view on GitHub)

FlowNodeViewColumnDescriptor

org.jenkinsci.plugins.workflow.visualization.table.FlowNodeViewColumnDescriptor in workflow-api

Descriptor for FlowNodeViewColumn .

Implementations:

Better Pipeline Flow Graph Table Plugin: io.jenkins.plugins.better_pipeline_flowgraph_table.StatusFormatterColumn.DescriptorImpl (view on GitHub)
Pipeline: Supporting APIs Plugin: org.jenkinsci.plugins.workflow.support.visualization.table.ArgumentsColumn.DescriptorImpl (view on GitHub)
Pipeline: Supporting APIs Plugin: org.jenkinsci.plugins.workflow.support.visualization.table.ConsoleColumn.DescriptorImpl (view on GitHub)
Pipeline: Supporting APIs Plugin: org.jenkinsci.plugins.workflow.support.visualization.table.StatusColumn.DescriptorImpl (view on GitHub)

GraphListener

org.jenkinsci.plugins.workflow.flow.GraphListener in workflow-api

{@code GraphListener}s can be used in two different ways: either as an Extension , which will have its #onNewHead(FlowNode) fired for every FlowExecution , or by instantiation and being passed to FlowExecution#addListener(GraphListener) , in which case only events for that specific FlowExecution will be fired.

Implementations:

Atlassian Jira Software Cloud Plugin: com.atlassian.jira.cloud.jenkins.listeners.JenkinsPipelineGraphListener (view on GitHub)
CDEvents Plugin: io.jenkins.plugins.cdevents.listeners.PipelineEventListener (view on GitHub)
Checks API Plugin: io.jenkins.plugins.checks.status.BuildStatusChecksPublisher.ChecksGraphListener (view on GitHub)
Datadog Plugin: org.datadog.jenkins.plugins.datadog.listeners.DatadogGraphListener (view on GitHub)
Events API for Blue Ocean Plugin: io.jenkins.blueocean.events.PipelineEventListener (view on GitHub)
Job and Stage monitoring Plugin: org.jenkinsci.plugins.githubautostatus.GithubBuildStatusGraphListener (view on GitHub)
OpenTelemetry Plugin: io.jenkins.plugins.opentelemetry.job.jenkins.GraphListenerAdapterToPipelineListener (view on GitHub)
OpenText Application Automation Tools Plugin: com.microfocus.application.automation.tools.octane.vulnerabilities.VulnerabilitiesWorkflowListener (view on GitHub)
OpenText Application Automation Tools Plugin: com.microfocus.application.automation.tools.octane.events.WorkflowListenerOctaneImpl (view on GitHub)
Pipeline Input Step Notification Plugin: io.jenkins.plugins.pipeline.input.InputNotificationGraphListener (view on GitHub)
Pipeline: API Plugin: org.jenkinsci.plugins.workflow.flow.GraphListener.Synchronous (view on GitHub)
Pipeline: API Plugin: org.jenkinsci.plugins.workflow.graph.StandardGraphLookupView (view on GitHub)
Pipeline: Declarative Plugin: org.jenkinsci.plugins.pipeline.modeldefinition.SyntheticStageGraphListener (view on GitHub)
Pipeline: Job Plugin: org.jenkinsci.plugins.workflow.job.WorkflowRun.FailOnLoadListener (view on GitHub)
Pipeline: Job Plugin: org.jenkinsci.plugins.workflow.job.WorkflowRun.GraphL (view on GitHub)
Pipeline: Job Plugin: org.jenkinsci.plugins.workflow.job.WorkflowRun.NodePrintListener (view on GitHub)
Pipeline: Supporting APIs Plugin: Anonymous class in org.jenkinsci.plugins.workflow.support.DefaultStepContext (view on GitHub)
Trunk Plugin: io.jenkins.plugins.trunk.listeners.JenkinsActivityListener (view on GitHub)

LogStorageFactory

org.jenkinsci.plugins.workflow.log.LogStorageFactory in workflow-api

Factory interface for LogStorage .

Implementations:

OpenTelemetry Plugin: io.jenkins.plugins.opentelemetry.job.log.OtelLogStorageFactory (view on GitHub)
Pipeline Logging over CloudWatch Plugin: io.jenkins.plugins.pipeline_cloudwatch_logs.PipelineBridge (view on GitHub)

PickleFactory

org.jenkinsci.plugins.workflow.pickles.PickleFactory in workflow-api

Provides a way of converting transient objects into Pickle s.

Implementations:

JUnit Realtime Test Reporter Plugin: org.jenkinsci.plugins.junitrealtimetestreporter.RealtimeJUnitStep.Pickler (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.EnvActionImpl.EnvActionImplPickleFactory (view on GitHub)
Pipeline: Multibranch Plugin: org.jenkinsci.plugins.workflow.multibranch.SCMVar.Pickler (view on GitHub)
Pipeline: Nodes and Processes Plugin: org.jenkinsci.plugins.workflow.support.pickles.ComputerPickle.Factory (view on GitHub)
Pipeline: Nodes and Processes Plugin: org.jenkinsci.plugins.workflow.support.pickles.ExecutorPickle.Factory (view on GitHub)
Pipeline: Nodes and Processes Plugin: org.jenkinsci.plugins.workflow.support.pickles.FilePathPickle.Factory (view on GitHub)
Pipeline: Nodes and Processes Plugin: org.jenkinsci.plugins.workflow.support.pickles.WorkspaceListLeasePickle.Factory (view on GitHub)
Pipeline: Supporting APIs Plugin: org.jenkinsci.plugins.workflow.support.pickles.SecretPickle.Factory (view on GitHub)
Pipeline: Supporting APIs Plugin: org.jenkinsci.plugins.workflow.support.pickles.SingleTypedPickleFactory (view on GitHub)
Pipeline: Supporting APIs Plugin: org.jenkinsci.plugins.workflow.support.pickles.ThrowablePickle.Factory (view on GitHub)

StashManager.StashBehavior

org.jenkinsci.plugins.workflow.flow.StashManager.StashBehavior in workflow-api

Extension point for customizing behavior of stashes from other plugins.

Implementations:

Pipeline: Declarative Plugin: org.jenkinsci.plugins.pipeline.modeldefinition.properties.PreserveStashesJobProperty.SaveStashes (view on GitHub)

StepListener

org.jenkinsci.plugins.workflow.flow.StepListener in workflow-api

StepListener s 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 StepContext#onFailure to make the step fail before it starts.

Implementations:

Datadog Plugin: org.datadog.jenkins.plugins.datadog.listeners.DatadogStepListener (view on GitHub)
DingTalk Plugin: io.jenkins.plugins.DingTalkStepListener (view on GitHub)
OpenTelemetry Plugin: io.jenkins.plugins.opentelemetry.job.jenkins.GraphListenerAdapterToPipelineListener (view on GitHub)
OpenTelemetry Plugin: io.jenkins.plugins.opentelemetry.job.MonitoringPipelineListener (view on GitHub)

TaskListenerDecorator.Factory

org.jenkinsci.plugins.workflow.log.TaskListenerDecorator.Factory in workflow-api

Allows a decorator to be applied to any build.

Implementations:

Datadog Plugin: org.datadog.jenkins.plugins.datadog.logs.DatadogTaskListenerDecorator.Factory (view on GitHub)
Timestamper Plugin: hudson.plugins.timestamper.pipeline.GlobalDecorator.Factory (view on GitHub)

Developer Documentation

Plugin Tutorial

How-To Guides

Reference Topics

Resources

Extensions Index

Javadoc

Taglibs

Tools

Extension Points defined in Pipeline: API Plugin

DurabilityHintProvider

ErrorCondition

FlowCopier

FlowDefinition

FlowExecutionListener

FlowNodeViewColumn

FlowNodeViewColumnDescriptor

GraphListener

LogStorageFactory

PickleFactory

StashManager.StashBehavior

StepListener

TaskListenerDecorator.Factory