|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objecthudson.model.AbstractModelObject
hudson.model.Actionable
hudson.model.AbstractItem
hudson.model.Job<P,R>
hudson.model.AbstractProject<P,R>
hudson.maven.AbstractMavenProject<MavenModuleSet,MavenModuleSetBuild>
hudson.maven.MavenModuleSet
public class MavenModuleSet
Group of MavenModules.
This corresponds to the group of Maven POMs that constitute a single tree of projects. This group serves as the grouping of those related modules.
| Nested Class Summary | |
|---|---|
static class |
MavenModuleSet.DescriptorImpl
|
| Nested classes/interfaces inherited from class hudson.maven.AbstractMavenProject |
|---|
AbstractMavenProject.MavenModuleDependency |
| Nested classes/interfaces inherited from class hudson.model.AbstractProject |
|---|
AbstractProject.AbstractProjectDescriptor, AbstractProject.BecauseOfBuildInProgress, AbstractProject.BecauseOfDownstreamBuildInProgress, AbstractProject.BecauseOfUpstreamBuildInProgress |
| Nested classes/interfaces inherited from interface hudson.ExtensionPoint |
|---|
ExtensionPoint.LegacyInstancesAreScopedToHudson |
| Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu |
|---|
ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.MenuItem |
| Field Summary | |
|---|---|
static MavenModuleSet.DescriptorImpl |
DESCRIPTOR
|
protected String |
globalSettingConfigPath
Deprecated. since 1.484 settings are provided by globalSettings |
| 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 |
| 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 |
| Constructor Summary | |
|---|---|
MavenModuleSet(ItemGroup parent,
String name)
|
|
MavenModuleSet(String name)
Deprecated. Use MavenModuleSet(ItemGroup, String) |
|
| Method Summary | |
|---|---|
protected void |
addTransientActionsFromBuild(MavenModuleSetBuild build,
List<Action> collection,
Set<Class> added)
|
AbstractProject<?,?> |
asProject()
|
int |
assignBuildNumber()
To make it easy to grasp relationship among modules and the module set, we'll align the build numbers of all the modules. |
protected void |
buildDependencyGraph(DependencyGraph graph)
|
Indenter<MavenModule> |
createIndenter()
|
protected List<Action> |
createTransientActions()
|
FormValidation |
doCheckFileInWorkspace(String value)
Check the location of the POM, alternate settings file, etc - any file. |
org.kohsuke.stapler.HttpResponse |
doDoDeleteAllDisabledModules()
Delete all disabled modules. |
Collection<Job> |
getAllJobs()
|
String |
getAlternateSettings()
Deprecated. as of 1.481 |
List<Queue.Item> |
getApproximateQueueItemsQuickly()
Returns the MavenModules that are in the queue. |
protected Class<MavenModuleSetBuild> |
getBuildClass()
|
DescribableList<BuildWrapper,Descriptor<BuildWrapper>> |
getBuildWrappers()
Deprecated. as of 1.335 Use getBuildWrappersList() to be consistent with other subtypes of AbstractProject. |
DescribableList<BuildWrapper,Descriptor<BuildWrapper>> |
getBuildWrappersList()
|
MavenModuleSet.DescriptorImpl |
getDescriptor()
|
List<MavenModule> |
getDisabledModules(boolean disabled)
Possibly empty list of all disabled modules (if disabled==true) or all enabeld modules (if disabled==false) |
Object |
getDynamic(String token,
org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp)
|
LocalRepositoryLocator |
getExplicitLocalRepository()
Undefaulted locally configured value with taking inheritance from the global configuration into account. |
GlobalSettingsProvider |
getGlobalSettings()
|
String |
getGoals()
Gets the list of goals to execute. |
MavenModule |
getItem(String name)
|
Collection<MavenModule> |
getItems()
|
LocalRepositoryLocator |
getLocalRepository()
|
Maven.MavenInstallation |
getMaven()
Gets the Maven to invoke. |
String |
getMavenOpts()
Possibly null, whitespace-separated (including TAB, NL, etc) VM options to be used to launch Maven process. |
Properties |
getMavenProperties()
Gets the system properties explicitly set in the Maven command line (the "-D" option.) |
int |
getMavenValidationLevel()
|
MavenModule |
getModule(String name)
|
Collection<MavenModule> |
getModules()
|
DescribableList<Builder,Descriptor<Builder>> |
getPostbuilders()
Builders that are run after the main Maven execution. |
DescribableList<Builder,Descriptor<Builder>> |
getPrebuilders()
Builders that are run before the main Maven execution. |
String |
getProfiles()
If the list of configured goals contain the "-P" option, return the configured profiles. |
DescribableList<Publisher,Descriptor<Publisher>> |
getPublishers()
List of active Publishers. |
DescribableList<Publisher,Descriptor<Publisher>> |
getPublishersList()
|
List<Queue.Item> |
getQueueItems()
Returns the MavenModules that are in the queue. |
DescribableList<MavenReporter,Descriptor<MavenReporter>> |
getReporters()
List of active MavenReporters that should be applied to all module builds. |
protected Set<ResourceActivity> |
getResourceActivities()
|
File |
getRootDirFor(MavenModule child)
|
MavenModule |
getRootModule()
|
String |
getRootPOM()
Deprecated. for backward comp only |
String |
getRootPOM(EnvVars env)
Gets the location of top-level pom.xml relative to the workspace root. |
Result |
getRunPostStepsIfResult()
postbuilders are run if the result is better or equal to this threshold. |
SettingsProvider |
getSettings()
|
String |
getUrlChildPrefix()
|
String |
getUserConfiguredGoals()
Gets the list of goals specified by the user, without taking inheritance and POM default goals into account. |
boolean |
hasDisabledModule()
Returns true if there's any disabled module. |
boolean |
ignoreUpstremChanges()
|
Maven.MavenInstallation |
inferMavenInstallation()
|
boolean |
isAggregatorStyleBuild()
|
boolean |
isArchivingDisabled()
|
boolean |
isDisableTriggerDownstreamProjects()
|
boolean |
isFingerprintConfigured()
|
boolean |
isIncrementalBuild()
|
boolean |
isNonRecursive()
Check for "-N" or "--non-recursive" in the Maven goals/options. |
boolean |
isPerModuleEmail()
|
boolean |
isProcessPlugins()
|
boolean |
isResolveDependencies()
|
void |
logRotate()
|
protected SearchIndexBuilder |
makeSearchIndex()
|
void |
onDeleted(MavenModule item)
|
void |
onLoad(ItemGroup<? extends Item> parent,
String name)
|
void |
onRenamed(MavenModule item,
String oldName,
String newName)
|
Object |
readResolve()
|
boolean |
runHeadless()
|
void |
setAggregatorStyleBuild(boolean aggregatorStyleBuild)
|
void |
setAlternateSettings(String alternateSettings)
Deprecated. as of 1.481 |
void |
setDisableTriggerDownstreamProjects(boolean disableTriggerDownstreamProjects)
|
void |
setGlobalSettings(GlobalSettingsProvider globalSettings)
|
void |
setGoals(String goals)
|
void |
setIgnoreUpstremChanges(boolean ignoreUpstremChanges)
|
void |
setIncrementalBuild(boolean incrementalBuild)
|
void |
setIsArchivingDisabled(boolean archivingDisabled)
|
void |
setLocalRepository(LocalRepositoryLocator localRepository)
|
void |
setMaven(String mavenName)
|
void |
setMavenOpts(String mavenOpts)
Set mavenOpts. |
void |
setProcessPlugins(boolean processPlugins)
|
void |
setResolveDependencies(boolean resolveDependencies)
|
void |
setRootPOM(String rootPOM)
|
void |
setRunHeadless(boolean runHeadless)
|
void |
setRunPostStepsIfResult(Result v)
|
void |
setSettings(SettingsProvider settings)
|
void |
setUsePrivateRepository(boolean usePrivateRepository)
Deprecated. as of 1.448. Use setLocalRepository(LocalRepositoryLocator) instead |
protected void |
submit(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp)
|
protected void |
updateTransientActions()
|
boolean |
usesPrivateRepository()
Deprecated. as of 1.448 Use getLocalRepository() |
| Methods inherited from class hudson.model.AbstractItem |
|---|
checkPermission, delete, doConfigDotXml, doSetName, doSubmitDescription, getAbsoluteUrl, getApi, getConfigFile, getDescription, getDescriptorByName, getDisplayName, getDisplayNameOrNull, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getRootDir, getSearchName, getSearchUrl, getShortUrl, getUrl, hasPermission, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXml |
| Methods inherited from class hudson.model.Actionable |
|---|
addAction, doContextMenu, getAction, getAction, getActions |
| 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.ItemGroup |
|---|
getFullDisplayName, getFullName, getUrl |
| Methods inherited from interface hudson.model.SCMedItem |
|---|
getScm, poll, pollSCMChanges |
| Methods inherited from interface hudson.model.BuildableItem |
|---|
scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild |
| Methods inherited from interface hudson.model.Item |
|---|
delete, getAbsoluteUrl, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl, onCopiedFrom, onCreatedFromScratch |
| 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, getFullDisplayName, getName, getSubTasks, getUrl, getWhyBlocked, hasAbortPermission, isBuildBlocked, isConcurrentBuild |
| Methods inherited from interface hudson.model.queue.SubTask |
|---|
createExecutable, getAssignedLabel, getEstimatedDuration, getLastBuiltOn, getOwnerTask, getSameNodeConstraint |
| Methods inherited from interface hudson.model.ResourceActivity |
|---|
getDisplayName, getResourceList |
| Field Detail |
|---|
protected transient String globalSettingConfigPath
globalSettings
@Extension(ordinal=900.0) public static final MavenModuleSet.DescriptorImpl DESCRIPTOR
| Constructor Detail |
|---|
public MavenModuleSet(String name)
MavenModuleSet(ItemGroup, String)
public MavenModuleSet(ItemGroup parent,
String name)
| Method Detail |
|---|
public Object readResolve()
public DescribableList<Builder,Descriptor<Builder>> getPrebuilders()
public DescribableList<Builder,Descriptor<Builder>> getPostbuilders()
public Result getRunPostStepsIfResult()
postbuilders are run if the result is better or equal to this threshold.
public void setRunPostStepsIfResult(Result v)
public String getUrlChildPrefix()
getUrlChildPrefix in interface ItemGroup<MavenModule>public Collection<MavenModule> getItems()
getItems in interface ItemGroup<MavenModule>@Exported public Collection<MavenModule> getModules()
public MavenModule getItem(String name)
getItem in interface ItemGroup<MavenModule>public MavenModule getModule(String name)
protected void updateTransientActions()
updateTransientActions in class AbstractProject<MavenModuleSet,MavenModuleSetBuild>protected List<Action> createTransientActions()
createTransientActions in class AbstractMavenProject<MavenModuleSet,MavenModuleSetBuild>
protected void addTransientActionsFromBuild(MavenModuleSetBuild build,
List<Action> collection,
Set<Class> added)
addTransientActionsFromBuild in class AbstractMavenProject<MavenModuleSet,MavenModuleSetBuild>collection - Add the transient actions to this collection.public boolean hasDisabledModule()
public List<MavenModule> getDisabledModules(boolean disabled)
public Indenter<MavenModule> createIndenter()
public boolean isIncrementalBuild()
public boolean isAggregatorStyleBuild()
public boolean usesPrivateRepository()
getLocalRepository()
public boolean isPerModuleEmail()
public boolean ignoreUpstremChanges()
public boolean runHeadless()
public boolean isArchivingDisabled()
public void setIncrementalBuild(boolean incrementalBuild)
public void setAggregatorStyleBuild(boolean aggregatorStyleBuild)
public void setUsePrivateRepository(boolean usePrivateRepository)
setLocalRepository(LocalRepositoryLocator) instead
public LocalRepositoryLocator getLocalRepository()
public LocalRepositoryLocator getExplicitLocalRepository()
public void setLocalRepository(LocalRepositoryLocator localRepository)
public void setSettings(SettingsProvider settings)
public void setGlobalSettings(GlobalSettingsProvider globalSettings)
public void setIgnoreUpstremChanges(boolean ignoreUpstremChanges)
public void setRunHeadless(boolean runHeadless)
public void setIsArchivingDisabled(boolean archivingDisabled)
public boolean isResolveDependencies()
public void setResolveDependencies(boolean resolveDependencies)
public boolean isProcessPlugins()
public void setProcessPlugins(boolean processPlugins)
public int getMavenValidationLevel()
public SettingsProvider getSettings()
public GlobalSettingsProvider getGlobalSettings()
public DescribableList<MavenReporter,Descriptor<MavenReporter>> getReporters()
MavenReporters that should be applied to all module builds.
public DescribableList<Publisher,Descriptor<Publisher>> getPublishers()
Publishers. Can be empty but never null.
public DescribableList<Publisher,Descriptor<Publisher>> getPublishersList()
getPublishersList in class AbstractProject<MavenModuleSet,MavenModuleSetBuild>public DescribableList<BuildWrapper,Descriptor<BuildWrapper>> getBuildWrappersList()
getBuildWrappersList in interface BuildableItemWithBuildWrapperspublic DescribableList<BuildWrapper,Descriptor<BuildWrapper>> getBuildWrappers()
getBuildWrappersList() to be consistent with other subtypes of AbstractProject.
BuildWrappers. Can be empty but never null.
public Object getDynamic(String token,
org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp)
getDynamic in class Job<MavenModuleSet,MavenModuleSetBuild>public File getRootDirFor(MavenModule child)
getRootDirFor in interface ItemGroup<MavenModule>
public void onRenamed(MavenModule item,
String oldName,
String newName)
throws IOException
onRenamed in interface ItemGroup<MavenModule>IOException
public void onDeleted(MavenModule item)
throws IOException
onDeleted in interface ItemGroup<MavenModule>IOExceptionpublic Collection<Job> getAllJobs()
getAllJobs in interface ItemgetAllJobs in class Job<MavenModuleSet,MavenModuleSetBuild>protected Class<MavenModuleSetBuild> getBuildClass()
getBuildClass in class AbstractProject<MavenModuleSet,MavenModuleSetBuild>protected SearchIndexBuilder makeSearchIndex()
makeSearchIndex in class AbstractProject<MavenModuleSet,MavenModuleSetBuild>public boolean isFingerprintConfigured()
isFingerprintConfigured in class AbstractProject<MavenModuleSet,MavenModuleSetBuild>
public void onLoad(ItemGroup<? extends Item> parent,
String name)
throws IOException
onLoad in interface ItemonLoad in class AbstractProject<MavenModuleSet,MavenModuleSetBuild>IOException
public int assignBuildNumber()
throws IOException
This method is invoked from Executor.run(),
and because of the mutual exclusion among MavenModuleSetBuild
and MavenBuild, we can safely touch all the modules.
assignBuildNumber in class Job<MavenModuleSet,MavenModuleSetBuild>IOException
public void logRotate()
throws IOException,
InterruptedException
logRotate in class Job<MavenModuleSet,MavenModuleSetBuild>IOException
InterruptedExceptionprotected void buildDependencyGraph(DependencyGraph graph)
buildDependencyGraph in class AbstractProject<MavenModuleSet,MavenModuleSetBuild>public boolean isDisableTriggerDownstreamProjects()
public void setDisableTriggerDownstreamProjects(boolean disableTriggerDownstreamProjects)
public MavenModule getRootModule()
public Maven.MavenInstallation inferMavenInstallation()
inferMavenInstallation in interface Maven.ProjectWithMavenprotected Set<ResourceActivity> getResourceActivities()
getResourceActivities in class AbstractProject<MavenModuleSet,MavenModuleSetBuild>public String getRootPOM()
public String getRootPOM(EnvVars env)
public void setRootPOM(String rootPOM)
public AbstractProject<?,?> asProject()
asProject in interface BuildableItemWithBuildWrappersasProject in interface SCMedItempublic String getGoals()
public void setGoals(String goals)
public String getAlternateSettings()
public void setAlternateSettings(String alternateSettings)
throws IOException
IOExceptionpublic String getProfiles()
public Properties getMavenProperties()
public boolean isNonRecursive()
public String getMavenOpts()
This method returns a configured value as-is, which can include variabl references.
At runtime, use AbstractMavenBuild.getMavenOpts(TaskListener, EnvVars) to obtain
a fully resolved value.
public void setMavenOpts(String mavenOpts)
public Maven.MavenInstallation getMaven()
public void setMaven(String mavenName)
public List<Queue.Item> getQueueItems()
MavenModules that are in the queue.
public List<Queue.Item> getApproximateQueueItemsQuickly()
MavenModules that are in the queue.
public String getUserConfiguredGoals()
This is only used to present the UI screen, and in
all the other cases getGoals() should be used.
protected void submit(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp)
throws IOException,
javax.servlet.ServletException,
Descriptor.FormException
submit in class AbstractProject<MavenModuleSet,MavenModuleSetBuild>IOException
javax.servlet.ServletException
Descriptor.FormException
public org.kohsuke.stapler.HttpResponse doDoDeleteAllDisabledModules()
throws IOException,
InterruptedException
IOException
InterruptedException
public FormValidation doCheckFileInWorkspace(@QueryParameter
String value)
throws IOException,
javax.servlet.ServletException
IOException
javax.servlet.ServletExceptionpublic MavenModuleSet.DescriptorImpl getDescriptor()
getDescriptor in interface Describable<TopLevelItem>getDescriptor in interface TopLevelItem
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||