Package se.diabol.jenkins.pipeline.source

Class ComponentSource

java.lang.Object

se.diabol.jenkins.pipeline.source.ComponentSource

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

FlowComponentSource, FreestyleComponentSource

public abstract class ComponentSource
extends Object
implements ExtensionPoint

Builds the model of a component from a kind of job: a chain of jobs with downstream dependencies, or a Pipeline job. The first source that supports a job owns it, in extension order.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ComponentSource()

Method Summary

Modifier and Type	Method	Description
void	abort(Job<?,?> job, int buildNumber)	Stops the build with the given number.
static ExtensionList<ComponentSource>	all()
static ComponentSource	forJob(Job<?,?> job)	The source that owns the job.
Pipeline	instance(Job<?,?> firstJob, Job<?,?> lastJob, int buildNumber, ViewSettings settings)	The pipeline instance that the build of the first job with the given number started, as resolve(se.diabol.jenkins.pipeline.source.ComponentRequest) would show it, whatever page it is on; null when there is no such build or the source cannot tell.
abstract Collection<? extends Job<?,?>>	jobsOf(Job<?,?> firstJob, Job<?,?> lastJob)	The jobs that make up the component, which the view lists as its items.
void	proceedInput(Job<?,?> job, int buildNumber)	Lets the build with the given number continue past the input step it is waiting at.
void	proceedInput(Job<?,?> job, int buildNumber, String task)	Lets the build continue past the input step the task with the given id is waiting at, or past the first one when no task is named or the source does not tell them apart.
void	rebuild(Job<?,?> job, int buildNumber)	Schedules a build of the job like the one with the given number: same causes and parameters.
void	rebuild(Job<?,?> job, int buildNumber, String stage)	Rebuilds as rebuild(Job, int) does, or when a stage is named, restarts the build from that stage where the kind of job supports it.
abstract Component	resolve(ComponentRequest request)	Builds the component; a failure is reported to the user as the component's error.
abstract boolean	supports(Job<?,?> job)	Whether this source knows how to build a component starting at the given job.
void	triggerManual(Job<?,?> job, Job<?,?> upstream, int upstreamBuild, ItemGroup<? extends TopLevelItem> context)	Performs the manual trigger of the job, continuing from the given build of the upstream job.

Methods inherited from class java.lang.Object

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

Constructor Details

ComponentSource

public ComponentSource()

Method Details

supports

public abstract boolean supports(Job<?,?> job)

Whether this source knows how to build a component starting at the given job.

resolve

public abstract Component resolve(ComponentRequest request)
                           throws PipelineException

Builds the component; a failure is reported to the user as the component's error.

Throws:

PipelineException

jobsOf

public abstract Collection<? extends Job<?,?>> jobsOf(Job<?,?> firstJob,
 Job<?,?> lastJob)

The jobs that make up the component, which the view lists as its items.

instance

public Pipeline instance(Job<?,?> firstJob,
 Job<?,?> lastJob,
 int buildNumber,
 ViewSettings settings)
                  throws PipelineException

The pipeline instance that the build of the first job with the given number started, as resolve(se.diabol.jenkins.pipeline.source.ComponentRequest) would show it, whatever page it is on; null when there is no such build or the source cannot tell. The consolidated pipeline of a view asks for it to find out whether a pipeline it started has come to an end.

Throws:

PipelineException

rebuild

public void rebuild(Job<?,?> job,
 int buildNumber)
             throws PipelineException

Schedules a build of the job like the one with the given number: same causes and parameters.

Throws:

PipelineException

rebuild

public void rebuild(Job<?,?> job,
 int buildNumber,
 String stage)
             throws PipelineException

Rebuilds as rebuild(Job, int) does, or when a stage is named, restarts the build from that stage where the kind of job supports it.

Throws:

PipelineException

abort

public void abort(Job<?,?> job,
 int buildNumber)
           throws PipelineException

Stops the build with the given number.

Throws:

PipelineException

triggerManual

public void triggerManual(Job<?,?> job,
 Job<?,?> upstream,
 int upstreamBuild,
 ItemGroup<? extends TopLevelItem> context)
                   throws PipelineException

Performs the manual trigger of the job, continuing from the given build of the upstream job.

Throws:

PipelineException

proceedInput

public void proceedInput(Job<?,?> job,
 int buildNumber)
                  throws PipelineException

Lets the build with the given number continue past the input step it is waiting at.

Throws:

PipelineException

proceedInput

public void proceedInput(Job<?,?> job,
 int buildNumber,
 String task)
                  throws PipelineException

Lets the build continue past the input step the task with the given id is waiting at, or past the first one when no task is named or the source does not tell them apart.

Throws:

PipelineException

all

public static ExtensionList<ComponentSource> all()

forJob

public static ComponentSource forJob(Job<?,?> job)
                              throws PipelineException

The source that owns the job.

Throws:

PipelineException