com.github.mjdetullio.jenkins.plugins.multibranch

Class FreeStyleBranchProject

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

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.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.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, hudson.tasks.Maven.ProjectWithMaven, jenkins.model.ModelObjectWithChildren, jenkins.model.ModelObjectWithContextMenu, jenkins.util.io.OnMaster, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerOverridable

public class FreeStyleBranchProject
extends hudson.model.Project<FreeStyleBranchProject,FreeStyleBranchBuild>
implements hudson.model.TopLevelItem

Wrapper for the Project class that imitates normal FreeStyleProjects, but for use as a sub-project of the FreeStyleMultiBranchProject type.

Author:

Matthew DeTullio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FreeStyleBranchProject.DescriptorImpl This project type has to be a TopLevelItem in order to be shown in the multi-branch project's branch list, but TopLevelItems are also shown in the new job list.

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

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
FreeStyleBranchProject(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
void	doConfigDotXml(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Disables configuring of this project type via Stapler.
void	doConfigSubmit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Disables configuring of this project type via Stapler.
void	doDoRename(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Disables renaming of this project type.
protected Class<FreeStyleBranchBuild>	getBuildClass()
FreeStyleBranchProject.DescriptorImpl	getDescriptor()
hudson.util.CopyOnWriteList<hudson.model.JobProperty<? super FreeStyleBranchProject>>	getPropertiesList() Exposes the job properties so they can be manipulated from the parent.
hudson.util.DescribableList<hudson.triggers.Trigger<?>,hudson.triggers.TriggerDescriptor>	getTriggersList() Exposes the triggers so they can be set from the parent.
boolean	isDisabled() First checks if the parent project is disabled, then this sub-project's setting.
boolean	isTemplate() Returns whether or not this is the template.
void	onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent, String name)
static void	registerXStream() Gives this class an alias for configuration XML.
void	setIsTemplate(boolean isTemplate) Sets whether or not this is the template

Methods inherited from class hudson.model.Project

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

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, doDoDelete, 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, getIconColor, getJDK, getLastBuild, 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, isBuildable, isBuildBlocked, isConcurrentBuild, isConfigurable, isInQueue, isParameterized, loadBuild, makeDisabled, 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, doRssAll, doRssFailed, getACL, getAllJobs, getAllProperties, getBuildDir, getBuildDiscarder, getBuildForCLI, getBuildHealth, getBuildHealthReports, 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, 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.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, getACL, hasPermission

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

FreeStyleBranchProject

public FreeStyleBranchProject(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

isTemplate

public boolean isTemplate()

Returns whether or not this is the template.

Returns:

boolean

setIsTemplate

public void setIsTemplate(boolean isTemplate)
                   throws IOException

Sets whether or not this is the template

Parameters:

isTemplate - - true/false

Throws:

IOException - - if problem saving

isDisabled

public boolean isDisabled()

First checks if the parent project is disabled, then this sub-project's setting.

Overrides:

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

Returns:

true if parent project is disabled or this project is disabled

getBuildClass

protected Class<FreeStyleBranchBuild> getBuildClass()

Specified by:

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

getDescriptor

public FreeStyleBranchProject.DescriptorImpl getDescriptor()

Specified by:

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

Specified by:

getDescriptor in interface hudson.model.TopLevelItem

getTriggersList

@WithBridgeMethods(value=java.util.List.class)
public hudson.util.DescribableList<hudson.triggers.Trigger<?>,hudson.triggers.TriggerDescriptor> getTriggersList()

Exposes the triggers so they can be set from the parent. Used for the template. For the branch sub-projects, triggers are unmarshaled from XML.

Returns:

list of triggers

getPropertiesList

public hudson.util.CopyOnWriteList<hudson.model.JobProperty<? super FreeStyleBranchProject>> getPropertiesList()

Exposes the job properties so they can be manipulated from the parent. Used for the template, which requires properties to be cleared so they they can be rebuilt.

Warning: offers direct access to list

Returns:

direct access to list of properties

doDoRename

public void doDoRename(org.kohsuke.stapler.StaplerRequest req,
              org.kohsuke.stapler.StaplerResponse rsp)

Disables renaming of this project type.

Inherited docs:

Overrides:

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

doConfigSubmit

public void doConfigSubmit(org.kohsuke.stapler.StaplerRequest req,
                  org.kohsuke.stapler.StaplerResponse rsp)

Disables configuring of this project type via Stapler.

Inherited docs:

Overrides:

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

doConfigDotXml

@WebMethod(name="config.xml")
public void doConfigDotXml(org.kohsuke.stapler.StaplerRequest req,
                            org.kohsuke.stapler.StaplerResponse rsp)
                    throws IOException

Disables configuring of this project type via Stapler.

Inherited docs:

Overrides:

doConfigDotXml in class hudson.model.AbstractItem

Throws:

IOException

registerXStream

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

Gives this class an alias for configuration XML.