org.jenkinsci.plugins.workflow.multibranch.extended

Class RemoteJenkinsFileWorkflowBranchProjectFactory

java.lang.Object

hudson.model.AbstractDescribableImpl<jenkins.branch.BranchProjectFactory<?,?>>

jenkins.branch.BranchProjectFactory<org.jenkinsci.plugins.workflow.job.WorkflowJob,org.jenkinsci.plugins.workflow.job.WorkflowRun>

org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowBranchProjectFactory

org.jenkinsci.plugins.workflow.multibranch.WorkflowBranchProjectFactory

org.jenkinsci.plugins.workflow.multibranch.extended.RemoteJenkinsFileWorkflowBranchProjectFactory

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<jenkins.branch.BranchProjectFactory<?,?>>, hudson.model.Saveable

public class RemoteJenkinsFileWorkflowBranchProjectFactory
extends org.jenkinsci.plugins.workflow.multibranch.WorkflowBranchProjectFactory

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

Author:

Aytunc BEKEN, aytuncbeken.ab@gmail.com

Nested Class Summary

Nested Classes

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

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

org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowBranchProjectFactory.AbstractWorkflowBranchProjectFactoryDescriptor

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

jenkins.branch.BranchProjectFactory.HeadByItemImpl, jenkins.branch.BranchProjectFactory.SourceByItemImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
RemoteJenkinsFileWorkflowBranchProjectFactory(String remoteJenkinsFile, String localFile, hudson.scm.SCM remoteJenkinsFileSCM, boolean matchBranches, String fallbackBranch) Jenkins @DataBoundConstructor

Method Summary

Modifier and Type	Method and Description
protected org.jenkinsci.plugins.workflow.flow.FlowDefinition	createDefinition() Extends @WorkflowBranchProjectFactory
String	getFallbackBranch()
String	getLocalFile() Default getter method
boolean	getMatchBranches() Default getter method
String	getRemoteJenkinsFile() Default getter method
hudson.scm.SCM	getRemoteJenkinsFileSCM() Default getter method
String	getScmSourceBranchName() Default getter method
protected jenkins.scm.api.SCMSourceCriteria	getSCMSourceCriteria(jenkins.scm.api.SCMSource source) Extends @WorkflowBranchProjectFactory
void	setFallbackBranch(String fallbackBranch)
void	setMatchBranches(boolean matchBranches) Jenkins @DataBoundSetter
void	setRemoteJenkinsFile(String remoteJenkinsFile) Jenkins @DataBoundSetter
void	setRemoteJenkinsFileSCM(hudson.scm.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.WorkflowBranchProjectFactory

getScriptPath, readResolve, setScriptPath

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

getBranch, isProject, newInstance, setBranch

Methods inherited from class jenkins.branch.BranchProjectFactory

asProject, decorate, getDescriptor, getOwner, getProjectClass, getRevision, save, setOwner, setRevisionHash

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteJenkinsFileWorkflowBranchProjectFactory

@DataBoundConstructor
public RemoteJenkinsFileWorkflowBranchProjectFactory(String remoteJenkinsFile,
                                                                           String localFile,
                                                                           hudson.scm.SCM remoteJenkinsFileSCM,
                                                                           boolean matchBranches,
                                                                           String fallbackBranch)

Jenkins @DataBoundConstructor

Parameters:

localFile - path of an arbitrary local file which must be present for the project to be recognised

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(hudson.scm.SCM remoteJenkinsFileSCM)

Jenkins @DataBoundSetter

Parameters:

remoteJenkinsFileSCM - @SCM definition for the Jenkinsfile

createDefinition

protected org.jenkinsci.plugins.workflow.flow.FlowDefinition createDefinition()

Extends @WorkflowBranchProjectFactory

Overrides:

createDefinition in class org.jenkinsci.plugins.workflow.multibranch.WorkflowBranchProjectFactory

Returns:

@FlowDefinition

getSCMSourceCriteria

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

Extends @WorkflowBranchProjectFactory

Overrides:

getSCMSourceCriteria in class org.jenkinsci.plugins.workflow.multibranch.WorkflowBranchProjectFactory

Parameters:

source - @SCMSource

Returns:

@SCMSourceCriteria

getRemoteJenkinsFile

public String getRemoteJenkinsFile()

Default getter method

Returns:

@this.remoteJenkinsFile

getRemoteJenkinsFileSCM

public hudson.scm.SCM getRemoteJenkinsFileSCM()

Default getter method

Returns:

@this.remoteJenkinsFile

getLocalFile

public String getLocalFile()

Default getter method

Returns:

@this.localFile

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

getFallbackBranch

public String getFallbackBranch()

setFallbackBranch

@DataBoundSetter
public void setFallbackBranch(String fallbackBranch)