com.cloudbees.hudson.plugins.folder.computed

Class ComputedFolder<I extends hudson.model.TopLevelItem>

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<I>

Type Parameters:

I - the child item type

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.BuildableItem, 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.Queue.FlyweightTask, hudson.model.queue.SubTask, hudson.model.Queue.Task, hudson.model.ResourceActivity, 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

public abstract class ComputedFolder<I extends hudson.model.TopLevelItem>
extends AbstractFolder<I>
implements hudson.model.BuildableItem, hudson.model.Queue.FlyweightTask

A folder-like item whose children are computed. Users cannot directly add or remove (or rename) children. The children should also not offer Item.CONFIGURE to anyone.

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 inherited from class com.cloudbees.hudson.plugins.folder.AbstractFolder

items

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	ComputedFolder(hudson.model.ItemGroup parent, String name)

Method Summary

Modifier and Type	Method and Description
void	addTrigger(hudson.triggers.Trigger trigger)
void	checkAbortPermission()
protected abstract void	computeChildren(ChildObserver<I> observer, hudson.model.TaskListener listener) Called to (re-)compute the set of children of this folder.
protected FolderComputation<I>	createComputation(FolderComputation<I> previous)
FolderComputation<I>	createExecutable()
org.kohsuke.stapler.HttpResponse	doBuild(jenkins.util.TimeDuration delay)
void	doConfigSubmit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
List<hudson.model.Action>	getActions()
hudson.model.Label	getAssignedLabel()
hudson.model.queue.CauseOfBlockage	getCauseOfBlockage()
FolderComputation<I>	getComputation() URL binding and other purposes.
protected File	getComputationDir()
org.acegisecurity.Authentication	getDefaultAuthentication()
org.acegisecurity.Authentication	getDefaultAuthentication(hudson.model.Queue.Item item)
long	getEstimatedDuration()
hudson.model.Node	getLastBuiltOn()
OrphanedItemStrategy	getOrphanedItemStrategy()
List<OrphanedItemStrategyDescriptor>	getOrphanedItemStrategyDescriptors() Gets the OrphanedItemStrategyDescriptors applicable to this folder.
hudson.model.Queue.Task	getOwnerTask()
hudson.model.ResourceList	getResourceList()
Object	getSameNodeConstraint()
Collection<? extends hudson.model.queue.SubTask>	getSubTasks()
Map<hudson.triggers.TriggerDescriptor,hudson.triggers.Trigger<?>>	getTriggers()
String	getWhyBlocked() Deprecated.
boolean	hasAbortPermission()
protected void	init()
boolean	isBuildable() Whether it is permissible to recompute this folder at this time.
boolean	isBuildBlocked()
boolean	isConcurrentBuild()
protected Collection<I>	orphanedItems(Collection<I> orphaned, hudson.model.TaskListener listener) Hook called when some items are no longer in the list.
protected String	renameBlocker() Allows a subclass to block renames under dynamic conditions.
boolean	scheduleBuild()
boolean	scheduleBuild(hudson.model.Cause c)
boolean	scheduleBuild(int quietPeriod)
boolean	scheduleBuild(int quietPeriod, hudson.model.Cause c)
hudson.model.Queue.Item	scheduleBuild2(int quietPeriod, hudson.model.Action... actions) Duck-types ParameterizedJobMixIn.scheduleBuild2(int, Action...).
protected void	submit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)

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

addProperty, addView, canDelete, deleteView, doChildrenContextMenu, doCreateView, doDoRename, doLastBuild, doSubmitDescription, doViewExistsCheck, getAllJobs, getBuildHealth, getBuildHealthReports, getDescriptor, getHealthMetrics, getIcon, getIconColor, getItem, getItemGroup, getItems, getJob, getJobsDir, getOverrides, getPrimaryView, getPronoun, getProperties, getRootDirFor, getRootDirFor, getStaplerFallback, getUrlChildPrefix, getView, getViewActions, getViews, getViewsTabBar, initViews, loadJobTotal, makeSearchIndex, onDeleted, onLoad, onRenamed, onViewRenamed, performDelete, renameTo, save, setIcon, setPrimaryView

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, 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, getAllJobs, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl, onCopiedFrom, onCreatedFromScratch, onLoad, 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.Queue.Task

getFullDisplayName, getName, getUrl

Methods inherited from interface hudson.model.ResourceActivity

getDisplayName

Methods inherited from interface hudson.model.ItemGroup

getFullDisplayName, getFullName, getUrl

Methods inherited from interface hudson.model.ViewGroup

getUrl

Constructor Detail

ComputedFolder

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

Method Detail

init

protected final void init()

Overrides:

init in class AbstractFolder<I extends hudson.model.TopLevelItem>

computeChildren

protected abstract void computeChildren(ChildObserver<I> observer,
                                        hudson.model.TaskListener listener)
                                 throws IOException,
                                        InterruptedException

Called to (re-)compute the set of children of this folder.

Parameters:

observer - how to indicate which children should be seen

listener - a way to report progress

Throws:

IOException

InterruptedException

orphanedItems

protected Collection<I> orphanedItems(Collection<I> orphaned,
                                      hudson.model.TaskListener listener)
                               throws IOException,
                                      InterruptedException

Hook called when some items are no longer in the list. Do not call Item.delete() or ItemGroup.onDeleted(T) or ItemListener.fireOnDeleted(hudson.model.Item) yourself. By default, uses getOrphanedItemStrategy().

Parameters:

orphaned - a nonempty set of items which no longer are supposed to be here

Returns:

any subset of orphaned, representing those children which ought to be removed from the folder now; items not listed will be left alone for the time being

Throws:

IOException

InterruptedException

doConfigSubmit

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

Overrides:

doConfigSubmit in class AbstractFolder<I extends hudson.model.TopLevelItem>

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

Overrides:

submit in class AbstractFolder<I extends hudson.model.TopLevelItem>

Throws:

IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

getTriggers

public Map<hudson.triggers.TriggerDescriptor,hudson.triggers.Trigger<?>> getTriggers()

addTrigger

public void addTrigger(hudson.triggers.Trigger trigger)

getActions

public List<hudson.model.Action> getActions()

Overrides:

getActions in class hudson.model.Actionable

isBuildable

public boolean isBuildable()

Whether it is permissible to recompute this folder at this time.

doBuild

public org.kohsuke.stapler.HttpResponse doBuild(@QueryParameter
                                                jenkins.util.TimeDuration delay)

scheduleBuild2

@CheckForNull
public hudson.model.Queue.Item scheduleBuild2(int quietPeriod,
                                                            hudson.model.Action... actions)

Duck-types ParameterizedJobMixIn.scheduleBuild2(int, Action...).

scheduleBuild

public boolean scheduleBuild()

Specified by:

scheduleBuild in interface hudson.model.BuildableItem

scheduleBuild

public boolean scheduleBuild(hudson.model.Cause c)

Specified by:

scheduleBuild in interface hudson.model.BuildableItem

scheduleBuild

public boolean scheduleBuild(int quietPeriod)

Specified by:

scheduleBuild in interface hudson.model.BuildableItem

scheduleBuild

public boolean scheduleBuild(int quietPeriod,
                             hudson.model.Cause c)

Specified by:

scheduleBuild in interface hudson.model.BuildableItem

isBuildBlocked

public boolean isBuildBlocked()

Specified by:

isBuildBlocked in interface hudson.model.Queue.Task

getWhyBlocked

@Deprecated
public String getWhyBlocked()

Deprecated.

Specified by:

getWhyBlocked in interface hudson.model.Queue.Task

getCauseOfBlockage

public hudson.model.queue.CauseOfBlockage getCauseOfBlockage()

Specified by:

getCauseOfBlockage in interface hudson.model.Queue.Task

checkAbortPermission

public void checkAbortPermission()

Specified by:

checkAbortPermission in interface hudson.model.Queue.Task

hasAbortPermission

public boolean hasAbortPermission()

Specified by:

hasAbortPermission in interface hudson.model.Queue.Task

isConcurrentBuild

public boolean isConcurrentBuild()

Specified by:

isConcurrentBuild in interface hudson.model.Queue.Task

getSubTasks

public Collection<? extends hudson.model.queue.SubTask> getSubTasks()

Specified by:

getSubTasks in interface hudson.model.Queue.Task

getDefaultAuthentication

public org.acegisecurity.Authentication getDefaultAuthentication()

Specified by:

getDefaultAuthentication in interface hudson.model.Queue.Task

getDefaultAuthentication

public org.acegisecurity.Authentication getDefaultAuthentication(hudson.model.Queue.Item item)

Specified by:

getDefaultAuthentication in interface hudson.model.Queue.Task

getAssignedLabel

public hudson.model.Label getAssignedLabel()

Specified by:

getAssignedLabel in interface hudson.model.queue.SubTask

getLastBuiltOn

public hudson.model.Node getLastBuiltOn()

Specified by:

getLastBuiltOn in interface hudson.model.queue.SubTask

getEstimatedDuration

public long getEstimatedDuration()

Specified by:

getEstimatedDuration in interface hudson.model.queue.SubTask

createExecutable

public final FolderComputation<I> createExecutable()
                                            throws IOException

Specified by:

createExecutable in interface hudson.model.queue.SubTask

Throws:

IOException

createComputation

@Nonnull
protected FolderComputation<I> createComputation(@CheckForNull
                                                          FolderComputation<I> previous)

getOwnerTask

public hudson.model.Queue.Task getOwnerTask()

Specified by:

getOwnerTask in interface hudson.model.queue.SubTask

getSameNodeConstraint

public Object getSameNodeConstraint()

Specified by:

getSameNodeConstraint in interface hudson.model.queue.SubTask

getResourceList

public hudson.model.ResourceList getResourceList()

Specified by:

getResourceList in interface hudson.model.ResourceActivity

getComputationDir

protected File getComputationDir()

getComputation

@CheckForNull
public FolderComputation<I> getComputation()

URL binding and other purposes.

renameBlocker

protected String renameBlocker()

Description copied from class: AbstractFolder

Allows a subclass to block renames under dynamic conditions.

Overrides:

renameBlocker in class AbstractFolder<I extends hudson.model.TopLevelItem>

Returns:

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

getOrphanedItemStrategy

@NonNull
public OrphanedItemStrategy getOrphanedItemStrategy()

getOrphanedItemStrategyDescriptors

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
 @NonNull
public List<OrphanedItemStrategyDescriptor> getOrphanedItemStrategyDescriptors()

Gets the OrphanedItemStrategyDescriptors applicable to this folder.