Package com.cloudbees.hudson.plugins.folder.computed

Class ComputedFolder<I extends 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:

ExtensionPoint, BuildableItem, Describable<TopLevelItem>, DescriptorByNameOwner, Item, ItemGroup<I>, ModelObject, ModifiableViewGroup, PersistenceRoot, Queue.FlyweightTask, SubTask, Queue.Task, ResourceActivity, Saveable, TopLevelItem, ViewGroup, SearchableModelObject, SearchItem, AccessControlled, Loadable, ModelObjectWithChildren, ModelObjectWithContextMenu, TriggeredItem, OnMaster, IconSpec, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerFallback, org.kohsuke.stapler.StaplerOverridable, org.kohsuke.stapler.StaplerProxy

public abstract class ComputedFolder<I extends TopLevelItem>
extends AbstractFolder<I>
implements BuildableItem, TriggeredItem, 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 class com.cloudbees.hudson.plugins.folder.AbstractFolder

AbstractFolder.ItemListenerImpl, AbstractFolder.RunListenerImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface org.kohsuke.stapler.HttpDeletable

org.kohsuke.stapler.HttpDeletable.HttpDeletableDispatcher

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

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem, ModelObjectWithContextMenu.MenuItemType

Field Summary

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

items, reloadingThis

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

Modifier	Constructor	Description
protected	ComputedFolder(ItemGroup parent, String name)

Method Summary

Modifier and Type	Method	Description
void	addTrigger(Trigger trigger)	Update an existing trigger or add a new one.
void	checkAbortPermission()
protected void	checkRename(String newName)
protected abstract void	computeChildren(ChildObserver<I> observer, TaskListener listener)	Called to (re-)compute the set of children of this folder.
protected FolderComputation<I>	createComputation(FolderComputation<I> previous)
protected final ChildObserver<I>	createEventsChildObserver()	Deprecated. use openEventsChildObserver()
final FolderComputation<I>	createExecutable()
org.kohsuke.stapler.HttpResponse	doBuild(TimeDuration delay)
void	doConfigSubmit(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
List<Action>	getActions()
Label	getAssignedLabel()
CauseOfBlockage	getCauseOfBlockage()
FolderComputation<I>	getComputation()	URL binding and other purposes.
protected File	getComputationDir()
long	getEstimatedDuration()
Node	getLastBuiltOn()
PseudoRun<I>	getLastFailedBuild()
PseudoRun<I>	getLastStableBuild()
PseudoRun<I>	getLastSuccessfulBuild()
OrphanedItemStrategy	getOrphanedItemStrategy()
List<OrphanedItemStrategyDescriptor>	getOrphanedItemStrategyDescriptors()	Gets the OrphanedItemStrategyDescriptors applicable to this folder.
protected final String	getSuccessfulDestination()	Where user will be redirected after creating or reconfiguring a AbstractFolder.
List<TriggerDescriptor>	getTriggerDescriptors()
Map<TriggerDescriptor,Trigger<?>>	getTriggers()
boolean	hasAbortPermission()
protected void	init()
boolean	isBuildable()	Whether it is permissible to recompute this folder at this time.
boolean	isDisabled()	Is this folder disabled.
boolean	isHasEvents()	Identifies if this ComputedFolder has a separate out of band events log.
void	onCreatedFromScratch()
void	onLoad(ItemGroup<? extends Item> parent, String name)
protected final ChildObserver<I>	openEventsChildObserver()	Opens a new ChildObserver that subclasses can use when handling events that might create new / update existing child items.
protected Collection<I>	orphanedItems(Collection<I> orphaned, TaskListener listener)	Hook called when some items are no longer in the list.
protected final void	recalculateAfterSubmitted(boolean recalculate)	Method for child classes to use if they want to suppress/confirm the automatic recalculation provided in doConfigSubmit(StaplerRequest2, StaplerResponse2).
void	removeTrigger(Trigger trigger)	Remove an existing trigger.
boolean	scheduleBuild(int quietPeriod, Cause c)
boolean	scheduleBuild(Cause c)
Queue.Item	scheduleBuild2(int quietPeriod, Action... actions)	Duck-types ParameterizedJobMixIn.scheduleBuild2(int, Action...).
protected void	setDisabled(boolean disabled)	Sets the folder as disabled.
void	setOrphanedItemStrategy(OrphanedItemStrategy strategy)
protected void	submit(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
protected void	submit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)	Deprecated. use submit(StaplerRequest2, StaplerResponse2)
boolean	supportsMakeDisabled()	Determines whether the folder supports being made disabled.

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

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

Methods inherited from class hudson.model.AbstractItem

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

Methods inherited from class hudson.model.Actionable

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

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, requirePOST, sendError, sendError, sendError, 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.security.AccessControlled

checkAnyPermission, checkPermission, getACL, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface hudson.model.BuildableItem

scheduleBuild, scheduleBuild

Methods inherited from interface hudson.model.DescriptorByNameOwner

getDescriptorByName

Methods inherited from interface hudson.model.Item

delete, getAbsoluteUrl, getAllJobs, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl, onCopiedFrom, save

Methods inherited from interface hudson.model.ItemGroup

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

Methods inherited from interface hudson.model.PersistenceRoot

getRootDir

Methods inherited from interface hudson.model.Queue.Task

getAffinityKey, getDefaultAuthentication, getDefaultAuthentication, getDefaultAuthentication2, getDefaultAuthentication2, getFullDisplayName, getName, getSubTasks, getUrl, getWhyBlocked, isBuildBlocked, isConcurrentBuild

Methods inherited from interface hudson.model.ResourceActivity

getDisplayName, getResourceList

Methods inherited from interface hudson.search.SearchableModelObject

getSearch

Methods inherited from interface hudson.search.SearchItem

getSearchIndex, getSearchName, getSearchUrl

Methods inherited from interface hudson.model.queue.SubTask

getOwnerExecutable, getOwnerTask, getSameNodeConstraint

Methods inherited from interface hudson.model.ViewGroup

getAllViews, getUrl

Constructor Details

ComputedFolder

protected ComputedFolder(ItemGroup parent,
 String name)

Method Details

init

protected void init()

Overrides:

init in class AbstractFolder<I extends TopLevelItem>

onCreatedFromScratch

public void onCreatedFromScratch()

Specified by:

onCreatedFromScratch in interface Item

onLoad

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

Description copied from class: AbstractFolder

Specified by:

onLoad in interface Item

Overrides:

onLoad in class AbstractFolder<I extends TopLevelItem>

Throws:

IOException

computeChildren

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

Called to (re-)compute the set of children of this folder. It is recommended that the computation checks the Thread.interrupted() status and throws a InterruptedException if set at least once every 5 seconds to allow the user to interrupt a computation..

Parameters:

observer - how to indicate which children should be seen

listener - a way to report progress

Throws:

IOException - if there was an IOException during the computation.

InterruptedException - if the computation was interrupted.

orphanedItems

protected Collection<I> orphanedItems(Collection<I> orphaned,
 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

listener - the listener to report decisions to.

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

Throws:

IOException - if there was an I/O issue processing the items.

InterruptedException - if interrupted while processing the items.

setOrphanedItemStrategy

public void setOrphanedItemStrategy(@NonNull
 OrphanedItemStrategy strategy)

createEventsChildObserver

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
protected final ChildObserver<I> createEventsChildObserver()

Deprecated.

use openEventsChildObserver()

Creates a ChildObserver that subclasses can use when handling events that might create new / update existing child items. The handling of orphaned items is a responsibility of the OrphanedItemStrategy which is only applied as part of a full computation.

Returns:

a ChildObserver for event handling.

openEventsChildObserver

protected final ChildObserver<I> openEventsChildObserver()

Opens a new ChildObserver that subclasses can use when handling events that might create new / update existing child items. The handling of orphaned items is a responsibility of the OrphanedItemStrategy which is only applied as part of a full computation.

Returns:

a ChildObserver for event handling. The caller must ChildObserver.close() when done.

Since:

6.0.0

isDisabled

public boolean isDisabled()

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

Overrides:

isDisabled in class AbstractFolder<I extends TopLevelItem>

Returns:

true if and only if the folder is disabled.

See Also:

• FolderJobQueueDecisionHandler

setDisabled

protected void setDisabled(boolean disabled)

Sets the folder as disabled.

Overrides:

setDisabled in class AbstractFolder<I extends TopLevelItem>

Parameters:

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

supportsMakeDisabled

public boolean supportsMakeDisabled()

Determines whether the folder supports being made disabled.

Overrides:

supportsMakeDisabled in class AbstractFolder<I extends TopLevelItem>

Returns:

true if and only if AbstractFolder.setDisabled(boolean) is implemented

doConfigSubmit

public void doConfigSubmit(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                    throws IOException,
jakarta.servlet.ServletException,
Descriptor.FormException

Overrides:

doConfigSubmit in class AbstractFolder<I extends TopLevelItem>

Throws:

IOException

jakarta.servlet.ServletException

Descriptor.FormException

recalculateAfterSubmitted

protected final void recalculateAfterSubmitted(boolean recalculate)

Method for child classes to use if they want to suppress/confirm the automatic recalculation provided in doConfigSubmit(StaplerRequest2, StaplerResponse2). This method should only be called from submit(StaplerRequest2, StaplerResponse2). If called multiple times from submit(StaplerRequest2, StaplerResponse2) then all calls must be with the false parameter to suppress recalculation.

Parameters:

recalculate - true to require recalculation, false to suppress recalculation.

See Also:

• submit(StaplerRequest2, StaplerResponse2)

submit

protected void submit(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
               throws IOException,
jakarta.servlet.ServletException,
Descriptor.FormException

Overrides:

submit in class AbstractFolder<I extends TopLevelItem>

Throws:

IOException

jakarta.servlet.ServletException

Descriptor.FormException

See Also:

• recalculateAfterSubmitted(boolean)

submit

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

Deprecated.

use submit(StaplerRequest2, StaplerResponse2)

Overrides:

submit in class AbstractFolder<I extends TopLevelItem>

Throws:

IOException

javax.servlet.ServletException

Descriptor.FormException

getSuccessfulDestination

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@NonNull
protected final String getSuccessfulDestination()

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

Overrides:

getSuccessfulDestination in class AbstractFolder<I extends TopLevelItem>

Returns:

A string that represents the redirect location URL.

See Also:

• HttpServletResponse.sendRedirect(String)

getTriggers

public Map<TriggerDescriptor,Trigger<?>> getTriggers()

Specified by:

getTriggers in interface TriggeredItem

getTriggerDescriptors

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public List<TriggerDescriptor> getTriggerDescriptors()

addTrigger

public void addTrigger(Trigger trigger)

Update an existing trigger or add a new one.

Parameters:

trigger - Target trigger instance.

removeTrigger

public void removeTrigger(Trigger trigger)

Remove an existing trigger.

Parameters:

trigger - Target trigger instance.

getActions

public List<Action> getActions()

Overrides:

getActions in class Actionable

isBuildable

@Exported
public boolean isBuildable()

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

Returns:

true if this folder can currently be recomputed.

doBuild

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

scheduleBuild2

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

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

Parameters:

quietPeriod - seconds to wait before starting (normally 0)

actions - various actions to associate with the scheduling, such as ParametersAction or CauseAction

Returns:

a handle by which you may wait for the build to complete (or just start); or null if the build was not actually scheduled for some reason

scheduleBuild

public boolean scheduleBuild(Cause c)

Specified by:

scheduleBuild in interface BuildableItem

scheduleBuild

public boolean scheduleBuild(int quietPeriod,
 Cause c)

Specified by:

scheduleBuild in interface BuildableItem

getCauseOfBlockage

public CauseOfBlockage getCauseOfBlockage()

Specified by:

getCauseOfBlockage in interface Queue.Task

checkAbortPermission

public void checkAbortPermission()

Specified by:

checkAbortPermission in interface Queue.Task

hasAbortPermission

public boolean hasAbortPermission()

Specified by:

hasAbortPermission in interface Queue.Task

getAssignedLabel

public Label getAssignedLabel()

Specified by:

getAssignedLabel in interface SubTask

getLastBuiltOn

public Node getLastBuiltOn()

Specified by:

getLastBuiltOn in interface SubTask

getEstimatedDuration

public long getEstimatedDuration()

Specified by:

getEstimatedDuration in interface SubTask

createExecutable

public final FolderComputation<I> createExecutable()
                                            throws IOException

Specified by:

createExecutable in interface SubTask

Throws:

IOException

createComputation

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

getComputationDir

protected File getComputationDir()

isHasEvents

public boolean isHasEvents()

Identifies if this ComputedFolder has a separate out of band events log. Default implementation just checks if the events log has content. Subclasses can override this method to force the events log always present in the UI.

Returns:

true if this ComputedFolder has a separate out of band events log.

getComputation

@NonNull
public FolderComputation<I> getComputation()

URL binding and other purposes. It may be null temporarily inside the constructor, so beware if you extend this class.

Returns:

the computation.

getLastSuccessfulBuild

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public PseudoRun<I> getLastSuccessfulBuild()

getLastStableBuild

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public PseudoRun<I> getLastStableBuild()

getLastFailedBuild

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public PseudoRun<I> getLastFailedBuild()

checkRename

protected void checkRename(String newName)

Overrides:

checkRename in class AbstractFolder<I extends TopLevelItem>

getOrphanedItemStrategy

@NonNull
public OrphanedItemStrategy getOrphanedItemStrategy()

getOrphanedItemStrategyDescriptors

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

Gets the OrphanedItemStrategyDescriptors applicable to this folder.

Returns:

the OrphanedItemStrategyDescriptors applicable to this folder.