org.jenkinsci.plugins.jobgenerator

Class JobGenerator

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

org.jenkinsci.plugins.jobgenerator.JobGenerator

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.BuildableItem, hudson.model.BuildableItemWithBuildWrappers, hudson.model.Describable<hudson.model.TopLevelItem>, hudson.model.DescriptorByNameOwner, hudson.model.Item, hudson.model.ModelObject, hudson.model.PersistenceRoot, hudson.model.Queue.FlyweightTask, hudson.model.queue.SubTask, hudson.model.Queue.Task, hudson.model.ResourceActivity, hudson.model.Saveable, hudson.model.SCMedItem, hudson.model.TopLevelItem, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, hudson.tasks.Maven.ProjectWithMaven, jenkins.model.ModelObjectWithContextMenu, jenkins.util.io.OnMaster, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerOverridable

public class JobGenerator
extends hudson.model.Project<JobGenerator,GeneratorRun>
implements hudson.model.TopLevelItem, hudson.model.Queue.FlyweightTask, hudson.model.SCMedItem

Defines project which build action is to generates a new job configuration.

Author:

Sylvain Benner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobGenerator.JobGeneratorDescriptor

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

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.MenuItem

Field Summary

Fields

Modifier and Type	Field and Description
static JobGenerator.JobGeneratorDescriptor	DESCRIPTOR

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

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
JobGenerator(hudson.model.ItemGroup parent, String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkout(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener, File changelogFile)
void	copyOptions(JobGenerator p)
void	doBuild(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, jenkins.util.TimeDuration delay)
hudson.model.Label	getAssignedLabel()
protected Class<GeneratorRun>	getBuildClass()
boolean	getDelete()
JobGenerator.JobGeneratorDescriptor	getDescriptor()
String	getGeneratedDisplayJobName()
String	getGeneratedJobName()
boolean	getProcessThisJobOnly()
String	getPronoun()
<T extends hudson.model.JobProperty> T	getProperty(Class<T> clazz) Returns plugin own parameter definition property which wraps the real one.
hudson.model.JobProperty	getTopMostParameterDefinitionProperty()
boolean	isInitiator()
boolean	isParameterized()
hudson.scm.PollingResult	poll(hudson.model.TaskListener listener)
void	resetInitiator()
boolean	scheduleBuild(int quietPeriod, hudson.model.Cause c, hudson.model.Action... actions)
boolean	schedulePolling()
void	setDelete(boolean check)
void	setGeneratedDisplayJobName(String name)
void	setGeneratedJobName(String name)
void	setProcessThisJobOnly(boolean check)
protected void	submit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)

Methods inherited from class hudson.model.Project

addPublisher, asProject, buildDependencyGraph, createTransientActions, getBuilders, getBuildersList, getBuildWrappers, getBuildWrappersList, getPublisher, getPublishers, getPublishersList, getResourceActivities, inferMavenInstallation, isFingerprintConfigured, onLoad, removePublisher

Methods inherited from class hudson.model.AbstractProject

_getRuns, addProperty, addToList, addTrigger, blockBuildWhenDownstreamBuilding, blockBuildWhenUpstreamBuilding, buildDescribable, buildDescribable, checkAbortPermission, createExecutable, createHistoryWidget, disable, doBuildWithParameters, doCancelQueue, doCheckRetryCount, doConfigSubmit, doDisable, doDoDelete, doDoWipeOutWorkspace, doEnable, doPolling, doRssChangelog, doWs, enable, findNearest, findNearest, getActions, getAssignedLabelString, getAuthToken, getBuild, getBuildByNumber, getBuildingDownstream, getBuildingUpstream, getBuildNowText, getBuildTriggerUpstreamProjects, getCauseOfBlockage, getCustomWorkspace, getDelay, getDownstreamProjects, getEnvironment, getFirstBuild, getHasCustomQuietPeriod, getIconColor, getJDK, getLastBuild, getLastBuiltOn, getModuleRoot, getModuleRoots, getNearestBuild, getNearestOldBuild, getOwnerTask, getProminentActions, getQueueItem, getQuietPeriod, getRelationship, getRelevantLabels, 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, loadBuild, makeDisabled, makeSearchIndex, newBuild, onCreatedFromScratch, performDelete, pollSCMChanges, removeFromList, removeRun, removeTrigger, resolveForCLI, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild2, scheduleBuild2, scheduleBuild2, scheduleBuild2, setAssignedLabel, setAssignedNode, setBlockBuildWhenDownstreamBuilding, setBlockBuildWhenUpstreamBuilding, setConcurrentBuild, setCustomWorkspace, setJDK, setQuietPeriod, setScm, setScmCheckoutStrategy, supportsMakeDisabled, updateTransientActions

Methods inherited from class hudson.model.Job

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

Methods inherited from class hudson.model.AbstractItem

checkPermission, delete, 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.SCMedItem

asProject, getScm, pollSCMChanges

Methods inherited from interface hudson.model.BuildableItem

scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild

Methods inherited from interface hudson.model.Item

delete, getAbsoluteUrl, getAllJobs, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl, onCopiedFrom, onCreatedFromScratch, onLoad, 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, getFullDisplayName, getName, getSubTasks, getUrl, getWhyBlocked, hasAbortPermission, isBuildBlocked, isConcurrentBuild

Methods inherited from interface hudson.model.queue.SubTask

createExecutable, getEstimatedDuration, getLastBuiltOn, getOwnerTask, getSameNodeConstraint

Methods inherited from interface hudson.model.ResourceActivity

getDisplayName, getResourceList

Field Detail

DESCRIPTOR

@Extension
public static final JobGenerator.JobGeneratorDescriptor DESCRIPTOR

Constructor Detail

JobGenerator

@DataBoundConstructor
public JobGenerator(hudson.model.ItemGroup parent,
                                 String name)

Method Detail

doBuild

public void doBuild(org.kohsuke.stapler.StaplerRequest req,
           org.kohsuke.stapler.StaplerResponse rsp,
           jenkins.util.TimeDuration delay)
             throws IOException,
                    javax.servlet.ServletException

Overrides:

doBuild in class hudson.model.AbstractProject<JobGenerator,GeneratorRun>

Throws:

IOException

javax.servlet.ServletException

isParameterized

public boolean isParameterized()

Overrides:

isParameterized in class hudson.model.AbstractProject<JobGenerator,GeneratorRun>

getProperty

public <T extends hudson.model.JobProperty> T getProperty(Class<T> clazz)

Returns plugin own parameter definition property which wraps the real one.

Overrides:

getProperty in class hudson.model.Job<JobGenerator,GeneratorRun>

getAssignedLabel

public hudson.model.Label getAssignedLabel()

Specified by:

getAssignedLabel in interface hudson.model.queue.SubTask

Overrides:

getAssignedLabel in class hudson.model.AbstractProject<JobGenerator,GeneratorRun>

checkout

public boolean checkout(hudson.model.AbstractBuild build,
               hudson.Launcher launcher,
               hudson.model.BuildListener listener,
               File changelogFile)
                 throws IOException,
                        InterruptedException

Overrides:

checkout in class hudson.model.AbstractProject<JobGenerator,GeneratorRun>

Throws:

IOException

InterruptedException

schedulePolling

public boolean schedulePolling()

Overrides:

schedulePolling in class hudson.model.AbstractProject<JobGenerator,GeneratorRun>

poll

public hudson.scm.PollingResult poll(hudson.model.TaskListener listener)

Specified by:

poll in interface hudson.model.SCMedItem

Overrides:

poll in class hudson.model.AbstractProject<JobGenerator,GeneratorRun>

scheduleBuild

public boolean scheduleBuild(int quietPeriod,
                    hudson.model.Cause c,
                    hudson.model.Action... actions)

Overrides:

scheduleBuild in class hudson.model.AbstractProject<JobGenerator,GeneratorRun>

submit

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

Overrides:

submit in class hudson.model.Project<JobGenerator,GeneratorRun>

Throws:

IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

getDescriptor

public JobGenerator.JobGeneratorDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.model.TopLevelItem>

Specified by:

getDescriptor in interface hudson.model.TopLevelItem

getPronoun

public String getPronoun()

Overrides:

getPronoun in class hudson.model.AbstractProject<JobGenerator,GeneratorRun>

getBuildClass

protected Class<GeneratorRun> getBuildClass()

Specified by:

getBuildClass in class hudson.model.AbstractProject<JobGenerator,GeneratorRun>

getTopMostParameterDefinitionProperty

public hudson.model.JobProperty getTopMostParameterDefinitionProperty()

isInitiator

public boolean isInitiator()

resetInitiator

public void resetInitiator()

getGeneratedJobName

public String getGeneratedJobName()

setGeneratedJobName

public void setGeneratedJobName(String name)

getGeneratedDisplayJobName

public String getGeneratedDisplayJobName()

setGeneratedDisplayJobName

public void setGeneratedDisplayJobName(String name)

getProcessThisJobOnly

public boolean getProcessThisJobOnly()

setProcessThisJobOnly

public void setProcessThisJobOnly(boolean check)

getDelete

public boolean getDelete()

setDelete

public void setDelete(boolean check)

copyOptions

public void copyOptions(JobGenerator p)