jenkins.branch

Class MultiBranchProject<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem,R extends hudson.model.Run<P,R>>

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.AbstractItem

com.cloudbees.hudson.plugins.folder.AbstractFolder<I>

com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<P>

jenkins.branch.MultiBranchProject<P,R>

Type Parameters:

P - the project type

R - the run type

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.BuildableItem, hudson.model.Describable<hudson.model.TopLevelItem>, hudson.model.DescriptorByNameOwner, hudson.model.Item, hudson.model.ItemGroup<P>, hudson.model.ModelObject, hudson.model.ModifiableViewGroup, hudson.model.PersistenceRoot, hudson.model.Queue.FlyweightTask, hudson.model.queue.SubTask, hudson.model.Queue.Task, hudson.model.ResourceActivity, hudson.model.Saveable, hudson.model.TopLevelItem, hudson.model.ViewGroup, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, jenkins.model.ModelObjectWithChildren, jenkins.model.ModelObjectWithContextMenu, jenkins.scm.api.SCMSourceOwner, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerFallback, org.kohsuke.stapler.StaplerOverridable

public abstract class MultiBranchProject<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem,R extends hudson.model.Run<P,R>>
extends com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<P>
implements jenkins.scm.api.SCMSourceOwner

Abstract base class for multiple-branch based projects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiBranchProject.BranchIndexing<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem,R extends hudson.model.Run<P,R>> Represents the branch indexing job.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

jenkins.model.ModelObjectWithContextMenu.ContextMenu, jenkins.model.ModelObjectWithContextMenu.ContextMenuVisibility, jenkins.model.ModelObjectWithContextMenu.MenuItem

Field Summary

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

items

Fields inherited from class hudson.model.AbstractItem

description, displayName, name, PRONOUN

Fields inherited from interface hudson.model.Item

BUILD, CANCEL, CONFIGURE, CREATE, DELETE, DISCOVER, EXTENDED_READ, PERMISSIONS, READ, WIPEOUT, WORKSPACE

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultiBranchProject(hudson.model.ItemGroup parent, String name) Constructor, mandated by TopLevelItem.

Method Summary

Modifier and Type	Method and Description
protected void	computeChildren(com.cloudbees.hudson.plugins.folder.computed.ChildObserver<P> observer, hudson.model.TaskListener listener)
protected com.cloudbees.hudson.plugins.folder.computed.FolderComputation<P>	createComputation(com.cloudbees.hudson.plugins.folder.computed.FolderComputation<P> previous)
hudson.security.ACL	getACL()
P	getBranch(String name) Deprecated. use getItem(String) or AbstractFolder.getJob(String) directly
BranchPropertyStrategy	getBranchPropertyStrategy(jenkins.scm.api.SCMSource source) Returns the BranchPropertyStrategy for a specific SCMSource.
File	getComputationDir() Returns the directory that branch indexing is stored in.
MultiBranchProjectDescriptor	getDescriptor()
MultiBranchProject.BranchIndexing<P,R>	getIndexing() Returns the current/most recent indexing details.
P	getItem(String name) Returns the named child job or null if no such job exists.
File	getJobsDir() Returns the directory that all branches are stored in.
hudson.model.View	getPrimaryView()
BranchProjectFactory<P,R>	getProjectFactory() Returns the BranchProjectFactory.
File	getRootDirFor(P child)
jenkins.scm.api.SCMSource	getSCMSource(String sourceId)
jenkins.scm.api.SCMSourceCriteria	getSCMSourceCriteria(jenkins.scm.api.SCMSource source)
List<jenkins.scm.api.SCMSource>	getSCMSources()
List<BranchSource>	getSources() The sources of branches.
hudson.util.PersistedList<BranchSource>	getSourcesList() Offers direct access to the configurable list of branch sources.
hudson.model.View	getView(String name)
protected hudson.model.View	getWelcomeView() Creates a place holder view when there's no active branch indexed.
boolean	isBuildable()
protected abstract BranchProjectFactory<P,R>	newProjectFactory() Creates a new instance of the default project factory to be used for a new instance of the project type.
void	onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent, String name)
void	onSCMSourceUpdated(jenkins.scm.api.SCMSource source)
protected Collection<P>	orphanedItems(Collection<P> orphaned, hudson.model.TaskListener listener)
static String	rawDecode(String s) Inverse function of Util.rawEncode(String)
void	setProjectFactory(BranchProjectFactory<P,R> projectFactory) Sets the BranchProjectFactory.
protected void	submit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)

Methods inherited from class com.cloudbees.hudson.plugins.folder.computed.ComputedFolder

addTrigger, checkAbortPermission, createExecutable, doBuild, doConfigSubmit, getActions, getAssignedLabel, getCauseOfBlockage, getComputation, getDefaultAuthentication, getDefaultAuthentication, getEstimatedDuration, getLastBuiltOn, getOrphanedItemStrategy, getOrphanedItemStrategyDescriptors, getOwnerTask, getResourceList, getSameNodeConstraint, getSubTasks, getSuccessfulDestination, getTriggers, getWhyBlocked, hasAbortPermission, init, isBuildBlocked, isConcurrentBuild, renameBlocker, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild2, setOrphanedItemStrategy

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

addAction, addProperty, addView, canDelete, deleteView, doChildrenContextMenu, doCreateView, doDoRename, doLastBuild, doSubmitDescription, doViewExistsCheck, getAllJobs, getBuildHealth, getBuildHealthReports, getHealthMetrics, getIcon, getIconColor, getItemGroup, getItems, getJob, getOverrides, getPronoun, getProperties, getRootDirFor, getStaplerFallback, getUrlChildPrefix, getViewActions, getViews, getViewsTabBar, initViews, loadJobTotal, makeSearchIndex, onDeleted, onRenamed, onViewRenamed, performDelete, renameTo, replaceAction, save, setIcon, setPrimaryView

Methods inherited from class hudson.model.AbstractItem

checkPermission, delete, delete, doConfigDotXml, doDoDelete, doReload, doSetName, getAbsoluteUrl, getApi, getConfigFile, getDescription, getDescriptorByName, getDisplayName, getDisplayNameOrNull, getFullDisplayName, getFullName, getName, getParent, getRelativeDisplayNameFrom, getRelativeNameFrom, getRelativeNameFrom, getRelativeNameFromGroup, getRootDir, getSearchName, getSearchUrl, getShortUrl, getUrl, hasPermission, movedTo, onCopiedFrom, onCreatedFromScratch, resolveForCLI, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXml

Methods inherited from class hudson.model.Actionable

doContextMenu, getAction, getAction, getActions, getAllActions, getDynamic

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Item

delete, getAbsoluteUrl, getAllJobs, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl, onCopiedFrom, onCreatedFromScratch, save

Methods inherited from interface hudson.model.PersistenceRoot

getRootDir

Methods inherited from interface hudson.search.SearchableModelObject

getSearch

Methods inherited from interface hudson.search.SearchItem

getSearchIndex, getSearchName, getSearchUrl

Methods inherited from interface hudson.security.AccessControlled

checkPermission, hasPermission

Methods inherited from interface hudson.model.Queue.Task

getFullDisplayName, getName, getUrl

Methods inherited from interface hudson.model.ResourceActivity

getDisplayName

Methods inherited from interface hudson.model.ItemGroup

getFullDisplayName, getFullName, getUrl

Methods inherited from interface hudson.model.ViewGroup

getUrl

Constructor Detail

MultiBranchProject

protected MultiBranchProject(hudson.model.ItemGroup parent,
                             String name)

Constructor, mandated by TopLevelItem.

Parameters:

parent - the parent of this multibranch job.

name - the name of the multibranch job.

Method Detail

onLoad

public void onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent,
                   String name)
            throws IOException

Specified by:

onLoad in interface hudson.model.Item

Overrides:

onLoad in class com.cloudbees.hudson.plugins.folder.AbstractFolder<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

Throws:

IOException

getProjectFactory

@NonNull
public BranchProjectFactory<P,R> getProjectFactory()

Returns the BranchProjectFactory. ˜

Returns:

the BranchProjectFactory.

setProjectFactory

public void setProjectFactory(BranchProjectFactory<P,R> projectFactory)

Sets the BranchProjectFactory.

Parameters:

projectFactory - the new BranchProjectFactory.

newProjectFactory

@NonNull
protected abstract BranchProjectFactory<P,R> newProjectFactory()

Creates a new instance of the default project factory to be used for a new instance of the project type.

Returns:

a new default BranchProjectFactory.

getSources

@NonNull
public List<BranchSource> getSources()

The sources of branches.

Returns:

the sources of branches.

getSourcesList

@NonNull
public hudson.util.PersistedList<BranchSource> getSourcesList()

Offers direct access to the configurable list of branch sources. Intended for use from scripting and testing.

getSCMSources

@NonNull
public List<jenkins.scm.api.SCMSource> getSCMSources()

Specified by:

getSCMSources in interface jenkins.scm.api.SCMSourceOwner

getSCMSource

@CheckForNull
public jenkins.scm.api.SCMSource getSCMSource(@CheckForNull
                                                            String sourceId)

Specified by:

getSCMSource in interface jenkins.scm.api.SCMSourceOwner

getBranchPropertyStrategy

@CheckForNull
public BranchPropertyStrategy getBranchPropertyStrategy(@NonNull
                                                                      jenkins.scm.api.SCMSource source)

Returns the BranchPropertyStrategy for a specific SCMSource.

Parameters:

source - the specific SCMSource.

Returns:

the BranchPropertyStrategy to use.

getSCMSourceCriteria

@CheckForNull
public jenkins.scm.api.SCMSourceCriteria getSCMSourceCriteria(@NonNull
                                                                            jenkins.scm.api.SCMSource source)

Specified by:

getSCMSourceCriteria in interface jenkins.scm.api.SCMSourceOwner

onSCMSourceUpdated

public void onSCMSourceUpdated(@NonNull
                               jenkins.scm.api.SCMSource source)

Specified by:

onSCMSourceUpdated in interface jenkins.scm.api.SCMSourceOwner

computeChildren

protected void computeChildren(com.cloudbees.hudson.plugins.folder.computed.ChildObserver<P> observer,
                               hudson.model.TaskListener listener)
                        throws IOException,
                               InterruptedException

Specified by:

computeChildren in class com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

Throws:

IOException

InterruptedException

orphanedItems

protected Collection<P> orphanedItems(Collection<P> orphaned,
                                      hudson.model.TaskListener listener)
                               throws IOException,
                                      InterruptedException

Overrides:

orphanedItems in class com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

Throws:

IOException

InterruptedException

getItem

@CheckForNull
public P getItem(String name)

Returns the named child job or null if no such job exists.

Specified by:

getItem in interface hudson.model.ItemGroup<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

Overrides:

getItem in class com.cloudbees.hudson.plugins.folder.AbstractFolder<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

Parameters:

name - the name of the child job.

Returns:

the named child job or null if no such job exists.

getBranch

@Deprecated
 @CheckForNull
public P getBranch(String name)

Deprecated. use getItem(String) or AbstractFolder.getJob(String) directly

Returns the named branch job or null if no such branch exists.

Parameters:

name - the name of the branch

Returns:

the named branch job or null if no such branch exists.

getACL

public hudson.security.ACL getACL()

Specified by:

getACL in interface hudson.security.AccessControlled

Overrides:

getACL in class hudson.model.AbstractItem

getRootDirFor

@NonNull
public File getRootDirFor(P child)

Specified by:

getRootDirFor in interface hudson.model.ItemGroup<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

Overrides:

getRootDirFor in class com.cloudbees.hudson.plugins.folder.AbstractFolder<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

getJobsDir

@NonNull
public File getJobsDir()

Returns the directory that all branches are stored in.

Overrides:

getJobsDir in class com.cloudbees.hudson.plugins.folder.AbstractFolder<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

Returns:

the directory that all branches are stored in.

getComputationDir

@NonNull
public File getComputationDir()

Returns the directory that branch indexing is stored in.

Overrides:

getComputationDir in class com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

Returns:

the directory that branch indexing is stored in.

getDescriptor

@NonNull
public MultiBranchProjectDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.model.TopLevelItem>

Specified by:

getDescriptor in interface hudson.model.TopLevelItem

Overrides:

getDescriptor in class com.cloudbees.hudson.plugins.folder.AbstractFolder<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

getIndexing

public MultiBranchProject.BranchIndexing<P,R> getIndexing()

Returns the current/most recent indexing details.

Returns:

the current/most recent indexing details.

submit

protected void submit(org.kohsuke.stapler.StaplerRequest req,
                      org.kohsuke.stapler.StaplerResponse rsp)
               throws IOException,
                      javax.servlet.ServletException,
                      hudson.model.Descriptor.FormException

Overrides:

submit in class com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

Throws:

IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

getPrimaryView

@Exported
 @NonNull
public hudson.model.View getPrimaryView()

Specified by:

getPrimaryView in interface hudson.model.ViewGroup

Overrides:

getPrimaryView in class com.cloudbees.hudson.plugins.folder.AbstractFolder<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

getWelcomeView

protected hudson.model.View getWelcomeView()

Creates a place holder view when there's no active branch indexed.

getView

public hudson.model.View getView(String name)

Specified by:

getView in interface hudson.model.ViewGroup

Overrides:

getView in class com.cloudbees.hudson.plugins.folder.AbstractFolder<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

isBuildable

public boolean isBuildable()

Overrides:

isBuildable in class com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

createComputation

protected com.cloudbees.hudson.plugins.folder.computed.FolderComputation<P> createComputation(com.cloudbees.hudson.plugins.folder.computed.FolderComputation<P> previous)

Overrides:

createComputation in class com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem>

rawDecode

@NonNull
public static String rawDecode(@NonNull
                                        String s)

Inverse function of Util.rawEncode(String)

Parameters:

s - the encoded string.

Returns:

the decoded string.