au.com.centrumsystems.hudson.plugin.buildpipeline.trigger
Class BuildPipelineTrigger

java.lang.Object
  hudson.tasks.BuildStepCompatibilityLayer
      hudson.tasks.Publisher
          hudson.tasks.Notifier
              au.com.centrumsystems.hudson.plugin.buildpipeline.trigger.BuildPipelineTrigger

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.DependecyDeclarer, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep

public class BuildPipelineTrigger
extends hudson.tasks.Notifier
implements hudson.model.DependecyDeclarer

The build pipeline trigger allows the creation of downstream jobs which aren't triggered automatically. This allows us to have manual "approval" steps in the process where jobs are manually promoted along the pipeline by a user pressing a button on the view.

Author:

Centrum Systems

Nested Class Summary

static class

BuildPipelineTrigger.DescriptorImpl Set the descriptor for build pipeline trigger class This descriptor is only attached to Build Trigger Post Build action in JOB configuration page

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

BuildPipelineTrigger(java.lang.String downstreamProjectNames)
Construct the trigger setting the project name and manual build promotion option

Method Summary

void	buildDependencyGraph(hudson.model.AbstractProject owner, hudson.model.DependencyGraph graph) this method is required to rebuild the dependency graph of the downstream project
java.lang.String	getDownstreamProjectNames()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
boolean	needsToRunAfterFinalized()
boolean	onDownstreamProjectDeleted(java.lang.String oldName) Deletes a project from downstreamProjectNames.
boolean	onDownstreamProjectRenamed(java.lang.String oldName, java.lang.String newName) Renames a project contained in downstreamProjectNames
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
void	setDownstreamProjectNames(java.lang.String downstreamProjectNames)

Methods inherited from class hudson.tasks.Notifier

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, prebuild

Constructor Detail

BuildPipelineTrigger

@DataBoundConstructor
public BuildPipelineTrigger(java.lang.String downstreamProjectNames)

Construct the trigger setting the project name and manual build promotion option

Parameters:

downstreamProjectNames - - the job name of the downstream build

Method Detail

getDownstreamProjectNames

public java.lang.String getDownstreamProjectNames()

setDownstreamProjectNames

public void setDownstreamProjectNames(java.lang.String downstreamProjectNames)

buildDependencyGraph

public void buildDependencyGraph(hudson.model.AbstractProject owner,
                                 hudson.model.DependencyGraph graph)

this method is required to rebuild the dependency graph of the downstream project

Specified by:

buildDependencyGraph in interface hudson.model.DependecyDeclarer

Parameters:

owner - owner

graph - graph

needsToRunAfterFinalized

public boolean needsToRunAfterFinalized()

Overrides:

needsToRunAfterFinalized in class hudson.tasks.Publisher

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws java.lang.InterruptedException,
                       java.io.IOException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

java.lang.InterruptedException

java.io.IOException

onDownstreamProjectRenamed

public boolean onDownstreamProjectRenamed(java.lang.String oldName,
                                          java.lang.String newName)

Renames a project contained in downstreamProjectNames

Parameters:

oldName - - The old name of the project

newName - - The new name of the project

Returns:

- true: A downstream project has been renamed; false No downstream projects were renamed

onDownstreamProjectDeleted

public boolean onDownstreamProjectDeleted(java.lang.String oldName)

Deletes a project from downstreamProjectNames.

Parameters:

oldName - - Project to be deleted

Returns:

- true; project deleted: false; project not deleted onDownstreamProjectRenamed(String, String)