com.github.mjdetullio.jenkins.plugins.multibranch

Class FreeStyleMultiBranchProject

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.AbstractItem

hudson.model.Job<P,R>

hudson.model.AbstractProject<P,B>

hudson.model.Project<FreeStyleBranchProject,FreeStyleBranchBuild>

com.github.mjdetullio.jenkins.plugins.multibranch.FreeStyleMultiBranchProject

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.BuildableItem, hudson.model.BuildableItemWithBuildWrappers, hudson.model.Describable<hudson.model.TopLevelItem>, hudson.model.DescriptorByNameOwner, hudson.model.Item, hudson.model.ItemGroup<FreeStyleBranchProject>, hudson.model.ModelObject, hudson.model.PersistenceRoot, hudson.model.queue.SubTask, hudson.model.Queue.Task, hudson.model.ResourceActivity, hudson.model.Saveable, hudson.model.SCMedItem, hudson.model.TopLevelItem, hudson.model.ViewGroup, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, hudson.tasks.Maven.ProjectWithMaven, jenkins.model.ModelObjectWithChildren, jenkins.model.ModelObjectWithContextMenu, jenkins.scm.api.SCMSourceOwner, jenkins.util.io.OnMaster, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerOverridable

public class FreeStyleMultiBranchProject
extends hudson.model.Project<FreeStyleBranchProject,FreeStyleBranchBuild>
implements hudson.model.TopLevelItem, hudson.model.ItemGroup<FreeStyleBranchProject>, hudson.model.ViewGroup, jenkins.scm.api.SCMSourceOwner

Author:

Matthew DeTullio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FreeStyleMultiBranchProject.DescriptorImpl Our project's descriptor.

Nested classes/interfaces inherited from class hudson.model.AbstractProject

hudson.model.AbstractProject.AbstractProjectDescriptor, hudson.model.AbstractProject.BecauseOfBuildInProgress, hudson.model.AbstractProject.BecauseOfDownstreamBuildInProgress, hudson.model.AbstractProject.BecauseOfUpstreamBuildInProgress

Nested classes/interfaces inherited from class hudson.model.Job

hudson.model.Job.LastItemListener

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.MenuItem

Field Summary

Fields inherited from class hudson.model.AbstractProject

ABORT, blockBuildWhenDownstreamBuilding, blockBuildWhenUpstreamBuilding, BUILD_NOW_TEXT, builds, disabled, transientActions, triggers

Fields inherited from class hudson.model.Job

HISTORY_ADAPTER, nextBuildNumber, properties

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
FreeStyleMultiBranchProject(hudson.model.ItemGroup parent, String name) Constructor that specifies the ItemGroup for this project and the project name.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDelete(hudson.model.View view)
void	deleteView(hudson.model.View view)
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.
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.
hudson.util.FormValidation	doViewExistsCheck(String value) Stapler URL binding used by the newView page to check for existing views.
FreeStyleBranchProject	getBranch(String name) Stapler URL binding for ${rootUrl}/job/${project}/branch/${branchProject}
File	getBranchesDir() Returns the "branches" directory inside the project directory.
protected Class<FreeStyleBranchBuild>	getBuildClass()
List<hudson.model.HealthReport>	getBuildHealthReports() Get the current health reports for a job.
hudson.model.TopLevelItemDescriptor	getDescriptor()
hudson.model.BallColor	getIconColor() Used as the color of the status ball for the project.
FreeStyleBranchProject	getItem(String name)
hudson.model.ItemGroup<? extends hudson.model.TopLevelItem>	getItemGroup()
Collection<FreeStyleBranchProject>	getItems()
FreeStyleBranchBuild	getLastBuild()
hudson.model.View	getPrimaryView()
File	getRootDirFor(FreeStyleBranchProject 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.
FreeStyleBranchProject	getTemplateProject() Retrieves the template sub-project.
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()
boolean	isBuildable()
void	makeDisabled(boolean b)
void	onDeleted(FreeStyleBranchProject item)
void	onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent, String name)
void	onRenamed(FreeStyleBranchProject item, String oldName, String newName)
void	onSCMSourceUpdated(jenkins.scm.api.SCMSource source)
void	onViewRenamed(hudson.model.View view, String oldName, String newName)
static void	registerXStream() Gives this class an alias for configuration XML.
protected void	submit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
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.Project

addPublisher, asProject, buildDependencyGraph, createTransientActions, getBuilders, getBuildersList, getBuildWrappers, getBuildWrappersList, getPublisher, getPublishers, getPublishersList, getResourceActivities, inferMavenInstallation, isFingerprintConfigured, removePublisher

Methods inherited from class hudson.model.AbstractProject

_getRuns, addProperty, addToList, addTrigger, blockBuildWhenDownstreamBuilding, blockBuildWhenUpstreamBuilding, buildDescribable, buildDescribable, checkAbortPermission, checkout, createExecutable, createHistoryWidget, disable, doBuild, doBuild, doBuildWithParameters, doBuildWithParameters, doCancelQueue, doCheckRetryCount, doChildrenContextMenu, doDisable, doDoWipeOutWorkspace, doEnable, doPolling, doRssChangelog, doWs, enable, findNearest, findNearest, getActions, getAssignedLabel, getAssignedLabelString, getAuthToken, getBuild, getBuildByNumber, getBuildingDownstream, getBuildingUpstream, getBuildNowText, getBuildTriggerUpstreamProjects, getCauseOfBlockage, getCustomWorkspace, getDefaultAuthentication, getDelay, getDownstreamProjects, getEnvironment, getFirstBuild, getHasCustomQuietPeriod, getJDK, getLastBuiltOn, getModuleRoot, getModuleRoots, getNearestBuild, getNearestOldBuild, getOwnerTask, getProminentActions, getPronoun, getQueueItem, getQuietPeriod, getRelationship, getRelevantLabels, getResourceList, getRootProject, getSameNodeConstraint, getScm, getScmCheckoutRetryCount, getScmCheckoutStrategy, getSomeBuildWithWorkspace, getSomeWorkspace, getSubTasks, getTransitiveDownstreamProjects, getTransitiveUpstreamProjects, getTrigger, getTriggers, getUpstreamProjects, getWhyBlocked, getWorkspace, getWorkspaceResource, hasAbortPermission, hasCustomScmCheckoutRetryCount, hasParticipant, isBuildBlocked, isConcurrentBuild, isConfigurable, isDisabled, isInQueue, isParameterized, loadBuild, makeSearchIndex, newBuild, onCreatedFromScratch, performDelete, poll, pollSCMChanges, removeFromList, removeRun, removeTrigger, renameTo, resolveForCLI, save, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild2, scheduleBuild2, scheduleBuild2, scheduleBuild2, schedulePolling, setAssignedLabel, setAssignedNode, setBlockBuildWhenDownstreamBuilding, setBlockBuildWhenUpstreamBuilding, setConcurrentBuild, setCustomWorkspace, setJDK, setQuietPeriod, setScm, setScmCheckoutStrategy, supportsMakeDisabled, triggers, updateTransientActions

Methods inherited from class hudson.model.Job

assignBuildNumber, delete, doBuildStatus, doDescription, doDoRename, doRssAll, doRssFailed, getACL, getAllJobs, getAllProperties, getBuildDir, getBuildDiscarder, getBuildForCLI, getBuildHealth, getBuilds, getBuilds, getBuildsAsMap, getBuildsByTimestamp, getBuildStatusUrl, getBuildTimeGraph, getCharacteristicEnvVars, getDynamic, getEstimatedDuration, getEstimatedDurationCandidates, getLastBuildsOverThreshold, getLastCompletedBuild, getLastFailedBuild, getLastStableBuild, getLastSuccessfulBuild, getLastUnstableBuild, getLastUnsuccessfulBuild, getLogRotator, getNewBuilds, getNextBuildNumber, getOverrides, getPermalinks, getProperties, getProperty, getProperty, getTimeline, getWidgets, isBuilding, isHoldOffBuildUntilSave, isKeepDependencies, isLogUpdated, isNameEditable, logRotate, onCopiedFrom, removeProperty, removeProperty, saveNextBuildNumber, setBuildDiscarder, setLogRotator, supportsLogRotator, updateNextBuildNumber

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, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXml

Methods inherited from class hudson.model.Actionable

addAction, doContextMenu, getAction, getAction, getActions

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.ItemGroup

getFullDisplayName, getFullName, getUrl

Methods inherited from interface hudson.model.ViewGroup

getUrl

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.search.SearchableModelObject

getSearch

Methods inherited from interface hudson.search.SearchItem

getSearchIndex, getSearchName, getSearchUrl

Methods inherited from interface hudson.model.SCMedItem

getScm, poll, pollSCMChanges

Methods inherited from interface hudson.model.BuildableItem

scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild

Methods inherited from interface hudson.model.Queue.Task

checkAbortPermission, getCauseOfBlockage, getDefaultAuthentication, getFullDisplayName, getName, getSubTasks, getUrl, getWhyBlocked, hasAbortPermission, isBuildBlocked, isConcurrentBuild

Methods inherited from interface hudson.model.queue.SubTask

createExecutable, getAssignedLabel, getEstimatedDuration, getLastBuiltOn, getOwnerTask, getSameNodeConstraint

Methods inherited from interface hudson.model.ResourceActivity

getDisplayName, getResourceList

Constructor Detail

FreeStyleMultiBranchProject

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

Constructor that specifies the ItemGroup for this project and the project name.

Parameters:

parent - - the project's parent ItemGroup

name - - the project's 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.Project<FreeStyleBranchProject,FreeStyleBranchBuild>

Throws:

IOException

getDescriptor

public hudson.model.TopLevelItemDescriptor getDescriptor()

Specified by:

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

Specified by:

getDescriptor in interface hudson.model.TopLevelItem

getBranch

public FreeStyleBranchProject getBranch(String name)

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

Parameters:

name - - Branch project name

Returns:

getItem(String)

getBuildClass

protected Class<FreeStyleBranchBuild> getBuildClass()

Specified by:

getBuildClass in class hudson.model.AbstractProject<FreeStyleBranchProject,FreeStyleBranchBuild>

getTemplateProject

public FreeStyleBranchProject getTemplateProject()

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.

getItems

public Collection<FreeStyleBranchProject> getItems()

Specified by:

getItems in interface hudson.model.ItemGroup<FreeStyleBranchProject>

getUrlChildPrefix

public String getUrlChildPrefix()

Specified by:

getUrlChildPrefix in interface hudson.model.ItemGroup<FreeStyleBranchProject>

getItem

public FreeStyleBranchProject getItem(String name)

Specified by:

getItem in interface hudson.model.ItemGroup<FreeStyleBranchProject>

getRootDirFor

public File getRootDirFor(FreeStyleBranchProject child)

Specified by:

getRootDirFor in interface hudson.model.ItemGroup<FreeStyleBranchProject>

onRenamed

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

Specified by:

onRenamed in interface hudson.model.ItemGroup<FreeStyleBranchProject>

onDeleted

public void onDeleted(FreeStyleBranchProject item)

Specified by:

onDeleted in interface hudson.model.ItemGroup<FreeStyleBranchProject>

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)

getLastBuild

public FreeStyleBranchBuild getLastBuild()

Overrides:

getLastBuild in class hudson.model.AbstractProject<FreeStyleBranchProject,FreeStyleBranchBuild>

isBuildable

public boolean isBuildable()

Overrides:

isBuildable in class hudson.model.AbstractProject<FreeStyleBranchProject,FreeStyleBranchBuild>

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 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.AbstractProject<FreeStyleBranchProject,FreeStyleBranchBuild>

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

Overrides:

doConfigSubmit in class hudson.model.AbstractProject<FreeStyleBranchProject,FreeStyleBranchBuild>

Throws:

javax.servlet.ServletException

hudson.model.Descriptor.FormException

IOException

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 hudson.model.Project<FreeStyleBranchProject,FreeStyleBranchBuild>

Throws:

IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

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.

Overrides:

getIconColor in class hudson.model.AbstractProject<FreeStyleBranchProject,FreeStyleBranchBuild>

Returns:

the color of the status ball for the project.

getBuildHealthReports

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

Get the current health reports for a job.

Kanged from Branch API.

Overrides:

getBuildHealthReports in class hudson.model.Job<FreeStyleBranchProject,FreeStyleBranchBuild>

Returns:

the health reports. Never returns null

makeDisabled

public void makeDisabled(boolean b)
                  throws IOException

Overrides:

makeDisabled in class hudson.model.AbstractProject<FreeStyleBranchProject,FreeStyleBranchBuild>

Throws:

IOException

registerXStream

@Initializer(before=PLUGINS_STARTED)
public static void registerXStream()

Gives this class an alias for configuration XML.

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.

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.