com.cloudbees.hudson.plugins.folder

Class AbstractFolder<I extends hudson.model.TopLevelItem>

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.AbstractItem

com.cloudbees.hudson.plugins.folder.AbstractFolder<I>

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.TopLevelItem>, hudson.model.DescriptorByNameOwner, hudson.model.Item, hudson.model.ItemGroup<I>, hudson.model.ModelObject, hudson.model.ModifiableViewGroup, hudson.model.PersistenceRoot, hudson.model.Saveable, hudson.model.TopLevelItem, hudson.model.ViewGroup, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, jenkins.model.ModelObjectWithChildren, jenkins.model.ModelObjectWithContextMenu, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerFallback, org.kohsuke.stapler.StaplerOverridable

Direct Known Subclasses:

ComputedFolder, Folder

public abstract class AbstractFolder<I extends hudson.model.TopLevelItem>
extends hudson.model.AbstractItem
implements hudson.model.TopLevelItem, hudson.model.ItemGroup<I>, hudson.model.ModifiableViewGroup, org.kohsuke.stapler.StaplerFallback, jenkins.model.ModelObjectWithChildren, org.kohsuke.stapler.StaplerOverridable

A general-purpose ItemGroup. Base for Folder and ComputedFolder.

Since:

4.11-beta-1

Nested Class Summary

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 Map<String,I>	items Child items, keyed by Item.getName().

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

Modifier	Constructor and Description
protected	AbstractFolder(hudson.model.ItemGroup parent, String name) Subclasses should also call init().

Method Summary

Modifier and Type	Method and Description
void	addProperty(AbstractFolderProperty p)
void	addView(hudson.model.View v)
boolean	canDelete(hudson.model.View view)
void	deleteView(hudson.model.View view)
jenkins.model.ModelObjectWithContextMenu.ContextMenu	doChildrenContextMenu(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response)
void	doConfigSubmit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
void	doCreateView(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
void	doDoRename(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
org.kohsuke.stapler.HttpResponse	doLastBuild(org.kohsuke.stapler.StaplerRequest req)
void	doSubmitDescription(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
hudson.util.FormValidation	doViewExistsCheck(String value) Checks if a top-level view with the given name exists.
Collection<? extends hudson.model.Job>	getAllJobs()
hudson.model.HealthReport	getBuildHealth() Get the current health report for a folder.
List<hudson.model.HealthReport>	getBuildHealthReports()
AbstractFolderDescriptor	getDescriptor()
hudson.util.DescribableList<FolderHealthMetric,FolderHealthMetricDescriptor>	getHealthMetrics()
FolderIcon	getIcon() Gets the icon used for this folder.
FolderIcon	getIconColor()
I	getItem(String name)
hudson.model.ItemGroup<? extends hudson.model.TopLevelItem>	getItemGroup()
Collection<I>	getItems()
I	getJob(String name) For URL binding.
protected File	getJobsDir() May be overridden, but loadJobTotal() will be inaccurate in that case.
Collection<?>	getOverrides() Overrides from job properties.
hudson.model.View	getPrimaryView()
String	getPronoun()
hudson.util.DescribableList<AbstractFolderProperty<?>,AbstractFolderPropertyDescriptor>	getProperties() May be used to enumerate or remove properties.
File	getRootDirFor(I child)
protected File	getRootDirFor(String name)
hudson.model.View	getStaplerFallback() Fallback to the primary view.
String	getUrlChildPrefix()
hudson.model.View	getView(String name)
List<hudson.model.Action>	getViewActions()
Collection<hudson.model.View>	getViews()
hudson.views.ViewsTabBar	getViewsTabBar()
protected void	init()
protected void	initViews(List<hudson.model.View> views)
static void	loadJobTotal()
protected hudson.search.SearchIndexBuilder	makeSearchIndex()
void	onDeleted(hudson.model.TopLevelItem item)
void	onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent, String name)
void	onRenamed(hudson.model.TopLevelItem item, String oldName, String newName)
void	onViewRenamed(hudson.model.View view, String oldName, String newName)
protected void	performDelete()
protected String	renameBlocker() Allows a subclass to block renames under dynamic conditions.
void	renameTo(String newName) Renames this item container.
void	save()
void	setIcon(FolderIcon icon)
void	setPrimaryView(hudson.model.View v)
protected void	submit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)

Methods inherited from class hudson.model.AbstractItem

checkPermission, delete, delete, doConfigDotXml, doDoDelete, doReload, doSetName, getAbsoluteUrl, getACL, getApi, getConfigFile, getDescription, getDescriptorByName, getDisplayName, getDisplayNameOrNull, getFullDisplayName, getFullName, getName, getParent, getRelativeDisplayNameFrom, getRelativeNameFrom, getRelativeNameFrom, getRelativeNameFromGroup, getRootDir, getSearchName, getSearchUrl, getShortUrl, getUrl, hasPermission, movedTo, onCopiedFrom, onCreatedFromScratch, resolveForCLI, 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, 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, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl, onCopiedFrom, onCreatedFromScratch

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

getFullDisplayName, getFullName, getUrl

Methods inherited from interface hudson.model.ViewGroup

getUrl

Methods inherited from interface hudson.security.AccessControlled

checkPermission, getACL, hasPermission

Field Detail

items

protected transient Map<String,I extends hudson.model.TopLevelItem> items

Child items, keyed by Item.getName().

Constructor Detail

AbstractFolder

protected AbstractFolder(hudson.model.ItemGroup parent,
                         String name)

Subclasses should also call init().

Method Detail

loadJobTotal

@Initializer(before=JOB_LOADED,
             fatal=false)
public static void loadJobTotal()

init

protected void init()

initViews

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

Throws:

IOException

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

getDescriptor

public AbstractFolderDescriptor getDescriptor()

Specified by:

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

Specified by:

getDescriptor in interface hudson.model.TopLevelItem

getProperties

public hudson.util.DescribableList<AbstractFolderProperty<?>,AbstractFolderPropertyDescriptor> getProperties()

May be used to enumerate or remove properties. To add properties, use addProperty(com.cloudbees.hudson.plugins.folder.AbstractFolderProperty).

addProperty

public void addProperty(AbstractFolderProperty p)
                 throws IOException

Throws:

IOException

getJobsDir

protected File getJobsDir()

May be overridden, but loadJobTotal() will be inaccurate in that case.

getRootDirFor

protected final File getRootDirFor(String name)

getRootDirFor

public File getRootDirFor(I child)

Specified by:

getRootDirFor in interface hudson.model.ItemGroup<I extends hudson.model.TopLevelItem>

getUrlChildPrefix

public String getUrlChildPrefix()

Specified by:

getUrlChildPrefix in interface hudson.model.ItemGroup<I extends hudson.model.TopLevelItem>

getJob

public I getJob(String name)

For URL binding.

See Also:

getUrlChildPrefix()

getPronoun

public String getPronoun()

Overrides:

getPronoun in class hudson.model.AbstractItem

getOverrides

public Collection<?> getOverrides()

Overrides from job properties.

Specified by:

getOverrides in interface org.kohsuke.stapler.StaplerOverridable

addView

public void addView(hudson.model.View v)
             throws IOException

Specified by:

addView in interface hudson.model.ModifiableViewGroup

Throws:

IOException

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

getView

public hudson.model.View getView(String name)

Specified by:

getView in interface hudson.model.ViewGroup

getViews

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

Specified by:

getViews in interface hudson.model.ViewGroup

getPrimaryView

@Exported
public hudson.model.View getPrimaryView()

Specified by:

getPrimaryView in interface hudson.model.ViewGroup

setPrimaryView

public void setPrimaryView(hudson.model.View v)

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

getStaplerFallback

public hudson.model.View getStaplerFallback()

Fallback to the primary view.

Specified by:

getStaplerFallback in interface org.kohsuke.stapler.StaplerFallback

makeSearchIndex

protected hudson.search.SearchIndexBuilder makeSearchIndex()

Overrides:

makeSearchIndex in class hudson.model.AbstractModelObject

doChildrenContextMenu

public jenkins.model.ModelObjectWithContextMenu.ContextMenu doChildrenContextMenu(org.kohsuke.stapler.StaplerRequest request,
                                                                                  org.kohsuke.stapler.StaplerResponse response)

Specified by:

doChildrenContextMenu in interface jenkins.model.ModelObjectWithChildren

doCreateView

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

Throws:

IOException

javax.servlet.ServletException

ParseException

hudson.model.Descriptor.FormException

doViewExistsCheck

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

Checks if a top-level view with the given name exists.

getBuildHealth

public hudson.model.HealthReport getBuildHealth()

Get the current health report for a folder.

Returns:

the health report. Never returns null

getBuildHealthReports

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

getHealthMetrics

public hudson.util.DescribableList<FolderHealthMetric,FolderHealthMetricDescriptor> getHealthMetrics()

doLastBuild

public org.kohsuke.stapler.HttpResponse doLastBuild(org.kohsuke.stapler.StaplerRequest req)

getIcon

public FolderIcon getIcon()

Gets the icon used for this folder.

setIcon

public void setIcon(FolderIcon icon)

getIconColor

public FolderIcon getIconColor()

getAllJobs

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

Specified by:

getAllJobs in interface hudson.model.Item

Specified by:

getAllJobs in class hudson.model.AbstractItem

getItems

@Exported(name="jobs")
public Collection<I> getItems()

Specified by:

getItems in interface hudson.model.ItemGroup<I extends hudson.model.TopLevelItem>

getItem

public I getItem(String name)
          throws org.acegisecurity.AccessDeniedException

Specified by:

getItem in interface hudson.model.ItemGroup<I extends hudson.model.TopLevelItem>

Throws:

org.acegisecurity.AccessDeniedException

onRenamed

public void onRenamed(hudson.model.TopLevelItem item,
                      String oldName,
                      String newName)
               throws IOException

Specified by:

onRenamed in interface hudson.model.ItemGroup<I extends hudson.model.TopLevelItem>

Throws:

IOException

onDeleted

public void onDeleted(hudson.model.TopLevelItem item)
               throws IOException

Specified by:

onDeleted in interface hudson.model.ItemGroup<I extends hudson.model.TopLevelItem>

Throws:

IOException

performDelete

protected void performDelete()
                      throws IOException,
                             InterruptedException

Overrides:

performDelete in class hudson.model.AbstractItem

Throws:

IOException

InterruptedException

save

public void save()
          throws IOException

Specified by:

save in interface hudson.model.Item

Specified by:

save in interface hudson.model.Saveable

Overrides:

save in class hudson.model.AbstractItem

Throws:

IOException

renameTo

public void renameTo(String newName)
              throws IOException

Renames this item container.

Overrides:

renameTo in class hudson.model.AbstractItem

Throws:

IOException

doSubmitDescription

public void doSubmitDescription(org.kohsuke.stapler.StaplerRequest req,
                                org.kohsuke.stapler.StaplerResponse rsp)
                         throws IOException,
                                javax.servlet.ServletException

Overrides:

doSubmitDescription in class hudson.model.AbstractItem

Throws:

IOException

javax.servlet.ServletException

doConfigSubmit

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doConfigSubmit(org.kohsuke.stapler.StaplerRequest req,
                                                                                                  org.kohsuke.stapler.StaplerResponse rsp)
                                                                                           throws IOException,
                                                                                                  javax.servlet.ServletException,
                                                                                                  hudson.model.Descriptor.FormException

Throws:

IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

submit

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

Throws:

IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

doDoRename

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public void doDoRename(org.kohsuke.stapler.StaplerRequest req,
                                                                                         org.kohsuke.stapler.StaplerResponse rsp)
                                                                                  throws IOException,
                                                                                         javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

renameBlocker

@CheckForNull
protected String renameBlocker()

Allows a subclass to block renames under dynamic conditions.

Returns:

a message if rename should currently be prohibited, or null to allow