Package hudson.ivy

Class IvyModule

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.AbstractItem

hudson.model.Job<IvyModule,IvyBuild>

hudson.model.AbstractProject<IvyModule,IvyBuild>

hudson.ivy.AbstractIvyProject<IvyModule,IvyBuild>

hudson.ivy.IvyModule

All Implemented Interfaces:

ExtensionPoint, BuildableItem, DescriptorByNameOwner, Item, ModelObject, PersistenceRoot, SubTask, Queue.Task, ResourceActivity, Saveable, SearchableModelObject, SearchItem, AccessControlled, LazyBuildMixIn.LazyLoadingJob<IvyModule,IvyBuild>, Loadable, ModelObjectWithChildren, ModelObjectWithContextMenu, ParameterizedJobMixIn.ParameterizedJob<IvyModule,IvyBuild>, TriggeredItem, OnMaster, HasWidgets, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerOverridable, org.kohsuke.stapler.StaplerProxy

public final class IvyModule
extends AbstractIvyProject<IvyModule,IvyBuild>
implements Saveable

Job that builds projects based on Ivy.

Author:

Timothy Bingaman

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IvyModule.BecauseOfUpstreamModuleBuildInProgress	Because the upstream module build is in progress, and we are configured to wait for that.

Nested classes/interfaces inherited from class hudson.model.AbstractProject

AbstractProject.AbstractProjectDescriptor, AbstractProject.BecauseOfBuildInProgress, AbstractProject.BecauseOfDownstreamBuildInProgress, AbstractProject.BecauseOfUpstreamBuildInProgress, AbstractProject.LabelValidator

Nested classes/interfaces inherited from class hudson.model.Job

Job.LastItemListener, Job.SubItemBuildsLocationImpl

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 hudson.model.AbstractProject

ABORT, blockBuildWhenDownstreamBuilding, blockBuildWhenUpstreamBuilding, BUILD_NOW_TEXT, builds, disabled, transientActions, triggers

Fields inherited from class hudson.model.Job

HISTORY_ADAPTER, nextBuildNumber, properties, runIdMigrator

Fields inherited from class hudson.model.AbstractItem

description, 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

Method Summary

Modifier and Type	Method	Description
protected void	addTransientActionsFromBuild(IvyBuild build, List<Action> collection, Set<Class> added)
ModuleDependency	asDependency()	Gets organisation+name+revision as ModuleDependency.
protected void	buildDependencyGraph(DependencyGraph graph)
protected final List<Publisher>	createModulePublishers()	Creates a list of Publishers to be used for a build of this project.
protected void	doSetName(String name)
protected Collection<IvyModule>	getAllIvyModules()	Returns all Ivy modules in this Jenkins instance.
Label	getAssignedLabel()	IvyModule uses the workspace of the IvyModuleSet, so it always needs to be built on the same slave as the parent.
protected Class<IvyBuild>	getBuildClass()
DescribableList<BuildWrapper,Descriptor<BuildWrapper>>	getBuildWrappersList()
CauseOfBlockage	getCauseOfBlockage()
String	getDisplayName()
String	getIvyBranch()	Gets the Ivy branch in the ivy.xml file as of the last build.
JDK	getJDK()
LogRotator	getLogRotator()	IvyModule follows the same log rotation schedule as its parent.
ModuleName	getModuleName()
IvyModuleSet	getParent()
String	getPronoun()
DescribableList<Publisher,Descriptor<Publisher>>	getPublishers()	List of active Publishers configured for this module.
DescribableList<Publisher,Descriptor<Publisher>>	getPublishersList()
String	getRelativePath()	Relative path to this module's root directory from the workspace of a IvyModuleSet.
String	getRelativePathToDescriptorFromModuleRoot()
String	getRelativePathToModuleRoot()
String	getRevision()	Gets the revision number in the ivy.xml file as of the last build.
String	getShortUrl()
String	getTargets()	Gets the list of targets to execute for this module.
String	getUserConfiguredRelativePathToDescriptorFromModuleRoot()
Resource	getWorkspaceResource()	Deprecated. as of 1.319 in AbstractProject.
boolean	isBuildable()
boolean	isFingerprintConfigured()
boolean	isNameEditable()
boolean	isUseUpstreamParameters()
protected IvyBuild	newBuild()
void	onLoad(ItemGroup<? extends Item> parent, String name)
protected void	performDelete()
void	setLogRotator(LogRotator logRotator)	Deprecated. Not allowed to configure log rotation per module.
protected void	submit(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
boolean	supportsLogRotator()
protected void	updateTransientActions()

Methods inherited from class hudson.ivy.AbstractIvyProject

createTransientActions, scheduleBuild

Methods 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, getAssignedLabelString, getAuthToken, getBuild, getBuildByNumber, getBuildingDownstream, getBuildingUpstream, getBuildNowText, getBuildTriggerUpstreamProjects, getCustomWorkspace, getDelay, getDownstreamProjects, getDownstreamProjectsForApi, getEnvironment, getEstimatedDurationCandidates, getFirstBuild, getHasCustomQuietPeriod, getIconColor, getLastBuild, getLastBuiltOn, getLazyBuildMixIn, getModuleRoot, getModuleRoots, getNearestBuild, getNearestOldBuild, getProminentActions, getQueueItem, getQuietPeriod, getRelationship, getRelevantLabels, getResourceActivities, getResourceList, getRootProject, getSameNodeConstraint, getScm, getScmCheckoutRetryCount, getScmCheckoutStrategy, getSomeBuildWithWorkspace, getSomeWorkspace, getSubTasks, getTransitiveDownstreamProjects, getTransitiveUpstreamProjects, getTrigger, getTriggers, getUpstreamProjects, getUpstreamProjectsForApi, getWorkspace, hasAbortPermission, hasCustomScmCheckoutRetryCount, hasParticipant, isConcurrentBuild, isConfigurable, isDisabled, isInQueue, loadBuild, makeSearchIndex, onCreatedFromScratch, poll, pollSCMChanges, removeFromList, removeRun, removeTrigger, resolveForCLI, save, scheduleBuild, scheduleBuild2, scheduleBuild2, scheduleBuild2, scheduleBuild2, scheduleBuild2, schedulePolling, setAssignedLabel, setAssignedNode, setBlockBuildWhenDownstreamBuilding, setBlockBuildWhenUpstreamBuilding, setConcurrentBuild, setCustomWorkspace, setDisabled, setJDK, setQuietPeriod, setScm, setScmCheckoutStrategy, submit, supportsMakeDisabled, triggers

Methods inherited from class hudson.model.Job

assignBuildNumber, checkRename, createHistoryWidget, delete, doBuildStatus, doChildrenContextMenu, doChildrenContextMenu, doDescription, doDoRename, doRssAll, doRssChangelog, doRssFailed, fastUpdateNextBuildNumber, getACL, getAllJobs, getAllProperties, getBuildDir, getBuildDiscarder, getBuildForCLI, getBuildHealth, getBuildHealthReports, getBuilds, getBuilds, getBuildsAsMap, getBuildsByTimestamp, getBuildStatusIconClassName, getBuildStatusUrl, getBuildTimeGraph, getCharacteristicEnvVars, getDynamic, getDynamic, getEstimatedDuration, getLastBuildsOverThreshold, getLastCompletedBuild, getLastFailedBuild, getLastStableBuild, getLastSuccessfulBuild, getLastUnstableBuild, getLastUnsuccessfulBuild, getNewBuilds, getNextBuildNumber, getOverrides, getPermalinks, getProperties, getProperty, getProperty, getTimeline, isBuilding, isHoldOffBuildUntilSave, isKeepDependencies, isLogUpdated, logRotate, movedTo, onCopiedFrom, removeProperty, removeProperty, renameTo, saveNextBuildNumber, setBuildDiscarder, updateNextBuildNumber

Methods inherited from class hudson.model.AbstractItem

delete, delete, doCheckNewName, doConfigDotXml, doConfigDotXml, doConfirmRename, doDoDelete, doDoDelete, doReload, doSubmitDescription, doSubmitDescription, getAbsoluteUrl, getApi, getConfigFile, getDescription, getDisplayNameOrNull, getFullDisplayName, getFullName, getName, getRelativeDisplayNameFrom, getRelativeNameFromGroup, getRootDir, getSearchName, getSearchUrl, getTarget, getTaskNoun, getUrl, load, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXml, writeConfigDotXml, writeReplace

Methods inherited from class hudson.model.Actionable

addAction, addOrReplaceAction, doContextMenu, doContextMenu, getAction, getAction, getActions, getAllActions, 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 jenkins.widgets.HasWidgets

getWidget, getWidgets

Methods inherited from interface hudson.model.Item

delete, getAbsoluteUrl, getAllJobs, getFullDisplayName, getFullName, getName, getRelativeNameFrom, getRelativeNameFrom, getUrl, onCopiedFrom

Methods inherited from interface jenkins.model.ParameterizedJobMixIn.ParameterizedJob

doBuild, doBuild, doBuildWithParameters, doBuildWithParameters, doCancelQueue, doDisable, doEnable, getParameterizedJobMixIn, isParameterized, makeDisabled, scheduleBuild

Methods inherited from interface hudson.model.PersistenceRoot

getRootDir

Methods inherited from interface hudson.model.Queue.Task

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

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

getEstimatedDuration, getOwnerExecutable, getOwnerTask

Method Details

getBuildWrappersList

public DescribableList<BuildWrapper,Descriptor<BuildWrapper>> getBuildWrappersList()

getLogRotator

public LogRotator getLogRotator()

IvyModule follows the same log rotation schedule as its parent.

Overrides:

getLogRotator in class Job<IvyModule,IvyBuild>

setLogRotator

@Deprecated
public void setLogRotator(LogRotator logRotator)

Deprecated.

Not allowed to configure log rotation per module.

Overrides:

setLogRotator in class Job<IvyModule,IvyBuild>

supportsLogRotator

public boolean supportsLogRotator()

Overrides:

supportsLogRotator in class Job<IvyModule,IvyBuild>

isBuildable

public boolean isBuildable()

Specified by:

isBuildable in interface ParameterizedJobMixIn.ParameterizedJob<IvyModule,IvyBuild>

Overrides:

isBuildable in class AbstractProject<IvyModule,IvyBuild>

doSetName

protected void doSetName(String name)

Overrides:

doSetName in class AbstractItem

onLoad

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

Specified by:

onLoad in interface Item

Overrides:

onLoad in class AbstractProject<IvyModule,IvyBuild>

Throws:

IOException

getRelativePath

public String getRelativePath()

Relative path to this module's root directory from the workspace of a IvyModuleSet.

The path separator is normalized to '/'.

getRevision

public String getRevision()

Gets the revision number in the ivy.xml file as of the last build.

Returns:

This method can return null if Jenkins loaded old data that didn't record this information, so that situation needs to be handled gracefully.

getIvyBranch

public String getIvyBranch()

Gets the Ivy branch in the ivy.xml file as of the last build.

Returns:

This method can return null if Jenkins loaded old data that didn't record this information, so that situation needs to be handled gracefully.

getTargets

public String getTargets()

Gets the list of targets to execute for this module.

getRelativePathToDescriptorFromModuleRoot

public String getRelativePathToDescriptorFromModuleRoot()

getUserConfiguredRelativePathToDescriptorFromModuleRoot

public String getUserConfiguredRelativePathToDescriptorFromModuleRoot()

getRelativePathToModuleRoot

public String getRelativePathToModuleRoot()

getPublishersList

public DescribableList<Publisher,Descriptor<Publisher>> getPublishersList()

Specified by:

getPublishersList in class AbstractProject<IvyModule,IvyBuild>

getJDK

public JDK getJDK()

Overrides:

getJDK in class AbstractProject<IvyModule,IvyBuild>

getBuildClass

protected Class<IvyBuild> getBuildClass()

Specified by:

getBuildClass in class AbstractProject<IvyModule,IvyBuild>

newBuild

protected IvyBuild newBuild()
                     throws IOException

Overrides:

newBuild in class AbstractProject<IvyModule,IvyBuild>

Throws:

IOException

getModuleName

public ModuleName getModuleName()

asDependency

public ModuleDependency asDependency()

Gets organisation+name+revision as ModuleDependency.

getShortUrl

public String getShortUrl()

Specified by:

getShortUrl in interface Item

Overrides:

getShortUrl in class AbstractItem

getDisplayName

@Exported(visibility=2)
public String getDisplayName()

Specified by:

getDisplayName in interface Item

Specified by:

getDisplayName in interface ModelObject

Specified by:

getDisplayName in interface ResourceActivity

Overrides:

getDisplayName in class AbstractItem

getPronoun

public String getPronoun()

Overrides:

getPronoun in class AbstractProject<IvyModule,IvyBuild>

isNameEditable

public boolean isNameEditable()

Overrides:

isNameEditable in class Job<IvyModule,IvyBuild>

getParent

public IvyModuleSet getParent()

Specified by:

getParent in interface Item

Overrides:

getParent in class AbstractItem

getAssignedLabel

public Label getAssignedLabel()

IvyModule uses the workspace of the IvyModuleSet, so it always needs to be built on the same slave as the parent.

Specified by:

getAssignedLabel in interface SubTask

Overrides:

getAssignedLabel in class AbstractProject<IvyModule,IvyBuild>

getWorkspaceResource

@Deprecated
public Resource getWorkspaceResource()

Deprecated.

as of 1.319 in AbstractProject.

Workspace of a IvyModule is a part of the parent's workspace.

That is, IvyModuleSet builds are incompatible with any IvyModule builds, whereas IvyModule builds are compatible with each other.

Overrides:

getWorkspaceResource in class AbstractProject<IvyModule,IvyBuild>

isFingerprintConfigured

public boolean isFingerprintConfigured()

Specified by:

isFingerprintConfigured in class AbstractProject<IvyModule,IvyBuild>

updateTransientActions

protected void updateTransientActions()

Overrides:

updateTransientActions in class AbstractProject<IvyModule,IvyBuild>

buildDependencyGraph

protected void buildDependencyGraph(DependencyGraph graph)

Overrides:

buildDependencyGraph in class AbstractProject<IvyModule,IvyBuild>

getAllIvyModules

protected Collection<IvyModule> getAllIvyModules()

Returns all Ivy modules in this Jenkins instance.

getCauseOfBlockage

public CauseOfBlockage getCauseOfBlockage()

Specified by:

getCauseOfBlockage in interface Queue.Task

Overrides:

getCauseOfBlockage in class AbstractProject<IvyModule,IvyBuild>

addTransientActionsFromBuild

protected void addTransientActionsFromBuild(IvyBuild build,
 List<Action> collection,
 Set<Class> added)

Specified by:

addTransientActionsFromBuild in class AbstractIvyProject<IvyModule,IvyBuild>

Parameters:

collection - Add the transient actions to this collection.

getPublishers

public DescribableList<Publisher,Descriptor<Publisher>> getPublishers()

List of active Publishers configured for this module.

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 AbstractProject<IvyModule,IvyBuild>

Throws:

IOException

jakarta.servlet.ServletException

Descriptor.FormException

performDelete

protected void performDelete()
                      throws IOException,
InterruptedException

Overrides:

performDelete in class AbstractProject<IvyModule,IvyBuild>

Throws:

IOException

InterruptedException

createModulePublishers

protected final List<Publisher> createModulePublishers()

Creates a list of Publishers to be used for a build of this project.

isUseUpstreamParameters

public boolean isUseUpstreamParameters()

Specified by:

isUseUpstreamParameters in class AbstractIvyProject<IvyModule,IvyBuild>