org.jenkinsci.plugins.workflow.multibranch

Class PipelineTriggerProperty

java.lang.Object

hudson.model.AbstractDescribableImpl<com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<?>>

com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<jenkins.branch.MultiBranchProject<?,?>>

org.jenkinsci.plugins.workflow.multibranch.PipelineTriggerProperty

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<?>>, hudson.model.ReconfigurableDescribable<com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<?>>

public class PipelineTriggerProperty
extends com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<jenkins.branch.MultiBranchProject<?,?>>

Job property to enable setting jobs to trigger when a pipeline is created or deleted. In details by this, multi branch pipeline will trigger other job/jobs depending on the configuration. Jobs defined in Pipeline Pre Create Jobs Trigger Field, will be triggered when a new pipeline created by branch indexing. Jobs defined in Pipeline Post Create Jobs Trigger Field, will be triggered when a pipeline is deleted by branch indexing. Jobs defined in the Pipeline Run Delete Jobs Trigger Field will be triggered when a Pipeline run is deleted (either by explicitly deleting the run or the branch in the run.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PipelineTriggerProperty.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.cloudbees.hudson.plugins.folder.AbstractFolderProperty

owner

Constructor Summary

Constructors

Constructor and Description
PipelineTriggerProperty(String createActionJobsToTrigger, String deleteActionJobsToTrigger, String actionJobsToTriggerOnRunDelete, String branchIncludeFilter, String branchExcludeFilter)

Method Summary

Modifier and Type	Method and Description
void	buildActionJobsOnRunDelete(String projectName, String projectFullName, Integer runNumber, String runDisplayName) Build Jobs which are defined in the @actionJobsToTriggerOnRunDelete field.
void	buildCreateActionJobs(String projectName, String projectFullName) Build Jobs which are defined in the @createActionJobsToTrigger field.
void	buildDeleteActionJobs(String projectName, String projectFullName) Build Jobs which are defined in the @deleteActionJobsToTrigger field.
static String	convertToPattern(String wildcardDefinitions)
List<hudson.model.Job>	getActionJobsOnRunDelete() Getter method for @actionJobsOnRunDelete
String	getActionJobsToTriggerOnRunDelete() Getter method for @actionJobsToTriggerOnRunDelete
String	getBranchExcludeFilter()
String	getBranchIncludeFilter()
List<hudson.model.Job>	getCreateActionJobs() Getter method for @createActionJobs
String	getCreateActionJobsToTrigger() Getter method for @createActionJobsToTrigger
List<hudson.model.Job>	getDeleteActionJobs() Getter method for @deleteActionJobs
String	getDeleteActionJobsToTrigger() Getter method for @deleteActionJobsToTrigger
void	setActionJobsOnRunDelete(List<hudson.model.Job> actionJobsOnRunDelete) Setter method for @actionJobsOnRunDelete
void	setActionJobsToTriggerOnRunDelete(String actionJobsToTriggerOnRunDelete) Setter method for @actionJobsToTriggerOnRunDelete Additionally.
void	setBranchExcludeFilter(String branchExcludeFilter)
void	setBranchIncludeFilter(String branchIncludeFilter)
void	setCreateActionJobs(List<hudson.model.Job> createActionJobs) Setter method for @createActionJobs
void	setCreateActionJobsToTrigger(String createActionJobsToTrigger) Setter method for @createActionJobsToTrigger Additionally.
void	setDeleteActionJobs(List<hudson.model.Job> deleteActionJobs) Setter method for @createActionJobs
void	setDeleteActionJobsToTrigger(String deleteActionJobsToTrigger) Setter method for @deleteActionJobsToTrigger Additionally.
static void	triggerActionJobsOnRunDelete(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob, hudson.model.Run<?,?> run)
static void	triggerCreateActionJobs(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)
static void	triggerDeleteActionJobs(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)

Methods inherited from class com.cloudbees.hudson.plugins.folder.AbstractFolderProperty

getDescriptor, getHealthMetrics, getHealthReports, getItemContainerOverrides, getOwner, reconfigure, setOwner

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineTriggerProperty

@DataBoundConstructor
public PipelineTriggerProperty(String createActionJobsToTrigger,
                                                     String deleteActionJobsToTrigger,
                                                     String actionJobsToTriggerOnRunDelete,
                                                     String branchIncludeFilter,
                                                     String branchExcludeFilter)

Parameters:

createActionJobsToTrigger - Full names of the jobs in comma separated format which are defined in the field

deleteActionJobsToTrigger - Full names of the jobs in comma separated format which are defined in the field

actionJobsToTriggerOnRunDelete - Full names of the jobs in comma separated format which are defined in the field

See Also:

DataBoundConstructor

Method Detail

getCreateActionJobsToTrigger

public String getCreateActionJobsToTrigger()

Getter method for @createActionJobsToTrigger

Returns:

Full names of the jobs in comma separated format

setCreateActionJobsToTrigger

@DataBoundSetter
public void setCreateActionJobsToTrigger(String createActionJobsToTrigger)

Setter method for @createActionJobsToTrigger Additionally. this methods parses job names from @createActionJobsToTrigger, convert to List of Job and store in @createActionJobs for later use.

Parameters:

createActionJobsToTrigger - Full names of the jobs in comma separated format which are defined in the field

getDeleteActionJobsToTrigger

public String getDeleteActionJobsToTrigger()

Getter method for @deleteActionJobsToTrigger

Returns:

Full names of the jobs in comma-separated format

setDeleteActionJobsToTrigger

@DataBoundSetter
public void setDeleteActionJobsToTrigger(String deleteActionJobsToTrigger)

Setter method for @deleteActionJobsToTrigger Additionally. this methods parses job names from @deleteActionJobsToTrigger, convert to List of Job and store in @deleteActionJobs for later use.

Parameters:

deleteActionJobsToTrigger - Full names of the jobs in comma-separated format which are defined in the field

getActionJobsToTriggerOnRunDelete

public String getActionJobsToTriggerOnRunDelete()

Getter method for @actionJobsToTriggerOnRunDelete

Returns:

Full names of the jobs in comma-separated format

setActionJobsToTriggerOnRunDelete

@DataBoundSetter
public void setActionJobsToTriggerOnRunDelete(String actionJobsToTriggerOnRunDelete)

Setter method for @actionJobsToTriggerOnRunDelete Additionally. this methods parses job names from @actionJobsToTriggerOnRunDelete, convert to List of Job and store in @actionJobsOnRunDelete for later use.

Parameters:

actionJobsToTriggerOnRunDelete - Full names of the jobs in comma-separated format which are defined in the field

getCreateActionJobs

public List<hudson.model.Job> getCreateActionJobs()

Getter method for @createActionJobs

Returns:

List of Job for Pre Action

setCreateActionJobs

public void setCreateActionJobs(List<hudson.model.Job> createActionJobs)

Setter method for @createActionJobs

Parameters:

createActionJobs - List of Job for Pre Action

getDeleteActionJobs

public List<hudson.model.Job> getDeleteActionJobs()

Getter method for @deleteActionJobs

Returns:

List of Job for Post Action

setDeleteActionJobs

public void setDeleteActionJobs(List<hudson.model.Job> deleteActionJobs)

Setter method for @createActionJobs

Parameters:

deleteActionJobs - List of Job for Post Action

getActionJobsOnRunDelete

public List<hudson.model.Job> getActionJobsOnRunDelete()

Getter method for @actionJobsOnRunDelete

Returns:

List of Job for Run Delete Action

setActionJobsOnRunDelete

public void setActionJobsOnRunDelete(List<hudson.model.Job> actionJobsOnRunDelete)

Setter method for @actionJobsOnRunDelete

Parameters:

actionJobsOnRunDelete - List of Job for Run Delete Action

buildCreateActionJobs

public void buildCreateActionJobs(String projectName,
                                  String projectFullName)

Build Jobs which are defined in the @createActionJobsToTrigger field.

Parameters:

projectName - Name of the project. This will be branch name which is found in branch indexing. Also this value will be passed as StringParameterDefinition

projectFullName - Full name of the project. Also this value will be passed as StringParameterDefinition

buildDeleteActionJobs

public void buildDeleteActionJobs(String projectName,
                                  String projectFullName)

Build Jobs which are defined in the @deleteActionJobsToTrigger field.

Parameters:

projectName - Name of the project. This will be branch name which is found in branch indexing. Also this value will be passed as StringParameterDefinition

projectFullName - Full name of the project. Also this value will be passed as StringParameterDefinition

buildActionJobsOnRunDelete

public void buildActionJobsOnRunDelete(String projectName,
                                       String projectFullName,
                                       Integer runNumber,
                                       String runDisplayName)

Build Jobs which are defined in the @actionJobsToTriggerOnRunDelete field.

Parameters:

projectName - Name of the project. This will be branch name which is found in branch indexing. Also this value will be passed as StringParameterDefinition

projectFullName - Full name of the project. Also this value will be passed as StringParameterDefinition

runNumber - Number of the upstream build. This value will be passed as StringParameterDefinition.

runDisplayName - Display Name of the upstream build. This value will be passed as StringParameterDefinition.

triggerDeleteActionJobs

public static void triggerDeleteActionJobs(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)

triggerCreateActionJobs

public static void triggerCreateActionJobs(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)

triggerActionJobsOnRunDelete

public static void triggerActionJobsOnRunDelete(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob,
                                                hudson.model.Run<?,?> run)

getBranchIncludeFilter

public String getBranchIncludeFilter()

setBranchIncludeFilter

@DataBoundSetter
public void setBranchIncludeFilter(String branchIncludeFilter)

getBranchExcludeFilter

public String getBranchExcludeFilter()

setBranchExcludeFilter

@DataBoundSetter
public void setBranchExcludeFilter(String branchExcludeFilter)

convertToPattern

public static String convertToPattern(String wildcardDefinitions)