hudson.matrix

Class MatrixConfiguration

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.AbstractItem

hudson.model.Job<P,R>

hudson.model.AbstractProject<P,B>

hudson.model.Project<MatrixConfiguration,MatrixRun>

hudson.matrix.MatrixConfiguration

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.BuildableItem, hudson.model.BuildableItemWithBuildWrappers, hudson.model.DescriptorByNameOwner, hudson.model.Item, hudson.model.ModelObject, hudson.model.PersistenceRoot, hudson.model.Queue.NonBlockingTask, hudson.model.queue.SubTask, hudson.model.Queue.Task, hudson.model.ResourceActivity, hudson.model.Saveable, hudson.model.SCMedItem, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, hudson.tasks.Maven.ProjectWithMaven, jenkins.model.lazy.LazyBuildMixIn.LazyLoadingJob<MatrixConfiguration,MatrixRun>, jenkins.model.ModelObjectWithChildren, jenkins.model.ModelObjectWithContextMenu, jenkins.model.ParameterizedJobMixIn.ParameterizedJob, jenkins.triggers.SCMTriggerItem, jenkins.util.io.OnMaster, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerOverridable

public class MatrixConfiguration
extends hudson.model.Project<MatrixConfiguration,MatrixRun>
implements hudson.model.SCMedItem, hudson.model.Queue.NonBlockingTask

One configuration of MatrixProject.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MatrixConfiguration.ParentBuildAction

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

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

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

hudson.model.Job.LastItemListener

Nested classes/interfaces inherited from interface jenkins.triggers.SCMTriggerItem

jenkins.triggers.SCMTriggerItem.SCMTriggerItems

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

Modifier and Type	Field and Description
static boolean	useShortWorkspaceName On Cygwin, path names cannot be longer than 256 chars.

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

Constructor and Description
MatrixConfiguration(MatrixProject parent, Combination c)

Method Summary

Modifier and Type	Method and Description
MatrixConfiguration	asProject()
int	assignBuildNumber()
protected void	buildDependencyGraph(hudson.model.DependencyGraph graph)
void	delete()
void	doConfigure(org.kohsuke.stapler.StaplerResponse rsp)
org.kohsuke.stapler.HttpResponse	doDisable()
hudson.model.Label	getAssignedLabel()
protected Class<MatrixRun>	getBuildClass()
jenkins.model.BuildDiscarder	getBuildDiscarder()
List<hudson.tasks.Builder>	getBuilders()
hudson.util.DescribableList<hudson.tasks.Builder,hudson.model.Descriptor<hudson.tasks.Builder>>	getBuildersList()
Map<hudson.model.Descriptor<hudson.tasks.BuildWrapper>,hudson.tasks.BuildWrapper>	getBuildWrappers()
hudson.util.DescribableList<hudson.tasks.BuildWrapper,hudson.model.Descriptor<hudson.tasks.BuildWrapper>>	getBuildWrappersList()
Combination	getCombination() Get the actual combination of the axes values for this MatrixConfiguration
String	getDisplayName()
hudson.EnvVars	getEnvironment(hudson.model.Node node, hudson.model.TaskListener listener)
hudson.model.JDK	getJDK()
int	getNextBuildNumber() Build numbers are always synchronized with the parent.
MatrixProject	getParent()
String	getPronoun()
hudson.tasks.Publisher	getPublisher(hudson.model.Descriptor<hudson.tasks.Publisher> descriptor)
Map<hudson.model.Descriptor<hudson.tasks.Publisher>,hudson.tasks.Publisher>	getPublishers()
hudson.util.DescribableList<hudson.tasks.Publisher,hudson.model.Descriptor<hudson.tasks.Publisher>>	getPublishersList()
int	getQuietPeriod() Since MatrixConfiguration is always invoked from MatrixRun once and just once, there's no point in having a quiet period.
hudson.scm.SCM	getScm()
int	getScmCheckoutRetryCount() Inherit the value from the parent.
jenkins.scm.SCMCheckoutStrategy	getScmCheckoutStrategy() Inherit the value from the parent.
boolean	isActiveConfiguration() Returns true if this configuration is a configuration currently in use today (as opposed to the ones that are there only to keep the past record.)
boolean	isConcurrentBuild()
boolean	isConfigurable()
boolean	isDisabled()
void	makeDisabled(boolean b)
protected MatrixRun	newBuild()
void	onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent, String name)
boolean	scheduleBuild(List<? extends hudson.model.Action> actions, hudson.model.Cause c) Starts the build with the actions that are passed in.
boolean	scheduleBuild(hudson.model.ParametersAction parameters) Deprecated. Use scheduleBuild(ParametersAction, Cause). Since 1.283
boolean	scheduleBuild(hudson.model.ParametersAction parameters, hudson.model.Cause c) Deprecated. Use scheduleBuild(List, Cause). Since 1.480
void	setBuildDiscarder(jenkins.model.BuildDiscarder logRotator) Deprecated. Value is controlled by MatrixProject.
void	setConcurrentBuild(boolean b)
void	setJDK(hudson.model.JDK jdk) Deprecated. Not supported.
boolean	supportsMakeDisabled()
protected void	updateTransientActions()

Methods inherited from class hudson.model.Project

addPublisher, asItem, createTransientActions, getResourceActivities, getSCMs, getSCMTrigger, inferMavenInstallation, isFingerprintConfigured, removePublisher, scheduleBuild2, submit

Methods inherited from class hudson.model.AbstractProject

_getRuns, addProperty, addToList, addTrigger, blockBuildWhenDownstreamBuilding, blockBuildWhenUpstreamBuilding, buildDescribable, buildDescribable, checkAbortPermission, checkout, createExecutable, createHistoryWidget, disable, doBuild, doBuild, doBuildWithParameters, doBuildWithParameters, doCancelQueue, doCheckRetryCount, doConfigSubmit, doDoWipeOutWorkspace, doEnable, doPolling, doRssChangelog, doWs, enable, findNearest, findNearest, getActions, getAssignedLabelString, getAuthToken, getBuild, getBuildByNumber, getBuildingDownstream, getBuildingUpstream, getBuildNowText, getBuildTriggerUpstreamProjects, getCauseOfBlockage, getCustomWorkspace, getDefaultAuthentication, getDefaultAuthentication, getDelay, getDownstreamProjects, getFirstBuild, getHasCustomQuietPeriod, getIconColor, getLastBuild, getLastBuiltOn, getLazyBuildMixIn, getModuleRoot, getModuleRoots, getNearestBuild, getNearestOldBuild, getOwnerTask, getProminentActions, getQueueItem, getRelationship, getRelevantLabels, getResourceList, getRootProject, getSameNodeConstraint, getSomeBuildWithWorkspace, getSomeWorkspace, getSubTasks, getTransitiveDownstreamProjects, getTransitiveUpstreamProjects, getTrigger, getTriggers, getUpstreamProjects, getWhyBlocked, getWorkspace, getWorkspaceResource, hasAbortPermission, hasCustomScmCheckoutRetryCount, hasParticipant, isBuildable, isBuildBlocked, isInQueue, isParameterized, loadBuild, makeSearchIndex, onCreatedFromScratch, performDelete, poll, pollSCMChanges, removeFromList, removeRun, removeTrigger, resolveForCLI, save, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild2, scheduleBuild2, scheduleBuild2, scheduleBuild2, schedulePolling, setAssignedLabel, setAssignedNode, setBlockBuildWhenDownstreamBuilding, setBlockBuildWhenUpstreamBuilding, setCustomWorkspace, setQuietPeriod, setScm, setScmCheckoutStrategy, triggers

Methods inherited from class hudson.model.Job

doBuildStatus, doChildrenContextMenu, doDescription, doDoRename, doRssAll, doRssFailed, getACL, getAllJobs, getAllProperties, getBuildDir, getBuildForCLI, getBuildHealth, getBuildHealthReports, getBuilds, getBuilds, getBuildsAsMap, getBuildsByTimestamp, getBuildStatusIconClassName, getBuildStatusUrl, getBuildTimeGraph, getCharacteristicEnvVars, getDynamic, getEstimatedDuration, getEstimatedDurationCandidates, getLastBuildsOverThreshold, getLastCompletedBuild, getLastFailedBuild, getLastStableBuild, getLastSuccessfulBuild, getLastUnstableBuild, getLastUnsuccessfulBuild, getLogRotator, getNewBuilds, getOverrides, getPermalinks, getProperties, getProperty, getProperty, getTimeline, getWidgets, isBuilding, isHoldOffBuildUntilSave, isKeepDependencies, isLogUpdated, isNameEditable, logRotate, movedTo, onCopiedFrom, removeProperty, removeProperty, renameTo, saveNextBuildNumber, setLogRotator, supportsLogRotator, updateNextBuildNumber

Methods inherited from class hudson.model.AbstractItem

checkPermission, delete, doConfigDotXml, doDoDelete, doReload, doSetName, doSubmitDescription, getAbsoluteUrl, getApi, getConfigFile, getDescription, getDescriptorByName, getDisplayNameOrNull, getFullDisplayName, getFullName, getName, getRelativeDisplayNameFrom, getRelativeNameFrom, getRelativeNameFrom, getRelativeNameFromGroup, getRootDir, getSearchName, getSearchUrl, getShortUrl, getUrl, hasPermission, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXml

Methods inherited from class hudson.model.Actionable

addAction, doContextMenu, getAction, getAction, getActions, getAllActions, 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.SCMedItem

poll, pollSCMChanges

Methods inherited from interface hudson.model.BuildableItem

scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild

Methods inherited from interface hudson.model.Item

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

checkAbortPermission, getCauseOfBlockage, getDefaultAuthentication, getDefaultAuthentication, getFullDisplayName, getName, getSubTasks, getUrl, getWhyBlocked, hasAbortPermission, isBuildBlocked

Methods inherited from interface hudson.model.queue.SubTask

createExecutable, getEstimatedDuration, getLastBuiltOn, getOwnerTask, getSameNodeConstraint

Methods inherited from interface hudson.model.ResourceActivity

getResourceList

Methods inherited from interface jenkins.triggers.SCMTriggerItem

poll

Field Detail

useShortWorkspaceName

public static boolean useShortWorkspaceName

On Cygwin, path names cannot be longer than 256 chars. See http://cygwin.com/ml/cygwin/2005-04/msg00395.html and http://www.nabble.com/Windows-Filename-too-long-errors-t3161089.html for the background of this issue. Setting this flag to true would cause Jenkins to use cryptic but short path name, giving more room for jobs to use longer path names.

Constructor Detail

MatrixConfiguration

public MatrixConfiguration(MatrixProject parent,
                           Combination c)

Method Detail

onLoad

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

Specified by:

onLoad in interface hudson.model.Item

Overrides:

onLoad in class hudson.model.Project<MatrixConfiguration,MatrixRun>

Throws:

IOException

getEnvironment

public hudson.EnvVars getEnvironment(hudson.model.Node node,
                                     hudson.model.TaskListener listener)
                              throws IOException,
                                     InterruptedException

Overrides:

getEnvironment in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

Throws:

IOException

InterruptedException

isDisabled

public final boolean isDisabled()

Overrides:

isDisabled in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

makeDisabled

public final void makeDisabled(boolean b)
                        throws IOException

Overrides:

makeDisabled in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

Throws:

IOException

supportsMakeDisabled

public final boolean supportsMakeDisabled()

Overrides:

supportsMakeDisabled in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

doDisable

public final org.kohsuke.stapler.HttpResponse doDisable()
                                                 throws IOException,
                                                        javax.servlet.ServletException

Overrides:

doDisable in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

Throws:

IOException

javax.servlet.ServletException

updateTransientActions

protected void updateTransientActions()

Overrides:

updateTransientActions in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

isConcurrentBuild

public boolean isConcurrentBuild()

Specified by:

isConcurrentBuild in interface hudson.model.Queue.Task

Overrides:

isConcurrentBuild in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

setConcurrentBuild

public void setConcurrentBuild(boolean b)
                        throws IOException

Overrides:

setConcurrentBuild in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

Throws:

IOException

delete

public void delete()
            throws IOException,
                   InterruptedException

Specified by:

delete in interface hudson.model.Item

Overrides:

delete in class hudson.model.Job<MatrixConfiguration,MatrixRun>

Throws:

IOException

InterruptedException

getNextBuildNumber

public int getNextBuildNumber()

Build numbers are always synchronized with the parent.

Computing this is bit tricky. Several considerations:

1. A new configuration build #N is started while the parent build #N is building, and when that happens we want to return N.
2. But the configuration build #N is done before the parent build #N finishes, and when that happens we want to return N+1 because that's going to be the next one.
3. Configuration builds might skip some numbers if the parent build is aborted before this configuration is built.
4. If nothing is building right now and the last build of the parent is #N, then we want to return N+1.

Specified by:

getNextBuildNumber in interface jenkins.triggers.SCMTriggerItem

Overrides:

getNextBuildNumber in class hudson.model.Job<MatrixConfiguration,MatrixRun>

assignBuildNumber

public int assignBuildNumber()
                      throws IOException

Overrides:

assignBuildNumber in class hudson.model.Job<MatrixConfiguration,MatrixRun>

Throws:

IOException

getDisplayName

public 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

getParent

public MatrixProject getParent()

Specified by:

getParent in interface hudson.model.Item

Overrides:

getParent in class hudson.model.AbstractItem

getCombination

public Combination getCombination()

Get the actual combination of the axes values for this MatrixConfiguration

getQuietPeriod

public int getQuietPeriod()

Since MatrixConfiguration is always invoked from MatrixRun once and just once, there's no point in having a quiet period.

Specified by:

getQuietPeriod in interface jenkins.model.ParameterizedJobMixIn.ParameterizedJob

Specified by:

getQuietPeriod in interface jenkins.triggers.SCMTriggerItem

Overrides:

getQuietPeriod in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

getScmCheckoutRetryCount

public int getScmCheckoutRetryCount()

Inherit the value from the parent.

Overrides:

getScmCheckoutRetryCount in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

getScmCheckoutStrategy

public jenkins.scm.SCMCheckoutStrategy getScmCheckoutStrategy()

Inherit the value from the parent.

Overrides:

getScmCheckoutStrategy in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

isConfigurable

public boolean isConfigurable()

Overrides:

isConfigurable in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

getBuildClass

protected Class<MatrixRun> getBuildClass()

Specified by:

getBuildClass in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

newBuild

protected MatrixRun newBuild()
                      throws IOException

Overrides:

newBuild in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

Throws:

IOException

buildDependencyGraph

protected void buildDependencyGraph(hudson.model.DependencyGraph graph)

Overrides:

buildDependencyGraph in class hudson.model.Project<MatrixConfiguration,MatrixRun>

asProject

public MatrixConfiguration asProject()

Specified by:

asProject in interface hudson.model.BuildableItemWithBuildWrappers

Specified by:

asProject in interface hudson.model.SCMedItem

Overrides:

asProject in class hudson.model.Project<MatrixConfiguration,MatrixRun>

getAssignedLabel

public hudson.model.Label getAssignedLabel()

Specified by:

getAssignedLabel in interface hudson.model.queue.SubTask

Overrides:

getAssignedLabel in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

getPronoun

public String getPronoun()

Overrides:

getPronoun in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

getJDK

public hudson.model.JDK getJDK()

Overrides:

getJDK in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

getBuilders

public List<hudson.tasks.Builder> getBuilders()

Overrides:

getBuilders in class hudson.model.Project<MatrixConfiguration,MatrixRun>

getPublishers

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

Overrides:

getPublishers in class hudson.model.Project<MatrixConfiguration,MatrixRun>

getBuildersList

public hudson.util.DescribableList<hudson.tasks.Builder,hudson.model.Descriptor<hudson.tasks.Builder>> getBuildersList()

Overrides:

getBuildersList in class hudson.model.Project<MatrixConfiguration,MatrixRun>

getPublishersList

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

Overrides:

getPublishersList in class hudson.model.Project<MatrixConfiguration,MatrixRun>

getBuildWrappers

public Map<hudson.model.Descriptor<hudson.tasks.BuildWrapper>,hudson.tasks.BuildWrapper> getBuildWrappers()

Overrides:

getBuildWrappers in class hudson.model.Project<MatrixConfiguration,MatrixRun>

getBuildWrappersList

public hudson.util.DescribableList<hudson.tasks.BuildWrapper,hudson.model.Descriptor<hudson.tasks.BuildWrapper>> getBuildWrappersList()

Specified by:

getBuildWrappersList in interface hudson.model.BuildableItemWithBuildWrappers

Overrides:

getBuildWrappersList in class hudson.model.Project<MatrixConfiguration,MatrixRun>

getPublisher

public hudson.tasks.Publisher getPublisher(hudson.model.Descriptor<hudson.tasks.Publisher> descriptor)

Overrides:

getPublisher in class hudson.model.Project<MatrixConfiguration,MatrixRun>

getBuildDiscarder

public jenkins.model.BuildDiscarder getBuildDiscarder()

Overrides:

getBuildDiscarder in class hudson.model.Job<MatrixConfiguration,MatrixRun>

getScm

public hudson.scm.SCM getScm()

Specified by:

getScm in interface hudson.model.SCMedItem

Overrides:

getScm in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

setJDK

public void setJDK(hudson.model.JDK jdk)
            throws IOException

Deprecated. Not supported.

JDK cannot be set on MatrixConfiguration because it's controlled by MatrixProject.

Overrides:

setJDK in class hudson.model.AbstractProject<MatrixConfiguration,MatrixRun>

Throws:

IOException

setBuildDiscarder

public void setBuildDiscarder(jenkins.model.BuildDiscarder logRotator)

Deprecated. Value is controlled by MatrixProject.

Overrides:

setBuildDiscarder in class hudson.model.Job<MatrixConfiguration,MatrixRun>

isActiveConfiguration

public boolean isActiveConfiguration()

Returns true if this configuration is a configuration currently in use today (as opposed to the ones that are there only to keep the past record.)

See Also:

MatrixProject.getActiveConfigurations()

scheduleBuild

public boolean scheduleBuild(hudson.model.ParametersAction parameters)

Deprecated. Use scheduleBuild(ParametersAction, Cause). Since 1.283

scheduleBuild

public boolean scheduleBuild(hudson.model.ParametersAction parameters,
                             hudson.model.Cause c)

Deprecated. Use scheduleBuild(List, Cause). Since 1.480

Starts the build with the ParametersAction that are passed in.

Parameters:

parameters - Can be null.

scheduleBuild

public boolean scheduleBuild(List<? extends hudson.model.Action> actions,
                             hudson.model.Cause c)

Starts the build with the actions that are passed in.

Parameters:

actions - Can be null.

c - Reason for starting the build

Returns:

true if the build has been scheduled

doConfigure

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public void doConfigure(org.kohsuke.stapler.StaplerResponse rsp)
                                                                                   throws IOException

Throws:

IOException