com.github.mjdetullio.jenkins.plugins.multibranch

Class TemplateDrivenMultiBranchProject<P extends hudson.model.AbstractProject<P,B> & hudson.model.TopLevelItem,B extends hudson.model.AbstractBuild<P,B>>

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,B>

com.github.mjdetullio.jenkins.plugins.multibranch.TemplateDrivenMultiBranchProject<P,B>

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.jenkins.ui.icon.IconSpec, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerFallback, org.kohsuke.stapler.StaplerOverridable

Direct Known Subclasses:

FreeStyleMultiBranchProject, IvyMultiBranchProject, MatrixMultiBranchProject, MavenMultiBranchProject

public abstract class TemplateDrivenMultiBranchProject<P extends hudson.model.AbstractProject<P,B> & hudson.model.TopLevelItem,B extends hudson.model.AbstractBuild<P,B>>
extends jenkins.branch.MultiBranchProject<P,B>
implements hudson.model.TopLevelItem, jenkins.scm.api.SCMSourceOwner

Author:

Matthew DeTullio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateDrivenMultiBranchProject.BranchProjectItemListener Additional listener for normal changes to Items in the UI, used to enforce state for multi-branch projects and their sub-projects.
static class	TemplateDrivenMultiBranchProject.BranchProjectSaveListener Additional listener for changes to Items via config.xml POST, used to enforce state for multi-branch projects and their sub-projects.

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

jenkins.branch.MultiBranchProject.BranchIndexing<P extends hudson.model.Job<P,R> & hudson.model.TopLevelItem,R extends hudson.model.Run<P,R>>, jenkins.branch.MultiBranchProject.SCMEventListenerImpl, jenkins.branch.MultiBranchProject.StateActionFactory

Nested classes/interfaces inherited from class com.cloudbees.hudson.plugins.folder.AbstractFolder

com.cloudbees.hudson.plugins.folder.AbstractFolder.ItemListenerImpl, com.cloudbees.hudson.plugins.folder.AbstractFolder.RunListenerImpl

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

Modifier and Type	Field and Description
protected boolean	disabled
protected P	template
static String	TEMPLATE

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

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

Method Summary

Modifier and Type	Method and Description
void	disable()
org.kohsuke.stapler.HttpResponse	doDisable()
org.kohsuke.stapler.HttpResponse	doEnable()
void	enable()
static void	enforceProjectStateOnUpdated(hudson.model.Item item) Triggered by different listeners to enforce state for multi-branch projects and their sub-projects.
hudson.model.Run	getFirstBuild() Returns the oldest build in the record.
hudson.model.Run	getLastBuild() Returns the last build.
hudson.model.Run	getLastCompletedBuild() Returns the last completed build, if any.
hudson.model.Run	getLastFailedBuild() Returns the last failed build, if any.
hudson.model.Run	getLastStableBuild() Returns the last stable build, if any.
hudson.model.Run	getLastSuccessfulBuild() Returns the last successful build, if any.
hudson.model.Run	getLastUnstableBuild() Returns the last unstable build, if any.
hudson.model.Run	getLastUnsuccessfulBuild() Returns the last build that was anything but stable, if any.
String	getPronoun() Get the term used in the UI to represent this kind of AbstractProject.
File	getRootDirFor(P child)
P	getTemplate() Retrieves the template sub-project.
File	getTemplateDir() Returns the "template" directory inside the project directory.
static List<hudson.model.ViewDescriptor>	getViewDescriptors() Returns a list of ViewDescriptors that we want to use for this project type.
protected void	init3() Common initialization that is invoked when either a new project is created with the constructor TemplateDrivenMultiBranchProject(ItemGroup, String) or when a project is loaded from disk with onLoad(ItemGroup, String).
protected void	initViews(List<hudson.model.View> views) Overrides view initialization to use BranchListView instead of AllView.
boolean	isBuildable()
boolean	isConfigurable() Gets whether or not this item is configurable (always true).
boolean	isDisabled() Gets whether this project is disabled.
void	makeDisabled(boolean b) Marks the build as disabled.
protected abstract P	newTemplate() Should create a new project using this TemplateDrivenMultiBranchProject as the parent and TEMPLATE as the name.
void	onCopiedFrom(hudson.model.Item src) If copied, also copy the template.
void	onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent, String name)
void	submit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Sets various implementation-specific fields and forwards wrapped req/rsp objects on to the template's AbstractProject.doConfigSubmit(StaplerRequest, StaplerResponse) method.
boolean	supportsMakeDisabled() Specifies whether this project may be disabled by the user.

Methods inherited from class jenkins.branch.MultiBranchProject

computeChildren, createComputation, getACL, getBranch, getBranchPropertyStrategy, getComputationDir, getDescription, getDescriptor, getDisplayName, getIconClassName, getIndexing, getItem, getItemByBranchName, getJobsDir, getProjectClass, getProjectFactory, getSCMSource, getSCMSourceCriteria, getSCMSources, getSources, getSourcesList, getView, getWelcomeView, isHasEvents, newDefaultFolderIcon, newFolderViewHolder, newProjectFactory, onSCMSourceUpdated, orphanedItems, rawDecode, setProjectFactory, setSourcesList

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

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

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

addAction, addOrReplaceAction, addProperty, addView, canDelete, delete, deleteView, doChildrenContextMenu, doCreateView, doDoRename, doLastBuild, doSubmitDescription, doViewExistsCheck, getAllJobs, getBuildHealth, getBuildHealthReports, getFolderViews, getHealthMetrics, getIcon, getIconColor, getItemGroup, getItems, getJob, getOverrides, getPrimaryView, getProperties, getRootDirFor, getStaplerFallback, getUrlChildPrefix, getViewActions, getViews, getViewsTabBar, invalidateBuildHealthReports, itemsPut, loadChildren, loadJobTotal, makeSearchIndex, newDefaultViewsTabBar, onDeleted, onRenamed, onViewRenamed, removeAction, removeActions, renameTo, replaceAction, replaceActions, resetFolderViews, save, setIcon, setPrimaryView

Methods inherited from class hudson.model.AbstractItem

checkPermission, delete, doConfigDotXml, doDoDelete, doReload, doSetName, getAbsoluteUrl, getApi, getConfigFile, getDescriptorByName, getDisplayNameOrNull, getFullDisplayName, getFullName, getName, getParent, getRelativeDisplayNameFrom, getRelativeNameFrom, getRelativeNameFrom, getRelativeNameFromGroup, getRootDir, getSearchName, getSearchUrl, getShortUrl, getUrl, hasPermission, movedTo, performDelete, 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.TopLevelItem

getDescriptor

Methods inherited from interface jenkins.scm.api.SCMSourceOwner

getSCMSource, getSCMSourceCriteria, getSCMSources, onSCMSourceUpdated

Methods inherited from interface hudson.model.Item

delete, getAbsoluteUrl, getAllJobs, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl, 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, getACL, hasPermission

Methods inherited from interface hudson.model.Queue.Task

getFullDisplayName, getName, getUrl

Methods inherited from interface hudson.model.ItemGroup

getFullDisplayName, getFullName, getUrl

Methods inherited from interface hudson.model.ViewGroup

getUrl

Field Detail

TEMPLATE

public static final String TEMPLATE

See Also:

Constant Field Values

disabled

protected volatile boolean disabled

template

protected transient P extends hudson.model.AbstractProject<P,B> & hudson.model.TopLevelItem template

Constructor Detail

TemplateDrivenMultiBranchProject

public TemplateDrivenMultiBranchProject(hudson.model.ItemGroup parent,
                                        String name)

Constructor, mandated by TopLevelItem.

Parameters:

parent - the parent of this multi-branch job.

name - the name of the multi-branch 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 jenkins.branch.MultiBranchProject<P extends hudson.model.AbstractProject<P,B> & hudson.model.TopLevelItem,B extends hudson.model.AbstractBuild<P,B>>

Throws:

IOException

init3

protected void init3()

Common initialization that is invoked when either a new project is created with the constructor TemplateDrivenMultiBranchProject(ItemGroup, String) or when a project is loaded from disk with onLoad(ItemGroup, String).

newTemplate

protected abstract P newTemplate()

Should create a new project using this TemplateDrivenMultiBranchProject as the parent and TEMPLATE as the name.

Returns:

a new project to serve as the template.

initViews

protected void initViews(List<hudson.model.View> views)
                  throws IOException

Overrides view initialization to use BranchListView instead of AllView.

Overrides:

initViews in class com.cloudbees.hudson.plugins.folder.AbstractFolder<P extends hudson.model.AbstractProject<P,B> & hudson.model.TopLevelItem>

Throws:

IOException

getTemplate

public P getTemplate()

Retrieves the template sub-project. Used by jelly views.

Returns:

P - the template sub-project.

getTemplateDir

@Nonnull
public File getTemplateDir()

Returns the "template" directory inside the project directory. This is the template project's directory.

Returns:

File - "template" directory inside the project directory.

getRootDirFor

@Nonnull
public File getRootDirFor(P child)

Specified by:

getRootDirFor in interface hudson.model.ItemGroup<P extends hudson.model.AbstractProject<P,B> & hudson.model.TopLevelItem>

Overrides:

getRootDirFor in class jenkins.branch.MultiBranchProject<P extends hudson.model.AbstractProject<P,B> & hudson.model.TopLevelItem,B extends hudson.model.AbstractBuild<P,B>>

onCopiedFrom

public void onCopiedFrom(hudson.model.Item src)

If copied, also copy the template.

Specified by:

onCopiedFrom in interface hudson.model.Item

Overrides:

onCopiedFrom in class hudson.model.AbstractItem

submit

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

Sets various implementation-specific fields and forwards wrapped req/rsp objects on to the template's AbstractProject.doConfigSubmit(StaplerRequest, StaplerResponse) method.

Overrides:

submit in class jenkins.branch.MultiBranchProject<P extends hudson.model.AbstractProject<P,B> & hudson.model.TopLevelItem,B extends hudson.model.AbstractBuild<P,B>>

Throws:

javax.servlet.ServletException

hudson.model.Descriptor.FormException

IOException

getLastBuild

@CheckForNull
 @Exported
public hudson.model.Run getLastBuild()

Returns the last build.

Returns:

the build or null

getFirstBuild

@CheckForNull
 @Exported
public hudson.model.Run getFirstBuild()

Returns the oldest build in the record.

Returns:

the build or null

getLastSuccessfulBuild

@CheckForNull
 @Exported
public hudson.model.Run getLastSuccessfulBuild()

Returns the last successful build, if any. Otherwise null. A successful build would include either Result.SUCCESS or Result.UNSTABLE.

Returns:

the build or null

See Also:

getLastStableBuild()

getLastUnsuccessfulBuild

@CheckForNull
 @Exported
public hudson.model.Run getLastUnsuccessfulBuild()

Returns the last build that was anything but stable, if any. Otherwise null.

Returns:

the build or null

See Also:

getLastSuccessfulBuild()

getLastUnstableBuild

@CheckForNull
 @Exported
public hudson.model.Run getLastUnstableBuild()

Returns the last unstable build, if any. Otherwise null.

Returns:

the build or null

See Also:

getLastSuccessfulBuild()

getLastStableBuild

@CheckForNull
 @Exported
public hudson.model.Run getLastStableBuild()

Returns the last stable build, if any. Otherwise null.

Returns:

the build or null

See Also:

getLastSuccessfulBuild()

getLastFailedBuild

@CheckForNull
 @Exported
public hudson.model.Run getLastFailedBuild()

Returns the last failed build, if any. Otherwise null.

Returns:

the build or null

getLastCompletedBuild

@CheckForNull
 @Exported
public hudson.model.Run getLastCompletedBuild()

Returns the last completed build, if any. Otherwise null.

Returns:

the build or null

isBuildable

public boolean isBuildable()

Overrides:

isBuildable in class jenkins.branch.MultiBranchProject<P extends hudson.model.AbstractProject<P,B> & hudson.model.TopLevelItem,B extends hudson.model.AbstractBuild<P,B>>

isDisabled

public boolean isDisabled()

Gets whether this project is disabled.

Returns:

boolean - true: disabled, false: enabled

makeDisabled

public void makeDisabled(boolean b)
                  throws IOException

Marks the build as disabled.

Parameters:

b - true - disable, false - enable

Throws:

IOException - if problem saving

supportsMakeDisabled

public boolean supportsMakeDisabled()

Specifies whether this project may be disabled by the user. By default, it can be only if this is a TopLevelItem; would be false for matrix configurations, etc.

Returns:

true if the GUI should allow doDisable() and the like

disable

public void disable()
             throws IOException

Throws:

IOException

enable

public void enable()
            throws IOException

Throws:

IOException

doDisable

@CLIMethod(name="disable-job")
public org.kohsuke.stapler.HttpResponse doDisable()
                                                                          throws IOException,
                                                                                 javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

doEnable

@CLIMethod(name="enable-job")
public org.kohsuke.stapler.HttpResponse doEnable()
                                                                        throws IOException,
                                                                               javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

isConfigurable

public boolean isConfigurable()

Gets whether or not this item is configurable (always true). Used in Jelly.

Returns:

boolean - true

getPronoun

public String getPronoun()

Get the term used in the UI to represent this kind of AbstractProject. Must start with a capital letter.

Overrides:

getPronoun in class jenkins.branch.MultiBranchProject<P extends hudson.model.AbstractProject<P,B> & hudson.model.TopLevelItem,B extends hudson.model.AbstractBuild<P,B>>

getViewDescriptors

public static List<hudson.model.ViewDescriptor> getViewDescriptors()

Returns a list of ViewDescriptors that we want to use for this project type. Used by newView.jelly.

Returns:

list of ViewDescriptors that we want to use for this project type

enforceProjectStateOnUpdated

public static void enforceProjectStateOnUpdated(hudson.model.Item item)

Triggered by different listeners to enforce state for multi-branch projects and their sub-projects.

• Watches for changes to the template project and corrects the SCM and enabled/disabled state if modified.
• Looks for rogue template project in the branches directory and removes it if no such sub-project exists.
• Re-disables sub-projects if they were enabled when the parent project was disabled.

Parameters:

item - the item that was just updated