com.github.mjdetullio.jenkins.plugins.multibranch

Class AbstractMultiBranchProject<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.github.mjdetullio.jenkins.plugins.multibranch.AbstractMultiBranchProject<P,B>

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.TopLevelItem>, hudson.model.DescriptorByNameOwner, hudson.model.Item, hudson.model.ItemGroup<P>, hudson.model.ModelObject, hudson.model.PersistenceRoot, hudson.model.Saveable, hudson.model.TopLevelItem, hudson.model.ViewGroup, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, jenkins.model.ModelObjectWithContextMenu, jenkins.scm.api.SCMSourceOwner, org.kohsuke.stapler.HttpDeletable

Direct Known Subclasses:

FreeStyleMultiBranchProject, MavenMultiBranchProject

public abstract class AbstractMultiBranchProject<P extends hudson.model.AbstractProject<P,B> & hudson.model.TopLevelItem,B extends hudson.model.AbstractBuild<P,B>>
extends hudson.model.AbstractItem
implements hudson.model.TopLevelItem, hudson.model.ItemGroup<P>, hudson.model.ViewGroup, jenkins.scm.api.SCMSourceOwner

Author:

Matthew DeTullio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractMultiBranchProject.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	AbstractMultiBranchProject.BranchProjectSaveListener Additional listener for changes to Items via config.xml POST, used to enforce state for multi-branch projects and their sub-projects.
static class	AbstractMultiBranchProject.SyncBranchesTransientActionFactory Adds SyncBranchesTrigger.SyncBranchesAction to the list of actions on AbstractMultiBranchProjects, effectively showing it on the sidepanel.

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 String	primaryView
protected jenkins.scm.api.SCMSource	scmSource
protected SyncBranchesTrigger	syncBranchesTrigger
protected P	templateProject
protected hudson.util.DescribableList<hudson.triggers.Trigger<?>,hudson.triggers.TriggerDescriptor>	triggers

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

Constructor Summary

Constructors

Constructor and Description
AbstractMultiBranchProject(hudson.model.ItemGroup parent, String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDelete(hudson.model.View view)
protected abstract P	createNewSubProject(AbstractMultiBranchProject parent, String branchName) Defines how sub-projects should be created when provided the parent and the branch name.
void	delete() Overrides the AbstractItem implementation to also delete the subprojects before deleting this parent project.
void	deleteView(hudson.model.View view)
void	disable()
void	doConfigSubmit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
void	doCreateView(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Stapler URL binding for creating views for our branch projects.
org.kohsuke.stapler.HttpResponse	doDisable()
void	doDoDelete(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Overrides the AbstractProject implementation because the user is not redirected to the parent properly for this project type.
org.kohsuke.stapler.HttpResponse	doEnable()
void	doSyncBranches(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Exposes a URI that allows the trigger of a branch sync.
hudson.util.FormValidation	doViewExistsCheck(String value) Stapler URL binding used by the newView page to check for existing views.
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.security.ACL	getACL() For project matrix auth, use custom implementation with ACL from template project, otherwise infinite loops are all too possible.
Collection<? extends hudson.model.Job>	getAllJobs()
P	getBranch(String name) Stapler URL binding for ${rootUrl}/job/${project}/branch/${branchProject}
File	getBranchesDir() Returns the "branches" directory inside the project directory.
hudson.model.HealthReport	getBuildHealth() Get the current health report for a job.
List<hudson.model.HealthReport>	getBuildHealthReports() Get the current health reports for a job.
B	getFirstBuild() Returns the oldest build in the record.
hudson.model.BallColor	getIconColor() Used as the color of the status ball for the project.
P	getItem(String name)
hudson.model.ItemGroup<? extends hudson.model.TopLevelItem>	getItemGroup()
Collection<P>	getItems()
B	getLastBuild() Returns the last build.
B	getLastCompletedBuild() Returns the last completed build, if any.
B	getLastFailedBuild() Returns the last failed build, if any.
B	getLastStableBuild() Returns the last stable build, if any.
B	getLastSuccessfulBuild() Returns the last successful build, if any.
B	getLastUnstableBuild() Returns the last unstable build, if any.
B	getLastUnsuccessfulBuild() Returns the last build that was anything but stable, if any.
hudson.model.View	getPrimaryView()
String	getPronoun() Get the term used in the UI to represent this kind of AbstractProject.
File	getRootDirFor(P child)
jenkins.scm.api.SCMSource	getSCMSource() Returns the project's only SCMSource.
jenkins.scm.api.SCMSource	getSCMSource(String sourceId)
jenkins.scm.api.SCMSourceCriteria	getSCMSourceCriteria(jenkins.scm.api.SCMSource source)
static List<jenkins.scm.api.SCMSourceDescriptor>	getSCMSourceDescriptors(boolean onlyUserInstantiable) Returns a list of SCMSourceDescriptors that we want to use for this project type.
List<jenkins.scm.api.SCMSource>	getSCMSources()
String	getSyncBranchesCron() Used by Jelly to populate the Sync Branches Schedule field on the configuration page.
SyncBranchesTrigger	getSyncBranchesTrigger() Gets this project's SyncBranchesTrigger.
P	getTemplate() Retrieves the template sub-project.
File	getTemplateDir() Returns the "template" directory inside the project directory.
String	getUrlChildPrefix()
hudson.model.View	getView(String name)
List<hudson.model.Action>	getViewActions()
static List<hudson.model.ViewDescriptor>	getViewDescriptors() Returns a list of ViewDescriptors that we want to use for this project type.
Collection<hudson.model.View>	getViews()
hudson.views.ViewsTabBar	getViewsTabBar()
protected void	init() Common initialization that is invoked when either a new project is created with the constructor (ItemGroup, String) or when a project is loaded from disk with onLoad(ItemGroup, String).
boolean	isAllowAnonymousSync() Gets whether anonymous sync is allowed from ${JOB_URL}/syncBranches
boolean	isConfigurable()
boolean	isDisabled()
void	makeDisabled(boolean b)
void	onDeleted(P item)
void	onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent, String name)
void	onRenamed(P item, String oldName, String newName)
void	onSCMSourceUpdated(jenkins.scm.api.SCMSource source)
void	onViewRenamed(hudson.model.View view, String oldName, String newName)
static String	rawDecode(String s) Inverse function of Util.rawEncode(String).
void	setAllowAnonymousSync(boolean b) Sets whether anonymous sync is allowed from ${JOB_URL}/syncBranches.
boolean	supportsMakeDisabled() Specifies whether this project may be disabled by the user.
void	syncBranches(hudson.model.TaskListener listener) Synchronizes the available sub-projects by checking if the project is disabled, then calling _syncBranches(TaskListener) and logging its exceptions to the listener.

Methods inherited from class hudson.model.AbstractItem

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

Methods inherited from class hudson.model.Actionable

addAction, doContextMenu, getAction, getAction, getActions, getActions, getAllActions, getDynamic, replaceAction

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, makeSearchIndex, 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 hudson.model.ItemGroup

getFullDisplayName, getFullName, getUrl

Methods inherited from interface hudson.model.ViewGroup

getUrl

Methods inherited from interface hudson.model.Item

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

Methods inherited from interface hudson.search.SearchableModelObject

getSearch

Methods inherited from interface hudson.search.SearchItem

getSearchIndex, getSearchName, getSearchUrl

Field Detail

primaryView

protected volatile String primaryView

disabled

protected volatile boolean disabled

templateProject

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

triggers

protected transient hudson.util.DescribableList<hudson.triggers.Trigger<?>,hudson.triggers.TriggerDescriptor> triggers

syncBranchesTrigger

protected volatile SyncBranchesTrigger syncBranchesTrigger

scmSource

protected volatile jenkins.scm.api.SCMSource scmSource

Constructor Detail

AbstractMultiBranchProject

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

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 hudson.model.AbstractItem

Throws:

IOException

init

protected void init()

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

createNewSubProject

protected abstract P createNewSubProject(AbstractMultiBranchProject parent,
                    String branchName)

Defines how sub-projects should be created when provided the parent and the branch name.

Parameters:

parent - - this

branchName - - branch name

Returns:

new sub-project of type P

getBranch

public P getBranch(String name)

Stapler URL binding for ${rootUrl}/job/${project}/branch/${branchProject}

Parameters:

name - - Branch project name

Returns:

getItem(String)

getTemplate

public P getTemplate()

Retrieves the template sub-project. Used by configure-entries.jelly.

getBranchesDir

public File getBranchesDir()

Returns the "branches" directory inside the project directory. This is where the sub-project directories reside.

Returns:

File - "branches" directory inside the project directory.

getTemplateDir

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.

getItems

public Collection<P> getItems()

Specified by:

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

getUrlChildPrefix

public String getUrlChildPrefix()

Specified by:

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

getItem

public P getItem(String name)

Specified by:

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

getRootDirFor

public File getRootDirFor(P child)

Specified by:

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

onRenamed

public void onRenamed(P item,
             String oldName,
             String newName)

Specified by:

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

onDeleted

public void onDeleted(P item)

Specified by:

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

canDelete

public boolean canDelete(hudson.model.View view)

Specified by:

canDelete in interface hudson.model.ViewGroup

deleteView

public void deleteView(hudson.model.View view)
                throws IOException

Specified by:

deleteView in interface hudson.model.ViewGroup

Throws:

IOException

getViews

@Exported
public Collection<hudson.model.View> getViews()

Specified by:

getViews in interface hudson.model.ViewGroup

getView

public hudson.model.View getView(String name)

Specified by:

getView in interface hudson.model.ViewGroup

getPrimaryView

@Exported
public hudson.model.View getPrimaryView()

Specified by:

getPrimaryView in interface hudson.model.ViewGroup

onViewRenamed

public void onViewRenamed(hudson.model.View view,
                 String oldName,
                 String newName)

Specified by:

onViewRenamed in interface hudson.model.ViewGroup

getViewsTabBar

public hudson.views.ViewsTabBar getViewsTabBar()

Specified by:

getViewsTabBar in interface hudson.model.ViewGroup

getItemGroup

public hudson.model.ItemGroup<? extends hudson.model.TopLevelItem> getItemGroup()

Specified by:

getItemGroup in interface hudson.model.ViewGroup

getViewActions

public List<hudson.model.Action> getViewActions()

Specified by:

getViewActions in interface hudson.model.ViewGroup

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

onSCMSourceUpdated

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

Specified by:

onSCMSourceUpdated in interface jenkins.scm.api.SCMSourceOwner

getSCMSourceCriteria

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

Specified by:

getSCMSourceCriteria in interface jenkins.scm.api.SCMSourceOwner

getSCMSource

public jenkins.scm.api.SCMSource getSCMSource()

Returns the project's only SCMSource. Used by configure-entries.jelly.

Returns:

the project's only SCMSource (may be null)

isAllowAnonymousSync

public boolean isAllowAnonymousSync()

Gets whether anonymous sync is allowed from ${JOB_URL}/syncBranches

setAllowAnonymousSync

public void setAllowAnonymousSync(boolean b)
                           throws IOException

Sets whether anonymous sync is allowed from ${JOB_URL}/syncBranches.

Parameters:

b - - true/false

Throws:

IOException - - if problems saving

doCreateView

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

Stapler URL binding for creating views for our branch projects. Unlike normal views, this only requires permission to configure the project, not create view permission.

Parameters:

req - - Stapler request

rsp - - Stapler response

Throws:

IOException - - if problems

javax.servlet.ServletException - - if problems

ParseException - - if problems

Descriptor.FormException - - if problems

doViewExistsCheck

public hudson.util.FormValidation doViewExistsCheck(@QueryParameter
                                           String value)

Stapler URL binding used by the newView page to check for existing views.

Parameters:

value - - desired name of view

Returns:

FormValidation.ok() or {@link hudson.util.FormValidation#error(String)|

doDoDelete

public void doDoDelete(org.kohsuke.stapler.StaplerRequest req,
              org.kohsuke.stapler.StaplerResponse rsp)
                throws IOException,
                       InterruptedException

Overrides the AbstractProject implementation because the user is not redirected to the parent properly for this project type.

Inherited docs:

Overrides:

doDoDelete in class hudson.model.AbstractItem

Parameters:

req - - Stapler request

rsp - - Stapler response

Throws:

IOException - - if problems

InterruptedException - - if problems

delete

public void delete()
            throws IOException,
                   InterruptedException

Overrides the AbstractItem implementation to also delete the subprojects before deleting this parent project.

Inherited docs:

Specified by:

delete in interface hudson.model.Item

Overrides:

delete in class hudson.model.AbstractItem

Throws:

IOException - - if problems

InterruptedException - - if problems

doSyncBranches

public void doSyncBranches(org.kohsuke.stapler.StaplerRequest req,
                  org.kohsuke.stapler.StaplerResponse rsp)
                    throws IOException,
                           InterruptedException

Exposes a URI that allows the trigger of a branch sync.

Parameters:

req - - Stapler request

rsp - - Stapler response

Throws:

IOException - - if problems

InterruptedException - - if problems

doConfigSubmit

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

Throws:

javax.servlet.ServletException

hudson.model.Descriptor.FormException

IOException

getSyncBranchesTrigger

public SyncBranchesTrigger getSyncBranchesTrigger()

Gets this project's SyncBranchesTrigger.

Returns:

SyncBranchesTrigger

syncBranches

public void syncBranches(hudson.model.TaskListener listener)

Synchronizes the available sub-projects by checking if the project is disabled, then calling _syncBranches(TaskListener) and logging its exceptions to the listener.

getSyncBranchesCron

public String getSyncBranchesCron()

Used by Jelly to populate the Sync Branches Schedule field on the configuration page.

Returns:

String - cron

getIconColor

@Exported(visibility=2,
          name="color")
public hudson.model.BallColor getIconColor()

Used as the color of the status ball for the project.

Kanged from Branch API.

Returns:

the color of the status ball for the project.

getBuildHealth

public hudson.model.HealthReport getBuildHealth()

Get the current health report for a job.

Returns:

the health report. Never returns null

getBuildHealthReports

@Exported(name="healthReport")
public List<hudson.model.HealthReport> getBuildHealthReports()

Get the current health reports for a job.

Kanged from Branch API.

Returns:

the health reports. Never returns null

getLastBuild

@Exported
public B getLastBuild()

Returns the last build.

getFirstBuild

@Exported
public B getFirstBuild()

Returns the oldest build in the record.

getLastSuccessfulBuild

@Exported
public B getLastSuccessfulBuild()

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

See Also:

getLastStableBuild()

getLastUnsuccessfulBuild

@Exported
public B getLastUnsuccessfulBuild()

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

See Also:

getLastSuccessfulBuild()

getLastUnstableBuild

@Exported
public B getLastUnstableBuild()

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

See Also:

getLastSuccessfulBuild()

getLastStableBuild

@Exported
public B getLastStableBuild()

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

See Also:

getLastSuccessfulBuild()

getLastFailedBuild

@Exported
public B getLastFailedBuild()

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

getLastCompletedBuild

@Exported
public B getLastCompletedBuild()

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

getAllJobs

public Collection<? extends hudson.model.Job> getAllJobs()

Specified by:

getAllJobs in interface hudson.model.Item

Specified by:

getAllJobs in class hudson.model.AbstractItem

isDisabled

public boolean isDisabled()

makeDisabled

public void makeDisabled(boolean b)
                  throws IOException

Throws:

IOException

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

getACL

public hudson.security.ACL getACL()

For project matrix auth, use custom implementation with ACL from template project, otherwise infinite loops are all too possible. For other auths, use super.getACL().

Specified by:

getACL in interface hudson.security.AccessControlled

Overrides:

getACL in class hudson.model.AbstractItem

isConfigurable

public boolean isConfigurable()

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 hudson.model.AbstractItem

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.

getSCMSourceDescriptors

public static List<jenkins.scm.api.SCMSourceDescriptor> getSCMSourceDescriptors(boolean onlyUserInstantiable)

Returns a list of SCMSourceDescriptors that we want to use for this project type. Used by configure-entries.jelly.

rawDecode

public static String rawDecode(String s)

Inverse function of Util.rawEncode(String).

Kanged from Branch API.

Parameters:

s - the encoded string.

Returns:

the decoded string.

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