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.

Extending Folders UI
As any other Item type, folder types support extension of UI via Actions. These actions can be persisted or added via TransientActionFactory. See this page for more details about actions. In folders actions provide the following features:

• Left sidepanel hyperlink, which opens the page specified by action's index.jelly.
• Optional summary boxes on the main panel, which may be defined by summary.jelly.

Since:

4.11-beta-1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractFolder.ItemListenerImpl
static class	AbstractFolder.RunListenerImpl

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	addAction(hudson.model.Action a)
boolean	addOrReplaceAction(hudson.model.Action a) Add an action, replacing any existing actions of the (exact) same class.
void	addProperty(AbstractFolderProperty p)
void	addView(hudson.model.View v)
boolean	canDelete(hudson.model.View view)
void	delete()
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)
org.kohsuke.stapler.HttpResponse	doDisable() Stapler action method to disable the folder.
void	doDoRename(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
org.kohsuke.stapler.HttpResponse	doEnable() Stapler action method to enable the folder.
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()
AbstractFolderViewHolder	getFolderViews()
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.
protected String	getSuccessfulDestination() Where user will be redirected after creating or reconfiguring a AbstractFolder.
String	getUrlChildPrefix() It is unwise to override this, lest links to children from nondefault Views break.
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)
void	invalidateBuildHealthReports() Invalidates the cache of build health reports.
boolean	isDisabled() Is this folder disabled.
protected I	itemsPut(String name, I item)
static <K,V extends hudson.model.TopLevelItem> Map<K,V>	loadChildren(AbstractFolder<V> parent, File modulesDir, hudson.util.Function1<? extends K,? super V> key) Loads all the child Items.
static void	loadJobTotal()
void	makeDisabled(boolean disabled) Makes the folder disabled.
protected hudson.search.SearchIndexBuilder	makeSearchIndex()
protected FolderIcon	newDefaultFolderIcon()
protected hudson.views.DefaultViewsTabBar	newDefaultViewsTabBar()
protected AbstractFolderViewHolder	newFolderViewHolder()
void	onDeleted(I item)
void	onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent, String name)
void	onRenamed(I item, String oldName, String newName)
void	onViewRenamed(hudson.model.View view, String oldName, String newName)
boolean	removeAction(hudson.model.Action a) Remove an action.
boolean	removeActions(Class<? extends hudson.model.Action> clazz) Removes any actions of the specified type.
protected String	renameBlocker() Allows a subclass to block renames under dynamic conditions.
void	renameTo(String newName) Renames this item container.
void	replaceAction(hudson.model.Action a)
boolean	replaceActions(Class<? extends hudson.model.Action> clazz, hudson.model.Action a) Replaces any actions of the specified type by the supplied action.
void	resetFolderViews()
void	save()
protected void	setDisabled(boolean disabled) Sets the folder as disabled.
void	setIcon(FolderIcon icon)
void	setPrimaryView(hudson.model.View v)
protected void	submit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
protected boolean	supportsMakeDisabled() Determines whether the folder supports being made disabled.

Methods inherited from class hudson.model.AbstractItem

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

Methods inherited from class hudson.model.Actionable

doContextMenu, getAction, getAction, getActions, getActions, getAllActions, getDynamic

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

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().

Parameters:

parent - the parent of this folder.

name - the name

Method Detail

loadJobTotal

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

init

protected void init()

newDefaultViewsTabBar

protected hudson.views.DefaultViewsTabBar newDefaultViewsTabBar()

newFolderViewHolder

protected AbstractFolderViewHolder newFolderViewHolder()

newDefaultFolderIcon

protected FolderIcon newDefaultFolderIcon()

initViews

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

Throws:

IOException

addAction

public void addAction(hudson.model.Action a)

Overrides:

addAction in class hudson.model.Actionable

replaceAction

public void replaceAction(hudson.model.Action a)

Overrides:

replaceAction in class hudson.model.Actionable

addOrReplaceAction

public boolean addOrReplaceAction(@Nonnull
                                  hudson.model.Action a)

Add an action, replacing any existing actions of the (exact) same class. Note: calls to Actionable.getAllActions() that happen before calls to this method may not see the update. Note: this method does not affect transient actions contributed by a TransientActionFactory

Parameters:

a - an action to add/replace

Returns:

true if this actions changed as a result of the call

Since:

FIXME

removeAction

public boolean removeAction(@Nullable
                            hudson.model.Action a)

Remove an action. Note: calls to Actionable.getAllActions() that happen before calls to this method may not see the update. Note: this method does not affect transient actions contributed by a TransientActionFactory

Parameters:

a - an action to remove (if null then this will be a no-op)

Returns:

true if this actions changed as a result of the call

Since:

FIXME

removeActions

public boolean removeActions(@Nonnull
                             Class<? extends hudson.model.Action> clazz)

Removes any actions of the specified type. Note: calls to Actionable.getAllActions() that happen before calls to this method may not see the update. Note: this method does not affect transient actions contributed by a TransientActionFactory

Parameters:

clazz - the type of actions to remove

Returns:

true if this actions changed as a result of the call

Since:

FIXME

replaceActions

public boolean replaceActions(@Nonnull
                              Class<? extends hudson.model.Action> clazz,
                              hudson.model.Action a)

Replaces any actions of the specified type by the supplied action. Note: calls to Actionable.getAllActions() that happen before calls to this method may not see the update. Note: this method does not affect transient actions contributed by a TransientActionFactory

Parameters:

clazz - the type of actions to replace (note that the action you are replacing this with need not extend this class)

a - the action to replace with

Returns:

true if this actions changed as a result of the call

Since:

FIXME

loadChildren

public static <K,V extends hudson.model.TopLevelItem> Map<K,V> loadChildren(AbstractFolder<V> parent,
                                                                            File modulesDir,
                                                                            hudson.util.Function1<? extends K,? super V> key)

Loads all the child Items.

Type Parameters:

K - the key type

V - the child type.

Parameters:

parent - the parent of the children.

modulesDir - Directory that contains sub-directories for each child item.

key - the key generating function.

Returns:

a map of the children keyed by the generated keys.

itemsPut

protected final I itemsPut(String name,
                           I item)

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

Returns:

the list of properties.

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.

Returns:

the jobs directory.

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()

It is unwise to override this, lest links to children from nondefault Views break. TODO remove this warning if and when JENKINS-35243 is fixed in the baseline.

Specified by:

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

getJob

public I getJob(String name)

For URL binding.

Parameters:

name - the name of the child.

Returns:

the job or null if there is no such child.

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

getFolderViews

public AbstractFolderViewHolder getFolderViews()

resetFolderViews

public void resetFolderViews()

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.

Parameters:

value - the name of the child.

Returns:

the validation results.

getBuildHealth

public hudson.model.HealthReport getBuildHealth()

Get the current health report for a folder.

Returns:

the health report. Never returns null

invalidateBuildHealthReports

public void invalidateBuildHealthReports()

Invalidates the cache of build health reports.

Since:

FIXME

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.

Returns:

the icon.

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(I 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(I item)
               throws IOException

Specified by:

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

Throws:

IOException

delete

public void delete()
            throws IOException,
                   InterruptedException

Specified by:

delete in interface hudson.model.Item

Overrides:

delete in class hudson.model.AbstractItem

Throws:

IOException

InterruptedException

isDisabled

public boolean isDisabled()

Is this folder disabled. A disabled folder should have all child items disabled.

Returns:

true if and only if the folder is disabled.

Since:

6.1.0

See Also:

FolderJobQueueDecisionHandler

setDisabled

protected void setDisabled(boolean disabled)

Sets the folder as disabled.

Parameters:

disabled - true if and only if the folder is to be disabled.

Since:

6.1.0

supportsMakeDisabled

protected boolean supportsMakeDisabled()

Determines whether the folder supports being made disabled.

Returns:

true if and only if setDisabled(boolean) is implemented

Since:

6.1.0

makeDisabled

public void makeDisabled(boolean disabled)
                  throws IOException

Makes the folder disabled. Will have no effect if the folder type does not supportsMakeDisabled().

Parameters:

disabled - true if the folder should be disabled.

Throws:

IOException - if the operation could not complete.

Since:

6.1.0

doDisable

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public org.kohsuke.stapler.HttpResponse doDisable()
                                                                                                                  throws IOException,
                                                                                                                         javax.servlet.ServletException

Stapler action method to disable the folder.

Returns:

the response.

Throws:

IOException - if the folder could not be disabled.

javax.servlet.ServletException - if something goes wrong.

Since:

6.1.0

doEnable

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public org.kohsuke.stapler.HttpResponse doEnable()
                                                                                                                 throws IOException,
                                                                                                                        javax.servlet.ServletException

Stapler action method to enable the folder.

Returns:

the response.

Throws:

IOException - if the folder could not be disabled.

javax.servlet.ServletException - if something goes wrong.

Since:

6.1.0

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

getSuccessfulDestination

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @Nonnull
protected String getSuccessfulDestination()

Where user will be redirected after creating or reconfiguring a AbstractFolder.

Returns:

A string that represents the redirect location URL.

See Also:

HttpServletResponse.sendRedirect(String)

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