Class 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
    • Constructor Detail

      • RemoteJenkinsFileWorkflowMultiBranchProjectFactory

        @DataBoundConstructor
        public RemoteJenkinsFileWorkflowMultiBranchProjectFactory​(String localMarker,
                                                                  String remoteJenkinsFile,
                                                                  SCM remoteJenkinsFileSCM,
                                                                  Boolean matchBranches,
                                                                  Boolean lookupInParameters)
        Jenkins DataBoundConstructor
        Parameters:
        remoteJenkinsFile - path of the Jenkinsfile
        remoteJenkinsFileSCM - SCM definition for the Jenkinsfile
    • Method Detail

      • getLookupInParameters

        public Boolean getLookupInParameters()
      • setLookupInParameters

        @DataBoundSetter
        public void setLookupInParameters​(Boolean lookupInParameters)
      • 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
      • setLocalMarkerForReconize

        @DataBoundSetter
        public void setLocalMarkerForReconize​(String localMarkerForRecognize)
        Jenkins DataBoundSetter
        Parameters:
        localMarkerForRecognize - file to search in local repository to activate build ( can be null )
      • getSCMSourceCriteria

        protected jenkins.scm.api.SCMSourceCriteria getSCMSourceCriteria​(@NonNull
                                                                         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:
        remoteJenkinsFile
      • getRemoteJenkinsFileSCM

        public SCM getRemoteJenkinsFileSCM()
        Default getter method
        Returns:
        remoteJenkinsFile
      • getLocalMarker

        public String getLocalMarker()
        Default getter method
        Returns:
        localMarker
      • 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:
        matchBranches
      • setScmSourceBranchName

        public void setScmSourceBranchName​(String scmSourceBranchName)
        Set scmSourceBranchName to be used in new scm definition with new branch nameLocal
        Parameters:
        scmSourceBranchName - Current branch name which MultiBranch pipeline working on.
      • getScmSourceBranchName

        public String getScmSourceBranchName()
        Default getter method
        Returns:
        scmSourceBranchName
      • getFallbackBranch

        public String getFallbackBranch()
      • setFallbackBranch

        @DataBoundSetter
        public void setFallbackBranch​(String fallbackBranch)