jenkins.branch

Class OrganizationFolder

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<MultiBranchProject<?,?>>

jenkins.branch.OrganizationFolder

All Implemented Interfaces:

ExtensionPoint, BuildableItem, Describable<TopLevelItem>, DescriptorByNameOwner, Item, ItemGroup<MultiBranchProject<?,?>>, ModelObject, ModifiableViewGroup, PersistenceRoot, Queue.FlyweightTask, SubTask, Queue.Task, ResourceActivity, Saveable, TopLevelItem, ViewGroup, SearchableModelObject, SearchItem, AccessControlled, ModelObjectWithChildren, ModelObjectWithContextMenu, jenkins.scm.api.SCMNavigatorOwner, jenkins.scm.api.SCMSourceOwner, OnMaster, org.jenkins.ui.icon.IconSpec, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerFallback, org.kohsuke.stapler.StaplerOverridable, org.kohsuke.stapler.StaplerProxy

public final class OrganizationFolder
extends com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<MultiBranchProject<?,?>>
implements jenkins.scm.api.SCMNavigatorOwner, org.jenkins.ui.icon.IconSpec

A folder-like collection of MultiBranchProjects, one per repository.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrganizationFolder.DescriptorImpl Our descriptor
static class	OrganizationFolder.OrganizationScan Our scan.
static class	OrganizationFolder.SCMEventListenerImpl Listens for events from the SCM event system.
static class	OrganizationFolder.StateActionFactory Adds the OrganizationFolder.State.getActions() to Actionable.getAllActions().

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

ExtensionPoint.LegacyInstancesAreScopedToHudson

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

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, 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, SKIP_PERMISSION_CHECK, TASK_NOUN

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
OrganizationFolder(ItemGroup parent, String name)

Method Summary

Modifier and Type	Method and Description
protected void	computeChildren(com.cloudbees.hudson.plugins.folder.computed.ChildObserver<MultiBranchProject<?,?>> observer, TaskListener listener)
protected com.cloudbees.hudson.plugins.folder.computed.FolderComputation<MultiBranchProject<?,?>>	createComputation(com.cloudbees.hudson.plugins.folder.computed.FolderComputation<MultiBranchProject<?,?>> previous)
ACL	getACL()
DescribableList<BranchBuildStrategy,BranchBuildStrategyDescriptor>	getBuildStrategies() The BranchBuildStrategys to apply.
String	getDescription()
String	getDisplayName()
String	getIconClassName()
MultiBranchProject<?,?>	getItem(String name)
MultiBranchProject<?,?>	getItemByProjectName(String projectName) Returns the child job with the specified project name or null if no such child job exists.
DescribableList<jenkins.scm.api.SCMNavigator,jenkins.scm.api.SCMNavigatorDescriptor>	getNavigators()
View	getPrimaryView() Will create an specialized view when there are no repositories or branches found, which contain a Jenkinsfile or other MARKER file.
DescribableList<MultiBranchProjectFactory,MultiBranchProjectFactoryDescriptor>	getProjectFactories()
List<jenkins.scm.api.SCMNavigator>	getSCMNavigators()
jenkins.scm.api.SCMSource	getSCMSource(String sourceId)
jenkins.scm.api.SCMSourceCriteria	getSCMSourceCriteria(jenkins.scm.api.SCMSource source)
List<jenkins.scm.api.SCMSource>	getSCMSources()
String	getSourcePronoun() Get the term used in the UI to represent the souce for this kind of Item.
View	getView(String name)
protected View	getWelcomeView() Creates a place-holder view when there's no active repositories indexed.
boolean	isBuildable()
boolean	isHasEvents()
boolean	isSingleOrigin() Returns true if this is a single origin OrganizationFolder.
protected com.cloudbees.hudson.plugins.folder.FolderIcon	newDefaultFolderIcon()
protected com.cloudbees.hudson.plugins.folder.views.AbstractFolderViewHolder	newFolderViewHolder()
void	onCreatedFromScratch()
void	onLoad(ItemGroup<? extends Item> parent, String name)
void	onSCMSourceUpdated(jenkins.scm.api.SCMSource source)
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, checkRename, createEventsChildObserver, createExecutable, doBuild, doConfigSubmit, getActions, getAssignedLabel, getCauseOfBlockage, getComputation, getComputationDir, getDefaultAuthentication, getDefaultAuthentication, getEstimatedDuration, getLastBuiltOn, getLastFailedBuild, getLastStableBuild, getLastSuccessfulBuild, getOrphanedItemStrategy, getOrphanedItemStrategyDescriptors, getOwnerTask, getResourceList, getSameNodeConstraint, getSubTasks, getSuccessfulDestination, getTriggerDescriptors, getTriggers, getWhyBlocked, hasAbortPermission, init, isBuildBlocked, isConcurrentBuild, isDisabled, openEventsChildObserver, orphanedItems, recalculateAfterSubmitted, removeTrigger, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild2, setDisabled, setOrphanedItemStrategy, supportsMakeDisabled

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

addProperty, addView, canDelete, delete, deleteView, doChildrenContextMenu, doCreateView, doDisable, doEnable, doLastBuild, doSubmitDescription, doViewExistsCheck, getAllJobs, getBuildHealth, getBuildHealthReports, getDescriptor, getFolderViews, getHealthMetrics, getIcon, getIconColor, getItemGroup, getItems, getJob, getJobsDir, getOverrides, getPronoun, getProperties, getRootDirFor, getRootDirFor, getStaplerFallback, getUrlChildPrefix, getViewActions, getViews, getViewsTabBar, initViews, invalidateBuildHealthReports, isNameEditable, itemsPut, loadChildren, loadJobTotal, makeDisabled, makeSearchIndex, newDefaultViewsTabBar, onDeleted, onRenamed, onViewRenamed, renameBlocker, renameTo, resetFolderViews, save, setIcon, setPrimaryView

Methods inherited from class hudson.model.AbstractItem

delete, doCheckNewName, doConfigDotXml, doConfirmRename, doDoDelete, doReload, doSetName, getAbsoluteUrl, getApi, getConfigFile, getDisplayNameOrNull, getFullDisplayName, getFullName, getName, getParent, getRelativeDisplayNameFrom, getRelativeNameFromGroup, getRootDir, getSearchName, getSearchUrl, getShortUrl, getTarget, getTaskNoun, getUrl, movedTo, onCopiedFrom, performDelete, resolveForCLI, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXml, writeConfigDotXml

Methods inherited from class hudson.model.Actionable

addAction, addOrReplaceAction, doContextMenu, getAction, getAction, getActions, getAllActions, getDynamic, removeAction, removeActions, replaceAction, replaceActions

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, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl, onCopiedFrom, 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, hasPermission

Methods inherited from interface hudson.model.Queue.Task

getFullDisplayName, getName, getUrl

Methods inherited from interface hudson.model.ItemGroup

allItems, allItems, getAllItems, getAllItems, getFullDisplayName, getFullName, getUrl

Methods inherited from interface hudson.model.ViewGroup

getUrl

Methods inherited from interface hudson.model.DescriptorByNameOwner

getDescriptorByName

Constructor Detail

OrganizationFolder

public OrganizationFolder(ItemGroup parent,
                          String name)

Method Detail

onCreatedFromScratch

public void onCreatedFromScratch()

Specified by:

onCreatedFromScratch in interface Item

Overrides:

onCreatedFromScratch in class com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<MultiBranchProject<?,?>>

onLoad

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

Specified by:

onLoad in interface Item

Overrides:

onLoad in class com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<MultiBranchProject<?,?>>

Throws:

IOException

getItem

public MultiBranchProject<?,?> getItem(String name)
                                throws org.acegisecurity.AccessDeniedException

Specified by:

getItem in interface ItemGroup<MultiBranchProject<?,?>>

Overrides:

getItem in class com.cloudbees.hudson.plugins.folder.AbstractFolder<MultiBranchProject<?,?>>

Throws:

org.acegisecurity.AccessDeniedException

getItemByProjectName

@CheckForNull
public MultiBranchProject<?,?> getItemByProjectName(@NonNull
                                                                  String projectName)

Returns the child job with the specified project name or null if no such child job exists.

Parameters:

projectName - the name of the project.

Returns:

the child job or null if no such job exists or if the requesting user does ave permission to view it.

Since:

2.0.0

isSingleOrigin

public boolean isSingleOrigin()

Returns true if this is a single origin OrganizationFolder.

Returns:

true if this is a single origin OrganizationFolder.

getNavigators

public DescribableList<jenkins.scm.api.SCMNavigator,jenkins.scm.api.SCMNavigatorDescriptor> getNavigators()

getSCMNavigators

@NonNull
public List<jenkins.scm.api.SCMNavigator> getSCMNavigators()

Specified by:

getSCMNavigators in interface jenkins.scm.api.SCMNavigatorOwner

getProjectFactories

public DescribableList<MultiBranchProjectFactory,MultiBranchProjectFactoryDescriptor> getProjectFactories()

getBuildStrategies

public DescribableList<BranchBuildStrategy,BranchBuildStrategyDescriptor> getBuildStrategies()

The BranchBuildStrategys to apply.

Returns:

The BranchBuildStrategys to apply.

Since:

2.0.12

submit

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

Overrides:

submit in class com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<MultiBranchProject<?,?>>

Throws:

IOException

javax.servlet.ServletException

Descriptor.FormException

createComputation

@Nonnull
protected com.cloudbees.hudson.plugins.folder.computed.FolderComputation<MultiBranchProject<?,?>> createComputation(@CheckForNull
                                                                                                                             com.cloudbees.hudson.plugins.folder.computed.FolderComputation<MultiBranchProject<?,?>> previous)

Overrides:

createComputation in class com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<MultiBranchProject<?,?>>

isHasEvents

public boolean isHasEvents()

Overrides:

isHasEvents in class com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<MultiBranchProject<?,?>>

isBuildable

public boolean isBuildable()

Overrides:

isBuildable in class com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<MultiBranchProject<?,?>>

computeChildren

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

Specified by:

computeChildren in class com.cloudbees.hudson.plugins.folder.computed.ComputedFolder<MultiBranchProject<?,?>>

Throws:

IOException

InterruptedException

newFolderViewHolder

protected com.cloudbees.hudson.plugins.folder.views.AbstractFolderViewHolder newFolderViewHolder()

Overrides:

newFolderViewHolder in class com.cloudbees.hudson.plugins.folder.AbstractFolder<MultiBranchProject<?,?>>

newDefaultFolderIcon

protected com.cloudbees.hudson.plugins.folder.FolderIcon newDefaultFolderIcon()

Overrides:

newDefaultFolderIcon in class com.cloudbees.hudson.plugins.folder.AbstractFolder<MultiBranchProject<?,?>>

getIconClassName

public String getIconClassName()

Specified by:

getIconClassName in interface org.jenkins.ui.icon.IconSpec

getSourcePronoun

public String getSourcePronoun()

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

getSCMSources

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

Specified by:

getSCMSources in interface jenkins.scm.api.SCMSourceOwner

getSCMSource

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

Specified by:

getSCMSource in interface jenkins.scm.api.SCMSourceOwner

onSCMSourceUpdated

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

Specified by:

onSCMSourceUpdated in interface jenkins.scm.api.SCMSourceOwner

getSCMSourceCriteria

public jenkins.scm.api.SCMSourceCriteria getSCMSourceCriteria(jenkins.scm.api.SCMSource source)

Specified by:

getSCMSourceCriteria in interface jenkins.scm.api.SCMSourceOwner

getPrimaryView

public View getPrimaryView()

Will create an specialized view when there are no repositories or branches found, which contain a Jenkinsfile or other MARKER file.

Specified by:

getPrimaryView in interface ViewGroup

Overrides:

getPrimaryView in class com.cloudbees.hudson.plugins.folder.AbstractFolder<MultiBranchProject<?,?>>

getWelcomeView

protected View getWelcomeView()

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

Returns:

a place-holder view for when there's no active repositories indexed.

getView

public View getView(String name)

Specified by:

getView in interface ViewGroup

Overrides:

getView in class com.cloudbees.hudson.plugins.folder.AbstractFolder<MultiBranchProject<?,?>>

getDescription

public String getDescription()

Overrides:

getDescription in class AbstractItem

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Item

Specified by:

getDisplayName in interface ModelObject

Specified by:

getDisplayName in interface ResourceActivity

Overrides:

getDisplayName in class AbstractItem

getACL

public ACL getACL()

Specified by:

getACL in interface AccessControlled

Overrides:

getACL in class AbstractItem