Extension Points defined in Pipeline: API Plugin

This site is the new docs site currently being tested. For the actual docs in use please go to https://www.jenkins.io/doc.

Pipeline: API Plugin

DurabilityHintProvider

jenkinsdoc:workflow-api:org.jenkinsci.plugins.workflow.flow.DurabilityHintProvider]

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

Implementations:

Pipeline: Multibranch Plugin: org.jenkinsci.plugins.workflow.multibranch.DurabilityHintBranchProperty.DescriptorImpl (view on GitHub)

ErrorCondition

jenkinsdoc:workflow-api:org.jenkinsci.plugins.workflow.flow.ErrorCondition]

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:

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

jenkinsdoc:workflow-api:org.jenkinsci.plugins.workflow.flow.FlowCopier]

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)

FlowDefinition

jenkinsdoc:workflow-api:org.jenkinsci.plugins.workflow.flow.FlowDefinition]

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: 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

jenkinsdoc:workflow-api:org.jenkinsci.plugins.workflow.flow.FlowExecutionListener]

Listens for significant status updates for a jenkinsdoc: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

jenkinsdoc:workflow-api:org.jenkinsci.plugins.workflow.visualization.table.FlowNodeViewColumn]

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

Implementations:

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

jenkinsdoc:workflow-api:org.jenkinsci.plugins.workflow.visualization.table.FlowNodeViewColumnDescriptor]

jenkinsdoc:Descriptor] for jenkinsdoc:FlowNodeViewColumn] .

Implementations:

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

jenkinsdoc:workflow-api:org.jenkinsci.plugins.workflow.flow.GraphListener]

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

Implementations:

Atlassian Jira Software Cloud Plugin: com.atlassian.jira.cloud.jenkins.listeners.JenkinsPipelineGraphListener (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)
Micro Focus Application Automation Tools Plugin: com.microfocus.application.automation.tools.octane.vulnerabilities.VulnerabilitiesWorkflowListener (view on GitHub)
Micro Focus 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: Supporting APIs Plugin: Anonymous class in org.jenkinsci.plugins.workflow.support.DefaultStepContext (view on GitHub)

LogStorageFactory

jenkinsdoc:workflow-api:org.jenkinsci.plugins.workflow.log.LogStorageFactory]

Factory interface for jenkinsdoc:LogStorage] .

Implementations:

Pipeline Logging over CloudWatch Plugin: io.jenkins.plugins.pipeline_cloudwatch_logs.PipelineBridge (view on GitHub)

PickleFactory

jenkinsdoc:workflow-api:org.jenkinsci.plugins.workflow.pickles.PickleFactory]

Provides a way of converting transient objects into jenkinsdoc:Pickle] s.

Implementations:

JUnit Realtime Test Reporter Plugin: org.jenkinsci.plugins.junitrealtimetestreporter.RealtimeJUnitStep.Pickler (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

jenkinsdoc:workflow-api:org.jenkinsci.plugins.workflow.flow.StashManager.StashBehavior]

Extension point for customizing behavior of stashes from other plugins.

Implementations:

(no known implementations)

StepListener

jenkinsdoc:workflow-api:org.jenkinsci.plugins.workflow.flow.StepListener]

jenkinsdoc:StepListener] s are fired before invoking a step but after the jenkinsdoc:FlowNode] has been created and the jenkinsdoc:StepContext] has been populated. A jenkinsdoc:StepListener] can perform actions before the jenkinsdoc:Step] is executed, such as calling jenkinsdoc: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)

TaskListenerDecorator.Factory

jenkinsdoc:workflow-api:org.jenkinsci.plugins.workflow.log.TaskListenerDecorator.Factory]

Allows a decorator to be applied to any build.

Implementations:

Datadog Plugin: org.datadog.jenkins.plugins.datadog.logs.DatadogTaskListenerDecorator.Factory (view on GitHub)
Logstash Plugin: jenkins.plugins.logstash.pipeline.GlobalDecorator.Factory (view on GitHub)