public class MatrixProject extends hudson.model.AbstractProject<MatrixProject,MatrixBuild> implements hudson.model.TopLevelItem, hudson.model.SCMedItem, hudson.model.ItemGroup<MatrixConfiguration>, hudson.model.Saveable, hudson.model.Queue.FlyweightTask, hudson.model.BuildableItemWithBuildWrappers
Job that allows you to run multiple different configurations
from a single setting.| Modifier and Type | Class and Description |
|---|---|
static class |
MatrixProject.DescriptorImpl |
hudson.model.AbstractProject.AbstractProjectDescriptor, hudson.model.AbstractProject.BecauseOfBuildInProgress, hudson.model.AbstractProject.BecauseOfDownstreamBuildInProgress, hudson.model.AbstractProject.BecauseOfUpstreamBuildInProgress, hudson.model.AbstractProject.LabelValidator| Modifier and Type | Field and Description |
|---|---|
static MatrixProject.DescriptorImpl |
DESCRIPTOR
Descriptor is instantiated as a field purely for backward compatibility.
|
ABORT, blockBuildWhenDownstreamBuilding, blockBuildWhenUpstreamBuilding, BUILD_NOW_TEXT, builds, disabled, transientActions, triggers| Constructor and Description |
|---|
MatrixProject(hudson.model.ItemGroup parent,
String name) |
MatrixProject(String name) |
| Modifier and Type | Method and Description |
|---|---|
static void |
alias() |
MatrixProject |
asProject() |
protected void |
buildDependencyGraph(hudson.model.DependencyGraph graph) |
protected List<hudson.model.Action> |
createTransientActions() |
jenkins.model.ModelObjectWithContextMenu.ContextMenu |
doChildrenContextMenu(org.kohsuke.stapler.StaplerRequest request,
org.kohsuke.stapler.StaplerResponse response) |
org.kohsuke.stapler.HttpResponse |
doDoWipeOutWorkspace()
Also delete all the workspaces of the configuration, too.
|
Collection<MatrixConfiguration> |
getActiveConfigurations()
Gets all active configurations.
|
hudson.tasks.test.AggregatedTestResultAction |
getAggregatedTestResultAction() |
Collection<? extends hudson.model.Job> |
getAllJobs() |
AxisList |
getAxes() |
protected Class<MatrixBuild> |
getBuildClass() |
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() |
String |
getChildCustomWorkspace()
Gets the workspace location that
MatrixConfiguration uses. |
String |
getCombinationFilter()
Obtains the combination filter, used to trim down the size of the matrix.
|
MatrixProject.DescriptorImpl |
getDescriptor() |
Object |
getDynamic(String token,
org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp) |
MatrixExecutionStrategy |
getExecutionStrategy() |
MatrixConfiguration |
getItem(Combination c) |
MatrixConfiguration |
getItem(String name) |
Collection<MatrixConfiguration> |
getItems() |
hudson.model.JDK |
getJDK()
Deprecated.
|
Set<hudson.model.JDK> |
getJDKs()
Gets the
JDKs where the builds will be run. |
Set<hudson.model.Label> |
getLabels()
Gets the
Labels where the builds will be run. |
Layouter<MatrixConfiguration> |
getLayouter() |
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() |
Set<hudson.model.Label> |
getRelevantLabels()
MatrixProject is relevant with all the labels its configurations are relevant. |
File |
getRootDirFor(Combination combination)
Gets a root directory for the specified
Combination. |
File |
getRootDirFor(MatrixConfiguration child)
Gets a root directory of the specified
MatrixConfiguration. |
MatrixConfigurationSorter |
getSorter()
Deprecated.
as of 1.456
Use
DefaultMatrixExecutionStrategyImpl.getSorter().
This method tries to emulate the previous behavior the best it can, but will return null
if the current MatrixExecutionStrategy is not the default one. |
String |
getTouchStoneCombinationFilter()
Deprecated.
as of 1.456
Use
DefaultMatrixExecutionStrategyImpl.getTouchStoneCombinationFilter().
This method tries to emulate the previous behavior the best it can, but will return null
if the current MatrixExecutionStrategy is not the default one. |
hudson.model.Result |
getTouchStoneResultCondition()
Deprecated.
as of 1.456
Use
DefaultMatrixExecutionStrategyImpl.getTouchStoneResultCondition().
This method tries to emulate the previous behavior the best it can, but will return null
if the current MatrixExecutionStrategy is not the default one. |
String |
getUrlChildPrefix() |
List<Axis> |
getUserAxes()
Deprecated.
as of 1.373
System vs user difference are generalized into extension point.
|
boolean |
hasChildCustomWorkspace()
Do we have an explicit child custom workspace setting (true)? Or just using the default value (false)?
|
boolean |
isFingerprintConfigured() |
boolean |
isRunSequentially()
Deprecated.
as of 1.456
Use
DefaultMatrixExecutionStrategyImpl.isRunSequentially().
This method tries to emulate the previous behavior the best it can, but will return false
if the current MatrixExecutionStrategy is not the default one. |
void |
logRotate() |
void |
onCreatedFromScratch() |
void |
onDeleted(MatrixConfiguration item) |
void |
onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent,
String name) |
void |
onRenamed(MatrixConfiguration item,
String oldName,
String newName) |
void |
setAxes(AxisList axes)
Reconfigures axes.
|
void |
setChildCustomWorkspace(String childCustomWorkspace) |
void |
setCombinationFilter(String combinationFilter)
Sets the combination filter.
|
void |
setExecutionStrategy(MatrixExecutionStrategy executionStrategy) |
void |
setRunSequentially(boolean runSequentially)
Deprecated.
as of 1.456
Use
DefaultMatrixExecutionStrategyImpl.setRunSequentially(boolean).
This method tries to emulate the previous behavior the best it can, but will fall back
to no-op if the current MatrixExecutionStrategy is not the default one. |
void |
setSorter(MatrixConfigurationSorter sorter)
Deprecated.
as of 1.456
Use
DefaultMatrixExecutionStrategyImpl.setSorter(MatrixConfigurationSorter).
This method tries to emulate the previous behavior the best it can, but will fall back
to no-op if the current MatrixExecutionStrategy is not the default one. |
void |
setTouchStoneCombinationFilter(String touchStoneCombinationFilter)
Deprecated.
as of 1.456
Use
DefaultMatrixExecutionStrategyImpl.setTouchStoneCombinationFilter(String).
This method tries to emulate the previous behavior the best it can, but will fall back
to no-op if the current MatrixExecutionStrategy is not the default one. |
void |
setTouchStoneResultCondition(hudson.model.Result touchStoneResultCondition)
Deprecated.
as of 1.456
Use
DefaultMatrixExecutionStrategyImpl.setTouchStoneResultCondition(Result).
This method tries to emulate the previous behavior the best it can, but will fall back
to no-op if the current MatrixExecutionStrategy is not the default one. |
protected void |
submit(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp) |
protected void |
updateTransientActions() |
_getRuns, addProperty, addToList, addTrigger, blockBuildWhenDownstreamBuilding, blockBuildWhenUpstreamBuilding, buildDescribable, buildDescribable, checkAbortPermission, checkout, createExecutable, createHistoryWidget, disable, doBuild, doBuild, doBuildWithParameters, doBuildWithParameters, doCancelQueue, doCheckRetryCount, doConfigSubmit, doDisable, doEnable, doPolling, doRssChangelog, doWs, enable, findNearest, findNearest, getActions, getAssignedLabel, getAssignedLabelString, getAuthToken, getBuild, getBuildByNumber, getBuildingDownstream, getBuildingUpstream, getBuildNowText, getBuildTriggerUpstreamProjects, getCauseOfBlockage, getCustomWorkspace, getDefaultAuthentication, getDefaultAuthentication, getDelay, getDownstreamProjects, getEnvironment, getFirstBuild, getHasCustomQuietPeriod, getIconColor, getLastBuild, getLastBuiltOn, getLazyBuildMixIn, getModuleRoot, getModuleRoots, getNearestBuild, getNearestOldBuild, getOwnerTask, getProminentActions, getQueueItem, getQuietPeriod, getRelationship, getResourceActivities, getResourceList, getRootProject, getSameNodeConstraint, getScm, getScmCheckoutRetryCount, getScmCheckoutStrategy, getSomeBuildWithWorkspace, getSomeWorkspace, getSubTasks, getTransitiveDownstreamProjects, getTransitiveUpstreamProjects, getTrigger, getTriggers, getUpstreamProjects, getWhyBlocked, getWorkspace, getWorkspaceResource, hasAbortPermission, hasCustomScmCheckoutRetryCount, hasParticipant, isBuildable, isBuildBlocked, isConcurrentBuild, isConfigurable, isDisabled, isInQueue, isParameterized, loadBuild, makeDisabled, makeSearchIndex, newBuild, performDelete, poll, pollSCMChanges, removeFromList, removeRun, removeTrigger, resolveForCLI, save, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild2, scheduleBuild2, scheduleBuild2, scheduleBuild2, schedulePolling, setAssignedLabel, setAssignedNode, setBlockBuildWhenDownstreamBuilding, setBlockBuildWhenUpstreamBuilding, setConcurrentBuild, setCustomWorkspace, setJDK, setQuietPeriod, setScm, setScmCheckoutStrategy, supportsMakeDisabled, triggersassignBuildNumber, delete, doBuildStatus, doDescription, doDoRename, doRssAll, doRssFailed, getACL, getAllProperties, getBuildDir, getBuildDiscarder, getBuildForCLI, getBuildHealth, getBuildHealthReports, getBuilds, getBuilds, getBuildsAsMap, getBuildsByTimestamp, getBuildStatusIconClassName, getBuildStatusUrl, getBuildTimeGraph, getCharacteristicEnvVars, getEstimatedDuration, getEstimatedDurationCandidates, getLastBuildsOverThreshold, getLastCompletedBuild, getLastFailedBuild, getLastStableBuild, getLastSuccessfulBuild, getLastUnstableBuild, getLastUnsuccessfulBuild, getLogRotator, getNewBuilds, getNextBuildNumber, getOverrides, getPermalinks, getProperties, getProperty, getProperty, getTimeline, getWidgets, isBuilding, isHoldOffBuildUntilSave, isKeepDependencies, isLogUpdated, isNameEditable, movedTo, onCopiedFrom, removeProperty, removeProperty, renameTo, saveNextBuildNumber, setBuildDiscarder, setLogRotator, supportsLogRotator, updateNextBuildNumbercheckPermission, delete, doConfigDotXml, doDoDelete, doReload, doSetName, doSubmitDescription, getAbsoluteUrl, getApi, getConfigFile, getDescription, getDescriptorByName, getDisplayName, getDisplayNameOrNull, getFullDisplayName, getFullName, getName, getParent, getRelativeDisplayNameFrom, getRelativeNameFrom, getRelativeNameFrom, getRelativeNameFromGroup, getRootDir, getSearchName, getSearchUrl, getShortUrl, getUrl, hasPermission, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXmladdAction, doContextMenu, getAction, getAction, getActions, getAllActions, replaceActiongetSearch, getSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendErrorclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitscheduleBuild, scheduleBuild, scheduleBuild, scheduleBuilddelete, getAbsoluteUrl, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl, onCopiedFrom@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) @Extension public static final MatrixProject.DescriptorImpl DESCRIPTOR
public MatrixProject(String name)
public MatrixProject(hudson.model.ItemGroup parent,
String name)
public String getPronoun()
getPronoun in class hudson.model.AbstractProject<MatrixProject,MatrixBuild>public String getChildCustomWorkspace()
MatrixConfiguration uses.
Used from MatrixRun.MatrixRunExecution.decideWorkspace.MatrixProject uses no custom workspace, this method still
returns something like "${PARENT_WORKSPACE}/${COMBINATION}" that controls
how the workspace should be laid out.
The return value can be absolute or relative. If relative, it is resolved
against the working directory of the overarching MatrixBuild.public boolean hasChildCustomWorkspace()
public void setChildCustomWorkspace(String childCustomWorkspace) throws IOException
IOExceptionpublic Set<hudson.model.Label> getRelevantLabels()
MatrixProject is relevant with all the labels its configurations are relevant.getRelevantLabels in class hudson.model.AbstractProject<MatrixProject,MatrixBuild>@Deprecated public MatrixConfigurationSorter getSorter()
DefaultMatrixExecutionStrategyImpl.getSorter().
This method tries to emulate the previous behavior the best it can, but will return null
if the current MatrixExecutionStrategy is not the default one.@Deprecated public void setSorter(MatrixConfigurationSorter sorter) throws IOException
DefaultMatrixExecutionStrategyImpl.setSorter(MatrixConfigurationSorter).
This method tries to emulate the previous behavior the best it can, but will fall back
to no-op if the current MatrixExecutionStrategy is not the default one.IOExceptionpublic AxisList getAxes()
public void setAxes(AxisList axes) throws IOException
IOExceptionpublic MatrixExecutionStrategy getExecutionStrategy()
public void setExecutionStrategy(MatrixExecutionStrategy executionStrategy) throws IOException
IOException@Deprecated public boolean isRunSequentially()
DefaultMatrixExecutionStrategyImpl.isRunSequentially().
This method tries to emulate the previous behavior the best it can, but will return false
if the current MatrixExecutionStrategy is not the default one.@Deprecated public void setRunSequentially(boolean runSequentially) throws IOException
DefaultMatrixExecutionStrategyImpl.setRunSequentially(boolean).
This method tries to emulate the previous behavior the best it can, but will fall back
to no-op if the current MatrixExecutionStrategy is not the default one.IOExceptionpublic void setCombinationFilter(String combinationFilter) throws IOException
combinationFilter - the combinationFilter to setIOExceptionpublic String getCombinationFilter()
By default, a MatrixConfiguration is created for every possible combination of axes exhaustively.
But by specifying a Groovy expression as a combination filter, one can trim down the # of combinations built.
Namely, this expression is evaluated for each axis value combination, and only when it evaluates to true,
a corresponding MatrixConfiguration will be created and built.
@Deprecated public String getTouchStoneCombinationFilter()
DefaultMatrixExecutionStrategyImpl.getTouchStoneCombinationFilter().
This method tries to emulate the previous behavior the best it can, but will return null
if the current MatrixExecutionStrategy is not the default one.@Deprecated public void setTouchStoneCombinationFilter(String touchStoneCombinationFilter) throws IOException
DefaultMatrixExecutionStrategyImpl.setTouchStoneCombinationFilter(String).
This method tries to emulate the previous behavior the best it can, but will fall back
to no-op if the current MatrixExecutionStrategy is not the default one.IOException@Deprecated public hudson.model.Result getTouchStoneResultCondition()
DefaultMatrixExecutionStrategyImpl.getTouchStoneResultCondition().
This method tries to emulate the previous behavior the best it can, but will return null
if the current MatrixExecutionStrategy is not the default one.@Deprecated public void setTouchStoneResultCondition(hudson.model.Result touchStoneResultCondition) throws IOException
DefaultMatrixExecutionStrategyImpl.setTouchStoneResultCondition(Result).
This method tries to emulate the previous behavior the best it can, but will fall back
to no-op if the current MatrixExecutionStrategy is not the default one.IOExceptionprotected List<hudson.model.Action> createTransientActions()
createTransientActions in class hudson.model.AbstractProject<MatrixProject,MatrixBuild>protected void updateTransientActions()
updateTransientActions in class hudson.model.AbstractProject<MatrixProject,MatrixBuild>@Deprecated public List<Axis> getUserAxes()
AxisList that are not system axes.public Layouter<MatrixConfiguration> getLayouter()
public void onCreatedFromScratch()
onCreatedFromScratch in interface hudson.model.ItemonCreatedFromScratch in class hudson.model.AbstractProject<MatrixProject,MatrixBuild>public void onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent,
String name)
throws IOException
onLoad in interface hudson.model.ItemonLoad in class hudson.model.AbstractProject<MatrixProject,MatrixBuild>IOExceptionpublic void logRotate()
throws IOException,
InterruptedException
logRotate in class hudson.model.Job<MatrixProject,MatrixBuild>IOExceptionInterruptedException@Exported public Collection<MatrixConfiguration> getActiveConfigurations()
In contract, inactive configurations are those that are left for archival purpose
and no longer built when a new MatrixBuild is executed.
During a build, MatrixBuild.MatrixBuildExecution.getActiveConfigurations() should be used
to make sure that a build is using the consistent set of active configurations from
the start to the end.
public Collection<MatrixConfiguration> getItems()
getItems in interface hudson.model.ItemGroup<MatrixConfiguration>public Collection<? extends hudson.model.Job> getAllJobs()
getAllJobs in interface hudson.model.ItemgetAllJobs in class hudson.model.Job<MatrixProject,MatrixBuild>public String getUrlChildPrefix()
getUrlChildPrefix in interface hudson.model.ItemGroup<MatrixConfiguration>public MatrixConfiguration getItem(String name)
getItem in interface hudson.model.ItemGroup<MatrixConfiguration>public MatrixConfiguration getItem(Combination c)
@Nonnull public File getRootDirFor(@Nonnull MatrixConfiguration child)
MatrixConfiguration.
Creates the whole directory hierarchy on-demand.getRootDirFor in interface hudson.model.ItemGroup<MatrixConfiguration>child - child MatrixConfigurationpublic void onRenamed(MatrixConfiguration item, String oldName, String newName) throws IOException
onRenamed in interface hudson.model.ItemGroup<MatrixConfiguration>IOExceptionpublic void onDeleted(MatrixConfiguration item) throws IOException
onDeleted in interface hudson.model.ItemGroup<MatrixConfiguration>IOException@Nonnull public File getRootDirFor(@Nonnull Combination combination)
Combination.
Creates the whole directory hierarchy on-demand.combination - Combination to be checked@Deprecated public hudson.model.JDK getJDK()
getJDK in class hudson.model.AbstractProject<MatrixProject,MatrixBuild>getJDKs()@Nonnull public Set<hudson.model.JDK> getJDKs()
JDKs where the builds will be run.@Nonnull public Set<hudson.model.Label> getLabels()
Labels where the builds will be run.public List<hudson.tasks.Builder> getBuilders()
public hudson.util.DescribableList<hudson.tasks.Builder,hudson.model.Descriptor<hudson.tasks.Builder>> getBuildersList()
public Map<hudson.model.Descriptor<hudson.tasks.Publisher>,hudson.tasks.Publisher> getPublishers()
public hudson.util.DescribableList<hudson.tasks.Publisher,hudson.model.Descriptor<hudson.tasks.Publisher>> getPublishersList()
getPublishersList in class hudson.model.AbstractProject<MatrixProject,MatrixBuild>public hudson.util.DescribableList<hudson.tasks.BuildWrapper,hudson.model.Descriptor<hudson.tasks.BuildWrapper>> getBuildWrappersList()
getBuildWrappersList in interface hudson.model.BuildableItemWithBuildWrapperspublic Map<hudson.model.Descriptor<hudson.tasks.BuildWrapper>,hudson.tasks.BuildWrapper> getBuildWrappers()
public hudson.tasks.Publisher getPublisher(hudson.model.Descriptor<hudson.tasks.Publisher> descriptor)
protected Class<MatrixBuild> getBuildClass()
getBuildClass in class hudson.model.AbstractProject<MatrixProject,MatrixBuild>public boolean isFingerprintConfigured()
isFingerprintConfigured in class hudson.model.AbstractProject<MatrixProject,MatrixBuild>protected void buildDependencyGraph(hudson.model.DependencyGraph graph)
buildDependencyGraph in class hudson.model.AbstractProject<MatrixProject,MatrixBuild>public MatrixProject asProject()
asProject in interface hudson.model.BuildableItemWithBuildWrappersasProject in interface hudson.model.SCMedItempublic Object getDynamic(String token, org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
getDynamic in class hudson.model.Job<MatrixProject,MatrixBuild>protected void submit(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp)
throws IOException,
javax.servlet.ServletException,
hudson.model.Descriptor.FormException
submit in class hudson.model.AbstractProject<MatrixProject,MatrixBuild>IOExceptionjavax.servlet.ServletExceptionhudson.model.Descriptor.FormExceptionpublic hudson.tasks.test.AggregatedTestResultAction getAggregatedTestResultAction()
public org.kohsuke.stapler.HttpResponse doDoWipeOutWorkspace()
throws IOException,
javax.servlet.ServletException,
InterruptedException
doDoWipeOutWorkspace in class hudson.model.AbstractProject<MatrixProject,MatrixBuild>IOExceptionjavax.servlet.ServletExceptionInterruptedExceptionpublic jenkins.model.ModelObjectWithContextMenu.ContextMenu doChildrenContextMenu(org.kohsuke.stapler.StaplerRequest request,
org.kohsuke.stapler.StaplerResponse response)
throws Exception
doChildrenContextMenu in interface jenkins.model.ModelObjectWithChildrendoChildrenContextMenu in class hudson.model.Job<MatrixProject,MatrixBuild>Exceptionpublic MatrixProject.DescriptorImpl getDescriptor()
getDescriptor in interface hudson.model.Describable<hudson.model.TopLevelItem>getDescriptor in interface hudson.model.TopLevelItemIllegalStateException - Jenkins is not ready@Initializer(before=EXTENSIONS_AUGMENTED) public static void alias()
Copyright © 2004-2016. All Rights Reserved.