Package org.jenkinsci.plugins.workflow.multibranch.extended.scm

Class ExtendedSCMBinder

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.flow.FlowDefinition>

org.jenkinsci.plugins.workflow.flow.FlowDefinition

org.jenkinsci.plugins.workflow.multibranch.extended.scm.ExtendedSCMBinder

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.flow.FlowDefinition>

public class ExtendedSCMBinder
extends org.jenkinsci.plugins.workflow.flow.FlowDefinition

This class consist of necessary methods for binding another Jenkins file from another repository to Multibranch pipeline.

Author:

Aytunc BEKEN, aytuncbeken.ab@gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExtendedSCMBinder.DescriptorImpl	Descriptor Implementation for FlowDefinitionDescriptor.
static class	ExtendedSCMBinder.HideMe	This method hides Remote Jenkins Plugin from other Pipeline Jobs and make visible to only MultiBranch Pipeline

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ExtendedSCMBinder(String remoteJenkinsFile, SCM remoteJenkinsFileSCM, String scmSourceBranchName, boolean matchBranches, String fallbackBranch, String originJenkinsFileDefinition, Boolean lookupInParameters, String localMarker)	Constructor for the class.

Method Summary

Modifier and Type	Method	Description
org.jenkinsci.plugins.workflow.flow.FlowExecution	create(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner handle, TaskListener listener, List<? extends Action> actions)	Overwrites create method of FlowDefinition class.
String	getLocalMarker()
String	getRemoteJenkinsFile()
String	getRemoteJenkinsFileBranch()
SCM	getRemoteJenkinsFileSCM()
boolean	isMatchBranches()

Methods inherited from class org.jenkinsci.plugins.workflow.flow.FlowDefinition

create, getDescriptor, getSCMs

Methods inherited from class java.lang.Object

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

Constructor Details

ExtendedSCMBinder

public ExtendedSCMBinder(String remoteJenkinsFile,
 SCM remoteJenkinsFileSCM,
 String scmSourceBranchName,
 boolean matchBranches,
 String fallbackBranch,
 String originJenkinsFileDefinition,
 Boolean lookupInParameters,
 String localMarker)

Constructor for the class.

Parameters:

remoteJenkinsFile - Path of the remote jenkins file from Remote Jenkins File Plugin descriptor

remoteJenkinsFileSCM - SCM definition from Remote Jenkins File Plugin descriptor

Method Details

create

public org.jenkinsci.plugins.workflow.flow.FlowExecution create(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner handle,
 TaskListener listener,
 List<? extends Action> actions)
                                                         throws Exception

Overwrites create method of FlowDefinition class. This methods sets the defined Jenkins file and defined SCM on Remote Jenkins Plugin to Pipeline job which will be created by MultiBranch Pipeline.

Overrides:

create in class org.jenkinsci.plugins.workflow.flow.FlowDefinition

Parameters:

handle - FlowExecutionOwner

listener - TaskListener

actions - List of Action

Returns:

FlowExecution

Throws:

Exception

getRemoteJenkinsFileSCM

public SCM getRemoteJenkinsFileSCM()

getRemoteJenkinsFile

public String getRemoteJenkinsFile()

getRemoteJenkinsFileBranch

public String getRemoteJenkinsFileBranch()

isMatchBranches

public boolean isMatchBranches()

getLocalMarker

public String getLocalMarker()