io.jenkins.jenkinsfile.runner

Class PipelineDefinitionProvider

java.lang.Object

io.jenkins.jenkinsfile.runner.PipelineDefinitionProvider

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

PipelineAsYAMLDefinitionProvider, TemplatingEnginePipelineDefinitionProvider

@Restricted(value=org.kohsuke.accmod.restrictions.Beta.class)
public abstract class PipelineDefinitionProvider
extends Object
implements hudson.ExtensionPoint

Allows specifying custom Runner implementations

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
PipelineDefinitionProvider()

Method Summary

Modifier and Type	Method and Description
static hudson.ExtensionList<PipelineDefinitionProvider>	all() Get all extension instances.
abstract void	instrumentJob(org.jenkinsci.plugins.workflow.job.WorkflowJob job, io.jenkins.jenkinsfile.runner.bootstrap.commands.PipelineRunOptions args) Configures the Pipeline job.
abstract boolean	matches(io.jenkins.jenkinsfile.runner.bootstrap.commands.PipelineRunOptions options) Check whether the extension point can provide a Pipeline for the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineDefinitionProvider

public PipelineDefinitionProvider()

Method Detail

matches

public abstract boolean matches(io.jenkins.jenkinsfile.runner.bootstrap.commands.PipelineRunOptions options)

Check whether the extension point can provide a Pipeline for the request.

Parameters:

options - run options

Returns:

true if the extension can produce the Pipeline definition

instrumentJob

public abstract void instrumentJob(org.jenkinsci.plugins.workflow.job.WorkflowJob job,
                                   io.jenkins.jenkinsfile.runner.bootstrap.commands.PipelineRunOptions args)
                            throws Exception

Configures the Pipeline job. Can be overridden if there is no need to update the entire Pipeline. The extension may pass additional configurations and actions.

Parameters:

job - Job to be updated

Throws:

Exception - modification failed

all

public static hudson.ExtensionList<PipelineDefinitionProvider> all()

Get all extension instances.