org.jenkinsci.plugins.workflow.multibranch.extended

Class RemoteJenkinsFileWorkflowMultiBranchProjectFactory

java.lang.Object

hudson.model.AbstractDescribableImpl<jenkins.branch.MultiBranchProjectFactory>

jenkins.branch.MultiBranchProjectFactory

jenkins.branch.MultiBranchProjectFactory.BySCMSourceCriteria

org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowMultiBranchProjectFactory

org.jenkinsci.plugins.workflow.multibranch.extended.RemoteJenkinsFileWorkflowMultiBranchProjectFactory

All Implemented Interfaces:

ExtensionPoint, Describable<jenkins.branch.MultiBranchProjectFactory>

public class RemoteJenkinsFileWorkflowMultiBranchProjectFactory
extends org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowMultiBranchProjectFactory

This class extends @AbstractWorkflowMultiBranchProjectFactory to inject defined Jenkins file and repository in Remote Jenkins File Plugin

Author:

Julien Roy, julien.vanroy@gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteJenkinsFileWorkflowMultiBranchProjectFactory.DescriptorImpl Descriptor Implementation for @RemoteJenkinsFileWorkflowMultiBranchProjectFactory

Nested classes/interfaces inherited from class org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowMultiBranchProjectFactory

org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowMultiBranchProjectFactory.PerFolderAdder

Nested classes/interfaces inherited from class jenkins.branch.MultiBranchProjectFactory

jenkins.branch.MultiBranchProjectFactory.BySCMSourceCriteria

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
RemoteJenkinsFileWorkflowMultiBranchProjectFactory(String localFile, String remoteJenkinsFile, SCM remoteJenkinsFileSCM, Boolean matchBranches) Jenkins @DataBoundConstructor

Method Summary

Modifier and Type	Method and Description
protected void	customize(org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProject project)
String	getLocalFile() Default getter method
boolean	getMatchBranches() Default getter method
String	getRemoteJenkinsFile() Default getter method
SCM	getRemoteJenkinsFileSCM() Default getter method
String	getScmSourceBranchName() Default getter method
protected jenkins.scm.api.SCMSourceCriteria	getSCMSourceCriteria(jenkins.scm.api.SCMSource source) Extends @WorkflowBranchProjectFactory
void	setLocalFileForReconize(String localFileForRecognize) Jenkins @DataBoundSetter
void	setMatchBranches(boolean matchBranches) Jenkins @DataBoundSetter
void	setRemoteJenkinsFile(String remoteJenkinsFile) Jenkins @DataBoundSetter
void	setRemoteJenkinsFileSCM(SCM remoteJenkinsFileSCM) Jenkins @DataBoundSetter
void	setScmSourceBranchName(String scmSourceBranchName) Set @this.scmSourceBranchName to be used in new scm definition with new branch name

Methods inherited from class org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowMultiBranchProjectFactory

doCreateProject, updateExistingProject

Methods inherited from class jenkins.branch.MultiBranchProjectFactory.BySCMSourceCriteria

createNewProject, recognizes, recognizes

Methods inherited from class jenkins.branch.MultiBranchProjectFactory

createProject

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteJenkinsFileWorkflowMultiBranchProjectFactory

@DataBoundConstructor
public RemoteJenkinsFileWorkflowMultiBranchProjectFactory(String localFile,
                                                                                String remoteJenkinsFile,
                                                                                SCM remoteJenkinsFileSCM,
                                                                                Boolean matchBranches)

Jenkins @DataBoundConstructor

Parameters:

remoteJenkinsFile - path of the Jenkinsfile

remoteJenkinsFileSCM - @SCM definition for the Jenkinsfile

Method Detail

setRemoteJenkinsFile

@DataBoundSetter
public void setRemoteJenkinsFile(String remoteJenkinsFile)

Jenkins @DataBoundSetter

Parameters:

remoteJenkinsFile - path of the Jenkinsfile

setRemoteJenkinsFileSCM

@DataBoundSetter
public void setRemoteJenkinsFileSCM(SCM remoteJenkinsFileSCM)

Jenkins @DataBoundSetter

Parameters:

remoteJenkinsFileSCM - @SCM definition for the Jenkinsfile

setLocalFileForReconize

@DataBoundSetter
public void setLocalFileForReconize(String localFileForRecognize)

Jenkins @DataBoundSetter

Parameters:

localFileForRecognize - file to search in local repository to activate build ( can be null )

getSCMSourceCriteria

protected jenkins.scm.api.SCMSourceCriteria getSCMSourceCriteria(jenkins.scm.api.SCMSource source)

Extends @WorkflowBranchProjectFactory

Specified by:

getSCMSourceCriteria in class jenkins.branch.MultiBranchProjectFactory.BySCMSourceCriteria

Parameters:

source - @SCMSource

Returns:

@SCMSourceCriteria

getRemoteJenkinsFile

public String getRemoteJenkinsFile()

Default getter method

Returns:

@this.remoteJenkinsFile

getRemoteJenkinsFileSCM

public SCM getRemoteJenkinsFileSCM()

Default getter method

Returns:

@this.remoteJenkinsFile

getLocalFile

public String getLocalFile()

Default getter method

Returns:

@this.localFile

customize

protected void customize(org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProject project)

Overrides:

customize in class org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowMultiBranchProjectFactory

setMatchBranches

@DataBoundSetter
public void setMatchBranches(boolean matchBranches)

Jenkins @DataBoundSetter

Parameters:

matchBranches - True to enable match branches feature

getMatchBranches

public boolean getMatchBranches()

Default getter method

Returns:

@this.matchBranches

setScmSourceBranchName

public void setScmSourceBranchName(String scmSourceBranchName)

Set @this.scmSourceBranchName to be used in new scm definition with new branch name

Parameters:

scmSourceBranchName - Current branch name which MultiBranch pipeline working on.

getScmSourceBranchName

public String getScmSourceBranchName()

Default getter method

Returns:

@this.scmSourceBranchName