Package hudson.ivy
Class IvyModuleSet
- All Implemented Interfaces:
ExtensionPoint,BuildableItem,BuildableItemWithBuildWrappers,Describable<TopLevelItem>,DescriptorByNameOwner,Item,ItemGroup<IvyModule>,ModelObject,PersistenceRoot,SubTask,Queue.Task,ResourceActivity,Saveable,SCMedItem,TopLevelItem,SearchableModelObject,SearchItem,AccessControlled,LazyBuildMixIn.LazyLoadingJob<IvyModuleSet,,IvyModuleSetBuild> Loadable,ModelObjectWithChildren,ModelObjectWithContextMenu,ParameterizedJobMixIn.ParameterizedJob<IvyModuleSet,,IvyModuleSetBuild> TriggeredItem,OnMaster,HasWidgets,org.kohsuke.stapler.HttpDeletable,org.kohsuke.stapler.StaplerOverridable,org.kohsuke.stapler.StaplerProxy
public final class IvyModuleSet
extends AbstractIvyProject<IvyModuleSet,IvyModuleSetBuild>
implements TopLevelItem, ItemGroup<IvyModule>, SCMedItem, Saveable, BuildableItemWithBuildWrappers
Group of
IvyModules.
This corresponds to the group of Ivy module descriptors that constitute a single branch of projects.
- Author:
- Timothy Bingaman
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBecause one of our own modules is currently building.static final classNested classes/interfaces inherited from class hudson.model.AbstractProject
AbstractProject.AbstractProjectDescriptor, AbstractProject.BecauseOfBuildInProgress, AbstractProject.BecauseOfDownstreamBuildInProgress, AbstractProject.BecauseOfUpstreamBuildInProgress, AbstractProject.LabelValidatorNested classes/interfaces inherited from class hudson.model.Job
Job.LastItemListener, Job.SubItemBuildsLocationImplNested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudsonNested classes/interfaces inherited from interface org.kohsuke.stapler.HttpDeletable
org.kohsuke.stapler.HttpDeletable.HttpDeletableDispatcherNested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu
ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem, ModelObjectWithContextMenu.MenuItemType -
Field Summary
FieldsFields inherited from class hudson.model.AbstractProject
ABORT, blockBuildWhenDownstreamBuilding, blockBuildWhenUpstreamBuilding, BUILD_NOW_TEXT, builds, disabled, transientActions, triggersFields inherited from class hudson.model.Job
HISTORY_ADAPTER, nextBuildNumber, properties, runIdMigratorFields inherited from class hudson.model.AbstractItem
description, displayName, name, PRONOUN, SKIP_PERMISSION_CHECK, TASK_NOUN -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddTransientActionsFromBuild(IvyModuleSetBuild build, List<Action> collection, Set<Class> added) AbstractProject<?, ?> intTo make it easy to grasp relationship among modules and the module set, we'll align the build numbers of all the modules.protected voiddoCheckFileInWorkspace(String value) Check the location of the ivy descriptor file, alternate settings file, etc - any file.doCheckIvySettingsFile(String value) Check that the provided file exists, just in case.voiddoDoDeleteAllDisabledModules(org.kohsuke.stapler.StaplerResponse2 rsp) Delete all disabled modules.protected Class<IvyModuleSetBuild> Deprecated.getDisabledModules(boolean disabled) Possibly empty list of all disabled modules (if disabled==true) or all enabled modules (if disabled==false)getDynamic(String token, org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) getItems()Class<? extends AbstractProject> List of activePublishers that should be applied to all module builds.List of activePublishers.Returns theIvyModules that are in the queue.protected Set<ResourceActivity> getRootDirFor(IvyModule child) hudson.tasks.test.AbstractTestResultAction<?> booleanReturns true if there's any disabled module.booleanbooleanbooleanbooleanbooleanbooleanbooleanvoidprotected SearchIndexBuildervoidvoidvoidprotected Objectvoidsave()voidsetAggregatorStyleBuild(boolean aggregatorStyleBuild) voidsetAllowedToTriggerDownstream(boolean allowedToTriggerDownstream) voidsetIgnoreUpstreamChanges(boolean ignoreUpstreamChanges) voidsetIncrementalBuild(boolean incrementalBuild) voidsetIsArchivingDisabled(boolean archivingDisabled) voidsetIvyBranch(String ivyBranch) voidsetIvyFileExcludesPattern(String ivyFileExcludesPattern) voidsetIvyFilePattern(String ivyFilePattern) voidsetIvySettingsFile(String ivySettingsFile) voidsetIvySettingsPropertyFiles(String ivySettingsPropertyFiles) voidsetRelativePathToDescriptorFromModuleRoot(String relativePathToDescriptorFromModuleRoot) voidsetUseUpstreamParameters(boolean useUpstreamParameters) protected voidsubmit(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) protected voidMethods inherited from class hudson.ivy.AbstractIvyProject
scheduleBuildMethods inherited from class hudson.model.AbstractProject
_getRuns, addProperty, addToList, addTrigger, blockBuildWhenDownstreamBuilding, blockBuildWhenUpstreamBuilding, buildDescribable, buildDescribable, checkAbortPermission, checkout, createExecutable, disable, doBuild, doBuildWithParameters, doCheckRetryCount, doConfigSubmit, doDoWipeOutWorkspace, doPolling, doWs, enable, findNearest, findNearest, getActions, getAssignedLabel, getAssignedLabelString, getAuthToken, getBuild, getBuildByNumber, getBuildingDownstream, getBuildingUpstream, getBuildNowText, getBuildTriggerUpstreamProjects, getCustomWorkspace, getDelay, getDownstreamProjects, getDownstreamProjectsForApi, getEnvironment, getEstimatedDurationCandidates, getFirstBuild, getHasCustomQuietPeriod, getIconColor, getJDK, getLastBuild, getLastBuiltOn, getLazyBuildMixIn, getModuleRoot, getModuleRoots, getNearestBuild, getNearestOldBuild, getProminentActions, getPronoun, getQueueItem, getQuietPeriod, getRelationship, getRelevantLabels, getResourceList, getRootProject, getSameNodeConstraint, getScm, getScmCheckoutRetryCount, getScmCheckoutStrategy, getSomeBuildWithWorkspace, getSomeWorkspace, getSubTasks, getTransitiveDownstreamProjects, getTransitiveUpstreamProjects, getTrigger, getTriggers, getUpstreamProjects, getUpstreamProjectsForApi, getWorkspace, getWorkspaceResource, hasAbortPermission, hasCustomScmCheckoutRetryCount, hasParticipant, isBuildable, isConcurrentBuild, isConfigurable, isDisabled, isInQueue, loadBuild, newBuild, onCreatedFromScratch, performDelete, poll, pollSCMChanges, removeFromList, removeRun, removeTrigger, resolveForCLI, scheduleBuild, scheduleBuild2, scheduleBuild2, scheduleBuild2, scheduleBuild2, scheduleBuild2, schedulePolling, setAssignedLabel, setAssignedNode, setBlockBuildWhenDownstreamBuilding, setBlockBuildWhenUpstreamBuilding, setConcurrentBuild, setCustomWorkspace, setDisabled, setJDK, setQuietPeriod, setScm, setScmCheckoutStrategy, submit, supportsMakeDisabled, triggersMethods inherited from class hudson.model.Job
checkRename, createHistoryWidget, delete, doBuildStatus, doChildrenContextMenu, doChildrenContextMenu, doDescription, doDoRename, doRssAll, doRssChangelog, doRssFailed, fastUpdateNextBuildNumber, getACL, getAllProperties, getBuildDir, getBuildDiscarder, getBuildForCLI, getBuildHealth, getBuildHealthReports, getBuilds, getBuilds, getBuildsAsMap, getBuildsByTimestamp, getBuildStatusIconClassName, getBuildStatusUrl, getBuildTimeGraph, getCharacteristicEnvVars, getDynamic, getEstimatedDuration, getLastBuildsOverThreshold, getLastCompletedBuild, getLastFailedBuild, getLastStableBuild, getLastSuccessfulBuild, getLastUnstableBuild, getLastUnsuccessfulBuild, getLogRotator, getNewBuilds, getNextBuildNumber, getOverrides, getPermalinks, getProperties, getProperty, getProperty, getTimeline, isBuilding, isHoldOffBuildUntilSave, isKeepDependencies, isLogUpdated, isNameEditable, movedTo, onCopiedFrom, removeProperty, removeProperty, renameTo, saveNextBuildNumber, setBuildDiscarder, setLogRotator, supportsLogRotator, updateNextBuildNumberMethods inherited from class hudson.model.AbstractItem
delete, delete, doCheckNewName, doConfigDotXml, doConfigDotXml, doConfirmRename, doDoDelete, doDoDelete, doReload, doSetName, doSubmitDescription, doSubmitDescription, getAbsoluteUrl, getApi, getConfigFile, getDescription, getDisplayName, getDisplayNameOrNull, getFullDisplayName, getFullName, getName, getParent, getRelativeDisplayNameFrom, getRelativeNameFromGroup, getRootDir, getSearchName, getSearchUrl, getShortUrl, getTarget, getTaskNoun, getUrl, load, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXml, writeConfigDotXml, writeReplaceMethods inherited from class hudson.model.Actionable
addAction, addOrReplaceAction, doContextMenu, doContextMenu, getAction, getAction, getActions, getAllActions, removeAction, removeActions, replaceAction, replaceActionsMethods inherited from class hudson.model.AbstractModelObject
getSearch, getSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendErrorMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface hudson.security.AccessControlled
checkAnyPermission, checkPermission, getACL, hasAnyPermission, hasPermission, hasPermission, hasPermission2Methods inherited from interface hudson.model.BuildableItem
scheduleBuild, scheduleBuildMethods inherited from interface hudson.model.DescriptorByNameOwner
getDescriptorByNameMethods inherited from interface jenkins.widgets.HasWidgets
getWidget, getWidgetsMethods inherited from interface hudson.model.Item
delete, getAbsoluteUrl, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl, onCopiedFrom, onCreatedFromScratchMethods inherited from interface hudson.model.ItemGroup
allItems, allItems, allItems, getAllItems, getAllItems, getAllItems, getFullDisplayName, getFullName, getItemName, getItems, getItemsStream, getItemsStream, getUrlMethods inherited from interface jenkins.model.ParameterizedJobMixIn.ParameterizedJob
doBuild, doBuild, doBuildWithParameters, doBuildWithParameters, doCancelQueue, doDisable, doEnable, getParameterizedJobMixIn, isParameterized, makeDisabled, scheduleBuildMethods inherited from interface hudson.model.PersistenceRoot
getRootDirMethods inherited from interface hudson.model.Queue.Task
checkAbortPermission, getAffinityKey, getDefaultAuthentication, getDefaultAuthentication, getDefaultAuthentication2, getDefaultAuthentication2, getFullDisplayName, getName, getSubTasks, getUrl, getWhyBlocked, hasAbortPermission, isBuildBlocked, isConcurrentBuildMethods inherited from interface hudson.model.ResourceActivity
getDisplayName, getResourceListMethods inherited from interface hudson.model.SCMedItem
getScm, poll, pollSCMChangesMethods inherited from interface hudson.search.SearchableModelObject
getSearchMethods inherited from interface hudson.search.SearchItem
getSearchIndex, getSearchName, getSearchUrlMethods inherited from interface hudson.model.queue.SubTask
getAssignedLabel, getEstimatedDuration, getLastBuiltOn, getOwnerExecutable, getOwnerTask, getSameNodeConstraint
-
Field Details
-
DESCRIPTOR
-
-
Constructor Details
-
IvyModuleSet
-
IvyModuleSet
-
-
Method Details
-
isUseUpstreamParameters
public boolean isUseUpstreamParameters()- Specified by:
isUseUpstreamParametersin classAbstractIvyProject<IvyModuleSet,IvyModuleSetBuild>
-
setUseUpstreamParameters
public void setUseUpstreamParameters(boolean useUpstreamParameters) -
getUrlChildPrefix
- Specified by:
getUrlChildPrefixin interfaceItemGroup<IvyModule>
-
getItems
-
getModules
-
getItem
-
getModule
-
getSettings
-
updateTransientActions
protected void updateTransientActions()- Overrides:
updateTransientActionsin classAbstractProject<IvyModuleSet,IvyModuleSetBuild>
-
createTransientActions
- Overrides:
createTransientActionsin classAbstractIvyProject<IvyModuleSet,IvyModuleSetBuild>
-
addTransientActionsFromBuild
protected void addTransientActionsFromBuild(IvyModuleSetBuild build, List<Action> collection, Set<Class> added) - Specified by:
addTransientActionsFromBuildin classAbstractIvyProject<IvyModuleSet,IvyModuleSetBuild> - Parameters:
collection- Add the transient actions to this collection.
-
hasDisabledModule
public boolean hasDisabledModule()Returns true if there's any disabled module. -
getDisabledModules
Possibly empty list of all disabled modules (if disabled==true) or all enabled modules (if disabled==false) -
isIncrementalBuild
public boolean isIncrementalBuild() -
getChangedModulesProperty
-
isAggregatorStyleBuild
public boolean isAggregatorStyleBuild() -
ignoreUpstreamChanges
public boolean ignoreUpstreamChanges() -
isAllowedToTriggerDownstream
public boolean isAllowedToTriggerDownstream() -
setAllowedToTriggerDownstream
public void setAllowedToTriggerDownstream(boolean allowedToTriggerDownstream) -
isArchivingDisabled
public boolean isArchivingDisabled() -
setIncrementalBuild
public void setIncrementalBuild(boolean incrementalBuild) -
getIvyFilePattern
-
setIvyFilePattern
-
getIvyFileExcludesPattern
-
setIvyFileExcludesPattern
-
getIvySettingsFile
-
setIvySettingsFile
-
getIvySettingsPropertyFiles
-
setIvySettingsPropertyFiles
-
getIvyBranch
-
setIvyBranch
-
getIvyBuilderType
-
setAggregatorStyleBuild
public void setAggregatorStyleBuild(boolean aggregatorStyleBuild) -
setIgnoreUpstreamChanges
public void setIgnoreUpstreamChanges(boolean ignoreUpstreamChanges) -
setIsArchivingDisabled
public void setIsArchivingDisabled(boolean archivingDisabled) -
getModulePublishers
List of activePublishers that should be applied to all module builds. -
getPublishers
List of activePublishers. Can be empty but never null. -
getPublishersList
- Specified by:
getPublishersListin classAbstractProject<IvyModuleSet,IvyModuleSetBuild>
-
getBuildWrappersList
- Specified by:
getBuildWrappersListin interfaceBuildableItemWithBuildWrappers
-
getBuildWrappers
Deprecated.as of 1.335 UsegetBuildWrappersList()to be consistent with other subtypes ofAbstractProject.List of activeBuildWrappers. Can be empty but never null. -
getDynamic
public Object getDynamic(String token, org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) - Overrides:
getDynamicin classJob<IvyModuleSet,IvyModuleSetBuild>
-
getRootDirFor
- Specified by:
getRootDirForin interfaceItemGroup<IvyModule>
-
onRenamed
- Specified by:
onRenamedin interfaceItemGroup<IvyModule>- Throws:
IOException
-
onDeleted
- Specified by:
onDeletedin interfaceItemGroup<IvyModule>- Throws:
IOException
-
getAllJobs
- Specified by:
getAllJobsin interfaceItem- Overrides:
getAllJobsin classJob<IvyModuleSet,IvyModuleSetBuild>
-
getBuildClass
- Specified by:
getBuildClassin classAbstractProject<IvyModuleSet,IvyModuleSetBuild>
-
makeSearchIndex
- Overrides:
makeSearchIndexin classAbstractProject<IvyModuleSet,IvyModuleSetBuild>
-
isFingerprintConfigured
public boolean isFingerprintConfigured()- Specified by:
isFingerprintConfiguredin classAbstractProject<IvyModuleSet,IvyModuleSetBuild>
-
save
- Specified by:
savein interfaceItem- Specified by:
savein interfaceSaveable- Overrides:
savein classAbstractProject<IvyModuleSet,IvyModuleSetBuild> - Throws:
IOException
-
onLoad
- Specified by:
onLoadin interfaceItem- Overrides:
onLoadin classAbstractProject<IvyModuleSet,IvyModuleSetBuild> - Throws:
IOException
-
assignBuildNumber
To make it easy to grasp relationship among modules and the module set, we'll align the build numbers of all the modules.This method is invoked from
Executor.run(), and because of the mutual exclusion amongIvyModuleSetBuildandIvyBuild, we can safely touch all the modules.- Overrides:
assignBuildNumberin classJob<IvyModuleSet,IvyModuleSetBuild> - Throws:
IOException
-
logRotate
- Overrides:
logRotatein classJob<IvyModuleSet,IvyModuleSetBuild> - Throws:
IOExceptionInterruptedException
-
buildDependencyGraph
- Overrides:
buildDependencyGraphin classAbstractProject<IvyModuleSet,IvyModuleSetBuild>
-
getResourceActivities
- Overrides:
getResourceActivitiesin classAbstractProject<IvyModuleSet,IvyModuleSetBuild>
-
getCauseOfBlockage
- Specified by:
getCauseOfBlockagein interfaceQueue.Task- Overrides:
getCauseOfBlockagein classAbstractProject<IvyModuleSet,IvyModuleSetBuild>
-
asProject
- Specified by:
asProjectin interfaceBuildableItemWithBuildWrappers- Specified by:
asProjectin interfaceSCMedItem
-
getRelativePathToDescriptorFromModuleRoot
-
setRelativePathToDescriptorFromModuleRoot
public void setRelativePathToDescriptorFromModuleRoot(String relativePathToDescriptorFromModuleRoot) -
getQueueItems
Returns theIvyModules that are in the queue. -
submit
protected void submit(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException, jakarta.servlet.ServletException, Descriptor.FormException - Overrides:
submitin classAbstractProject<IvyModuleSet,IvyModuleSetBuild> - Throws:
IOExceptionjakarta.servlet.ServletExceptionDescriptor.FormException
-
getModuleClass
-
getTestResultAction
public hudson.tasks.test.AbstractTestResultAction<?> getTestResultAction() -
doDoDeleteAllDisabledModules
@POST public void doDoDeleteAllDisabledModules(org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException, InterruptedException Delete all disabled modules.- Throws:
IOExceptionInterruptedException
-
doCheckFileInWorkspace
public FormValidation doCheckFileInWorkspace(@QueryParameter String value) throws IOException, jakarta.servlet.ServletException Check the location of the ivy descriptor file, alternate settings file, etc - any file.- Throws:
IOExceptionjakarta.servlet.ServletException
-
doCheckIvySettingsFile
public FormValidation doCheckIvySettingsFile(@QueryParameter String value) throws IOException, jakarta.servlet.ServletException Check that the provided file exists, just in case.- Throws:
IOExceptionjakarta.servlet.ServletException
-
getBuilderTypeDescriptors
-
getDescriptor
- Specified by:
getDescriptorin interfaceDescribable<TopLevelItem>- Specified by:
getDescriptorin interfaceTopLevelItem
-
readResolve
-
getBuildWrappersList()to be consistent with other subtypes ofAbstractProject.