hudson.ivy
Class IvyModule

java.lang.Object
  hudson.model.AbstractModelObject
      hudson.model.Actionable
          hudson.model.AbstractItem
              hudson.model.Job<P,R>
                  hudson.model.AbstractProject<P,R>
                      hudson.ivy.AbstractIvyProject<IvyModule,IvyBuild>
                          hudson.ivy.IvyModule

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.BuildableItem, hudson.model.DescriptorByNameOwner, hudson.model.Item, hudson.model.ModelObject, hudson.model.PersistenceRoot, hudson.model.Queue.Task, hudson.model.ResourceActivity, hudson.model.Saveable, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, org.kohsuke.stapler.HttpDeletable

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

Job that builds projects based on Ivy.

Author:

Timothy Bingaman

Nested Class Summary

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

hudson.model.AbstractProject.AbstractProjectDescriptor, hudson.model.AbstractProject.BecauseOfBuildInProgress, hudson.model.AbstractProject.BecauseOfUpstreamBuildInProgress

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.AbstractProject

ABORT, blockBuildWhenUpstreamBuilding, builds, disabled, transientActions, triggers

Fields inherited from class hudson.model.Job

HISTORY_ADAPTER, nextBuildNumber, properties

Fields inherited from class hudson.model.AbstractItem

description, name

Fields inherited from interface hudson.model.Saveable

NOOP

Fields inherited from interface hudson.model.Item

BUILD, CONFIGURE, CREATE, DELETE, EXTENDED_READ, PERMISSIONS, READ, WORKSPACE

Method Summary

protected void	addTransientActionsFromBuild(IvyBuild build, java.util.Set<java.lang.Class> added)
ModuleDependency	asDependency() Gets organisation+name+revision as ModuleDependency.
protected void	buildDependencyGraph(hudson.model.DependencyGraph graph)
protected java.util.List<hudson.tasks.Publisher>	createModulePublishers() Creates a list of Publishers to be used for a build of this project.
protected void	doSetName(java.lang.String name)
hudson.model.Label	getAssignedLabel() IvyModule uses the workspace of the IvyModuleSet, so it always needs to be built on the same slave as the parent.
protected java.lang.Class<IvyBuild>	getBuildClass()
java.lang.String	getDisplayName()
java.lang.String	getIvyBranch() Gets the Ivy branch in the ivy.xml file as of the last build.
hudson.model.JDK	getJDK()
hudson.tasks.LogRotator	getLogRotator() IvyModule follows the same log rotation schedule as its parent.
ModuleName	getModuleName()
IvyModuleSet	getParent()
java.lang.String	getPronoun()
hudson.util.DescribableList<hudson.tasks.Publisher,hudson.model.Descriptor<hudson.tasks.Publisher>>	getPublishers() List of active Publishers configured for this module.
hudson.util.DescribableList<hudson.tasks.Publisher,hudson.model.Descriptor<hudson.tasks.Publisher>>	getPublishersList()
java.lang.String	getRelativePath() Relative path to this module's root directory from the workspace of a IvyModuleSet.
java.lang.String	getRelativePathToDescriptorFromModuleRoot()
java.lang.String	getRelativePathToModuleRoot()
java.lang.String	getRevision() Gets the revision number in the ivy.xml file as of the last build.
java.lang.String	getShortUrl()
java.lang.String	getTargets() Gets the list of targets to execute for this module.
java.lang.String	getUserConfiguredRelativePathToDescriptorFromModuleRoot()
java.lang.String	getUserConfiguredTargets() Gets the list of targets specified by the user, without taking inheritance and into account.
hudson.model.Resource	getWorkspaceResource() Deprecated. as of 1.319 in AbstractProject.
boolean	isBuildable()
boolean	isFingerprintConfigured()
boolean	isNameEditable()
protected IvyBuild	newBuild()
void	onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent, java.lang.String name)
protected void	performDelete()
void	setLogRotator(hudson.tasks.LogRotator logRotator) Deprecated. Not allowed to configure log rotation per module.
protected void	submit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
boolean	supportsLogRotator()

Methods inherited from class hudson.ivy.AbstractIvyProject

updateTransientActions

Methods inherited from class hudson.model.AbstractProject

_getRuns, addProperty, addToList, addTrigger, blockBuildWhenUpstreamBuilding, buildDescribable, buildDescribable, checkAbortPermission, checkout, createExecutable, createHistoryWidget, disable, doBuild, doBuildWithParameters, doCancelQueue, doCheckRetryCount, doConfigSubmit, doDisable, doDoWipeOutWorkspace, doEnable, doPolling, doRssChangelog, doWs, enable, findNearest, getActions, getAuthToken, getBuildingUpstream, getBuildTriggerUpstreamProjects, getCauseOfBlockage, getDownstreamProjects, getEstimatedDuration, getHasCustomQuietPeriod, getIconColor, getLastBuiltOn, getModuleRoot, getModuleRoots, getProminentActions, getQueueItem, getQuietPeriod, getRelationship, getResourceActivities, getResourceList, getRootProject, getScm, getScmCheckoutRetryCount, getSomeBuildWithWorkspace, getSomeWorkspace, getTransitiveDownstreamProjects, getTransitiveUpstreamProjects, getTrigger, getTriggers, getUpstreamProjects, getWhyBlocked, getWorkspace, hasAbortPermission, hasCustomScmCheckoutRetryCount, hasParticipant, isBuildBlocked, isConcurrentBuild, isConfigurable, isDisabled, isInQueue, isParameterized, loadBuild, makeDisabled, makeSearchIndex, poll, pollSCMChanges, removeFromList, removeRun, removeTrigger, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild2, scheduleBuild2, scheduleBuild2, schedulePolling, setAssignedLabel, setBlockBuildWhenUpstreamBuilding, setConcurrentBuild, setJDK, setQuietPeriod, setScm

Methods inherited from class hudson.model.Job

assignBuildNumber, doBuildStatus, doConfigDotXml, doDescription, doDoRename, doRssAll, doRssFailed, doTimelineData, getACL, getAllJobs, getAllProperties, getBuild, getBuildByNumber, getBuildDir, getBuildForCLI, getBuildHealth, getBuildHealthReports, getBuilds, getBuilds, getBuildsAsMap, getBuildsByTimestamp, getBuildStatusUrl, getBuildTimeGraph, getDynamic, getFirstBuild, getLastBuild, getLastCompletedBuild, getLastFailedBuild, getLastStableBuild, getLastSuccessfulBuild, getNearestBuild, getNearestOldBuild, getNextBuildNumber, getPermalinks, getProperties, getProperty, getWidgets, isBuilding, isKeepDependencies, logRotate, onCopiedFrom, removeProperty, removeProperty, renameTo, saveNextBuildNumber, updateNextBuildNumber

Methods inherited from class hudson.model.AbstractItem

checkPermission, delete, delete, doDoDelete, doSubmitDescription, getAbsoluteUrl, getApi, getConfigFile, getDescription, getDescriptorByName, getFullDisplayName, getFullName, getName, getRootDir, getSearchUrl, getUrl, hasPermission, resolveForCLI, save, setDescription, toString

Methods inherited from class hudson.model.Actionable

addAction, getAction, getAction, getActions

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, 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.Saveable

save

Methods inherited from interface hudson.model.Item

delete, getAbsoluteUrl, getAllJobs, getFullDisplayName, getFullName, getName, getUrl, onCopiedFrom, 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

Method Detail

getLogRotator

public hudson.tasks.LogRotator getLogRotator()

IvyModule follows the same log rotation schedule as its parent.

Overrides:

getLogRotator in class hudson.model.Job<IvyModule,IvyBuild>

setLogRotator

@Deprecated
public void setLogRotator(hudson.tasks.LogRotator logRotator)

Deprecated. Not allowed to configure log rotation per module.

Overrides:

setLogRotator in class hudson.model.Job<IvyModule,IvyBuild>

supportsLogRotator

public boolean supportsLogRotator()

Overrides:

supportsLogRotator in class hudson.model.Job<IvyModule,IvyBuild>

isBuildable

public boolean isBuildable()

Overrides:

isBuildable in class hudson.model.AbstractProject<IvyModule,IvyBuild>

doSetName

protected void doSetName(java.lang.String name)

Overrides:

doSetName in class hudson.model.AbstractItem

onLoad

public void onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent,
                   java.lang.String name)
            throws java.io.IOException

Specified by:

onLoad in interface hudson.model.Item

Overrides:

onLoad in class hudson.model.AbstractProject<IvyModule,IvyBuild>

Throws:

java.io.IOException

getRelativePath

public java.lang.String getRelativePath()

Relative path to this module's root directory from the workspace of a IvyModuleSet. The path separator is normalized to '/'.

getRevision

public java.lang.String getRevision()

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

Returns:

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

getIvyBranch

public java.lang.String getIvyBranch()

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

Returns:

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

getTargets

public java.lang.String getTargets()

Gets the list of targets to execute for this module.

getRelativePathToDescriptorFromModuleRoot

public java.lang.String getRelativePathToDescriptorFromModuleRoot()

getUserConfiguredRelativePathToDescriptorFromModuleRoot

public java.lang.String getUserConfiguredRelativePathToDescriptorFromModuleRoot()

getRelativePathToModuleRoot

public java.lang.String getRelativePathToModuleRoot()

getUserConfiguredTargets

public java.lang.String getUserConfiguredTargets()

Gets the list of targets specified by the user, without taking inheritance and into account.

This is only used to present the UI screen, and in all the other cases getTargets() should be used.

getPublishersList

public hudson.util.DescribableList<hudson.tasks.Publisher,hudson.model.Descriptor<hudson.tasks.Publisher>> getPublishersList()

Specified by:

getPublishersList in class hudson.model.AbstractProject<IvyModule,IvyBuild>

getJDK

public hudson.model.JDK getJDK()

Overrides:

getJDK in class hudson.model.AbstractProject<IvyModule,IvyBuild>

getBuildClass

protected java.lang.Class<IvyBuild> getBuildClass()

Specified by:

getBuildClass in class hudson.model.AbstractProject<IvyModule,IvyBuild>

newBuild

protected IvyBuild newBuild()
                     throws java.io.IOException

Overrides:

newBuild in class hudson.model.AbstractProject<IvyModule,IvyBuild>

Throws:

java.io.IOException

getModuleName

public ModuleName getModuleName()

asDependency

public ModuleDependency asDependency()

Gets organisation+name+revision as ModuleDependency.

getShortUrl

public java.lang.String getShortUrl()

Specified by:

getShortUrl in interface hudson.model.Item

Overrides:

getShortUrl in class hudson.model.AbstractItem

getDisplayName

@Exported(visibility=2)
public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.Item

Specified by:

getDisplayName in interface hudson.model.ModelObject

Specified by:

getDisplayName in interface hudson.model.ResourceActivity

Overrides:

getDisplayName in class hudson.model.AbstractItem

getPronoun

public java.lang.String getPronoun()

Overrides:

getPronoun in class hudson.model.AbstractProject<IvyModule,IvyBuild>

isNameEditable

public boolean isNameEditable()

Overrides:

isNameEditable in class hudson.model.Job<IvyModule,IvyBuild>

getParent

public IvyModuleSet getParent()

Specified by:

getParent in interface hudson.model.Item

Overrides:

getParent in class hudson.model.AbstractItem

getAssignedLabel

public hudson.model.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 hudson.model.Queue.Task

Overrides:

getAssignedLabel in class hudson.model.AbstractProject<IvyModule,IvyBuild>

getWorkspaceResource

@Deprecated
public hudson.model.Resource getWorkspaceResource()

Deprecated. as of 1.319 in AbstractProject.

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

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

Overrides:

getWorkspaceResource in class hudson.model.AbstractProject<IvyModule,IvyBuild>

isFingerprintConfigured

public boolean isFingerprintConfigured()

Specified by:

isFingerprintConfigured in class hudson.model.AbstractProject<IvyModule,IvyBuild>

buildDependencyGraph

protected void buildDependencyGraph(hudson.model.DependencyGraph graph)

Specified by:

buildDependencyGraph in class hudson.model.AbstractProject<IvyModule,IvyBuild>

addTransientActionsFromBuild

protected void addTransientActionsFromBuild(IvyBuild build,
                                            java.util.Set<java.lang.Class> added)

Specified by:

addTransientActionsFromBuild in class AbstractIvyProject<IvyModule,IvyBuild>

getPublishers

public hudson.util.DescribableList<hudson.tasks.Publisher,hudson.model.Descriptor<hudson.tasks.Publisher>> getPublishers()

List of active Publishers configured for this module.

submit

protected void submit(org.kohsuke.stapler.StaplerRequest req,
                      org.kohsuke.stapler.StaplerResponse rsp)
               throws java.io.IOException,
                      javax.servlet.ServletException,
                      hudson.model.Descriptor.FormException

Overrides:

submit in class hudson.model.AbstractProject<IvyModule,IvyBuild>

Throws:

java.io.IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

performDelete

protected void performDelete()
                      throws java.io.IOException,
                             java.lang.InterruptedException

Overrides:

performDelete in class hudson.model.AbstractProject<IvyModule,IvyBuild>

Throws:

java.io.IOException

java.lang.InterruptedException

createModulePublishers

protected final java.util.List<hudson.tasks.Publisher> createModulePublishers()

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