jenkins.triggers

Class ReverseBuildTrigger

java.lang.Object

hudson.triggers.Trigger<Job>

jenkins.triggers.ReverseBuildTrigger

All Implemented Interfaces:

ExtensionPoint, Describable<Trigger<?>>, DependencyDeclarer

public final class ReverseBuildTrigger
extends Trigger<Job>
implements DependencyDeclarer

Like BuildTrigger but defined on the downstream project. Operates via BuildTrigger.execute(hudson.model.AbstractBuild, hudson.model.BuildListener, hudson.tasks.BuildTrigger) and DependencyGraph, so run implicitly at the end of the upstream build, when used on a pair of AbstractProjects. Otherwise directly listens for the upstream build to complete.

Since:

1.560

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReverseBuildTrigger.DescriptorImpl
static class	ReverseBuildTrigger.ItemListenerImpl
static class	ReverseBuildTrigger.RunListenerImpl

Nested classes/interfaces inherited from class hudson.triggers.Trigger

Trigger.Cron

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.triggers.Trigger

CRON_THRESHOLD, job, spec, tabs, timer

Constructor Summary

Constructors

Constructor and Description
ReverseBuildTrigger(String upstreamProjects)
ReverseBuildTrigger(String upstreamProjects, Result threshold) Deprecated. use ReverseBuildTrigger(String) and setThreshold(Result)

Method Summary

Modifier and Type	Method and Description
void	buildDependencyGraph(AbstractProject downstream, DependencyGraph graph) Invoked from AbstractProject.buildDependencyGraph(DependencyGraph).
Result	getThreshold()
String	getUpstreamProjects() Gets the upstream projects.
void	setThreshold(Result r)
void	start(Job project, boolean newInstance) Called when a Trigger is loaded into memory and started.
void	stop() Called before a Trigger is removed.

Methods inherited from class hudson.triggers.Trigger

all, checkTriggers, for_, getDescriptor, getProjectAction, getProjectActions, getSpec, readResolve, run

Methods inherited from class java.lang.Object

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

Constructor Detail

ReverseBuildTrigger

@Deprecated
public ReverseBuildTrigger(String upstreamProjects,
                                       Result threshold)

Deprecated. use ReverseBuildTrigger(String) and setThreshold(Result)

Legacy constructor used before threshold was moved to a @DataBoundSetter. Kept around for binary compatibility.

ReverseBuildTrigger

@DataBoundConstructor
public ReverseBuildTrigger(String upstreamProjects)

Method Detail

getUpstreamProjects

public String getUpstreamProjects()

Gets the upstream projects.

Returns:

Upstream projects or empty("") if upstream projects is null.

getThreshold

public Result getThreshold()

setThreshold

@DataBoundSetter
public void setThreshold(Result r)

buildDependencyGraph

public void buildDependencyGraph(AbstractProject downstream,
                                 DependencyGraph graph)

Description copied from interface: DependencyDeclarer

Invoked from AbstractProject.buildDependencyGraph(DependencyGraph).

Specified by:

buildDependencyGraph in interface DependencyDeclarer

Parameters:

downstream - The project that owns the publishers, builders, etc. This information is conceptually redundant, as those objects are only configured against the single owner, but this information is nevertheless passed in since often owner information is not recorded. Never null.

graph - The dependency graph being built. Never null.

start

public void start(@NonNull
                  Job project,
                  boolean newInstance)

Description copied from class: Trigger

Called when a Trigger is loaded into memory and started.

Overrides:

start in class Trigger<Job>

Parameters:

project - given so that the persisted form of this object won't have to have a back pointer.

newInstance - True if this may be a newly created trigger first attached to the Project (generally if the project is being created or configured). False if this is invoked for a Project loaded from disk.

See Also:

Items.currentlyUpdatingByXml()

stop

public void stop()

Description copied from class: Trigger

Called before a Trigger is removed. Under some circumstances, this may be invoked more than once for a given Trigger, so be prepared for that.

When the configuration is changed for a project, all triggers are removed once and then added back.

Overrides:

stop in class Trigger<Job>