org.jenkinsci.plugins.workflow.job

Class WorkflowJob

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.AbstractItem

hudson.model.Job<WorkflowJob,WorkflowRun>

org.jenkinsci.plugins.workflow.job.WorkflowJob

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.BuildableItem, 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.TopLevelItem, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, jenkins.model.lazy.LazyBuildMixIn.LazyLoadingJob<WorkflowJob,WorkflowRun>, jenkins.model.ModelObjectWithChildren, jenkins.model.ModelObjectWithContextMenu, jenkins.model.ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>, jenkins.triggers.SCMTriggerItem, jenkins.util.io.OnMaster, org.jenkinsci.plugins.workflow.flow.BlockableResume, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerOverridable, org.kohsuke.stapler.StaplerProxy

public final class WorkflowJob
extends hudson.model.Job<WorkflowJob,WorkflowRun>
implements jenkins.model.lazy.LazyBuildMixIn.LazyLoadingJob<WorkflowJob,WorkflowRun>, jenkins.model.ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>, hudson.model.TopLevelItem, hudson.model.Queue.FlyweightTask, jenkins.triggers.SCMTriggerItem, org.jenkinsci.plugins.workflow.flow.BlockableResume

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkflowJob.DescriptorImpl
static class	WorkflowJob.SCMListenerImpl

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

hudson.model.Job.LastItemListener, hudson.model.Job.SubItemBuildsLocationImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

jenkins.triggers.SCMTriggerItem.SCMTriggerItems

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 hudson.security.Permission	ABORT Deprecated. Just use Item.CANCEL.

Fields inherited from class hudson.model.Job

HISTORY_ADAPTER, nextBuildNumber, properties, runIdMigrator

Fields inherited from class hudson.model.AbstractItem

description, displayName, name, PRONOUN, SKIP_PERMISSION_CHECK, TASK_NOUN

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
WorkflowJob(hudson.model.ItemGroup parent, String name)

Method Summary

Modifier and Type	Method and Description
protected hudson.model.RunMap<WorkflowRun>	_getRuns()
void	addAction(hudson.model.Action a)
void	addProperty(hudson.model.JobProperty jobProp)
void	addTrigger(hudson.triggers.Trigger trigger)
void	addTriggersJobPropertyWithoutStart(PipelineTriggersJobProperty prop)
static void	alias()
hudson.model.Item	asItem()
void	checkAbortPermission()
protected hudson.widgets.HistoryWidget	createHistoryWidget()
hudson.security.ACL	getACL()
hudson.model.Label	getAssignedLabel()
hudson.model.BuildAuthorizationToken	getAuthToken()
WorkflowRun	getBuild(String id) Deprecated.
WorkflowRun	getBuildByNumber(int n)
hudson.model.queue.CauseOfBlockage	getCauseOfBlockage()
org.jenkinsci.plugins.workflow.flow.FlowDefinition	getDefinition()
hudson.model.TopLevelItemDescriptor	getDescriptor()
WorkflowRun	getFirstBuild()
boolean	getHasCustomQuietPeriod()
hudson.model.BallColor	getIconColor()
WorkflowRun	getLastBuild()
hudson.model.Node	getLastBuiltOn()
jenkins.model.lazy.LazyBuildMixIn<WorkflowJob,WorkflowRun>	getLazyBuildMixIn()
WorkflowRun	getNearestBuild(int n)
WorkflowRun	getNearestOldBuild(int n)
String	getPronoun()
int	getQuietPeriod()
Object	getSameNodeConstraint()
Collection<? extends hudson.scm.SCM>	getSCMs()
hudson.triggers.SCMTrigger	getSCMTrigger()
Collection<? extends hudson.model.queue.SubTask>	getSubTasks()
Map<hudson.triggers.TriggerDescriptor,hudson.triggers.Trigger<?>>	getTriggers()
PipelineTriggersJobProperty	getTriggersJobProperty()
hudson.scm.SCM	getTypicalSCM()
boolean	hasAbortPermission()
boolean	isBuildable()
boolean	isConcurrentBuild()
boolean	isDisabled()
boolean	isResumeBlocked()
protected hudson.search.SearchIndexBuilder	makeSearchIndex()
void	onCreatedFromScratch()
void	onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent, String name)
protected void	performDelete()
hudson.scm.PollingResult	poll(hudson.model.TaskListener listener)
void	removeProperty(hudson.model.JobProperty jobProperty)
protected void	removeRun(WorkflowRun run)
void	replaceAction(hudson.model.Action a)
hudson.model.queue.QueueTaskFuture<WorkflowRun>	scheduleBuild2(int quietPeriod, hudson.model.Action... actions)
void	setConcurrentBuild(boolean b)
void	setDefinition(org.jenkinsci.plugins.workflow.flow.FlowDefinition definition)
void	setDisabled(boolean disabled)
void	setQuietPeriod(Integer seconds)
void	setResumeBlocked(boolean resumeBlocked)
void	setTriggers(List<hudson.triggers.Trigger<?>> inputTriggers)
protected void	submit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
boolean	supportsMakeDisabled()

Methods inherited from class hudson.model.Job

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

Methods inherited from class hudson.model.AbstractItem

delete, doCheckNewName, doConfigDotXml, doConfirmRename, doDoDelete, doReload, doSetName, doSubmitDescription, getAbsoluteUrl, getApi, getConfigFile, getDescription, getDisplayName, getDisplayNameOrNull, getFullDisplayName, getFullName, getName, getParent, getRelativeDisplayNameFrom, getRelativeNameFromGroup, getRootDir, getSearchName, getSearchUrl, getShortUrl, getTarget, getTaskNoun, getUrl, resolveForCLI, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXml, writeConfigDotXml

Methods inherited from class hudson.model.Actionable

addOrReplaceAction, doContextMenu, getAction, getAction, getActions, getActions, getAllActions, removeAction, removeActions, replaceActions

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 jenkins.model.ParameterizedJobMixIn.ParameterizedJob

createExecutable, doBuild, doBuildWithParameters, doCancelQueue, doDisable, doEnable, doPolling, getBuildNowText, getParameterizedJobMixIn, isParameterized, makeDisabled, resolveForCLI, scheduleBuild, scheduleBuild

Methods inherited from interface hudson.model.BuildableItem

scheduleBuild, scheduleBuild

Methods inherited from interface hudson.model.Item

delete, getAbsoluteUrl, getAllJobs, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, 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, hasPermission, hasPermission

Methods inherited from interface hudson.model.Queue.Task

getDefaultAuthentication, getDefaultAuthentication, getFullDisplayName, getName, getUrl, getWhyBlocked, isBuildBlocked

Methods inherited from interface hudson.model.queue.SubTask

getEstimatedDuration, getOwnerTask

Methods inherited from interface hudson.model.ResourceActivity

getDisplayName, getResourceList

Methods inherited from interface jenkins.triggers.SCMTriggerItem

getNextBuildNumber, schedulePolling

Methods inherited from interface hudson.model.DescriptorByNameOwner

getDescriptorByName

Field Detail

ABORT

@Deprecated
public static final hudson.security.Permission ABORT

Deprecated. Just use Item.CANCEL.

Constructor Detail

WorkflowJob

public WorkflowJob(hudson.model.ItemGroup parent,
                   String name)

Method Detail

onCreatedFromScratch

public void onCreatedFromScratch()

Specified by:

onCreatedFromScratch in interface hudson.model.Item

Overrides:

onCreatedFromScratch in class hudson.model.Job<WorkflowJob,WorkflowRun>

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.Job<WorkflowJob,WorkflowRun>

Throws:

IOException

getDefinition

public org.jenkinsci.plugins.workflow.flow.FlowDefinition getDefinition()

setDefinition

public void setDefinition(org.jenkinsci.plugins.workflow.flow.FlowDefinition definition)

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.Job<WorkflowJob,WorkflowRun>

Throws:

IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

addProperty

public void addProperty(hudson.model.JobProperty jobProp)
                 throws IOException

Overrides:

addProperty in class hudson.model.Job<WorkflowJob,WorkflowRun>

Throws:

IOException

isBuildable

public boolean isBuildable()

Specified by:

isBuildable in interface jenkins.model.ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

Specified by:

isBuildable in class hudson.model.Job<WorkflowJob,WorkflowRun>

_getRuns

protected hudson.model.RunMap<WorkflowRun> _getRuns()

Specified by:

_getRuns in class hudson.model.Job<WorkflowJob,WorkflowRun>

getLazyBuildMixIn

public jenkins.model.lazy.LazyBuildMixIn<WorkflowJob,WorkflowRun> getLazyBuildMixIn()

Specified by:

getLazyBuildMixIn in interface jenkins.model.lazy.LazyBuildMixIn.LazyLoadingJob<WorkflowJob,WorkflowRun>

removeRun

protected void removeRun(WorkflowRun run)

Specified by:

removeRun in class hudson.model.Job<WorkflowJob,WorkflowRun>

getBuild

@Deprecated
public WorkflowRun getBuild(String id)

Deprecated.

Overrides:

getBuild in class hudson.model.Job<WorkflowJob,WorkflowRun>

getBuildByNumber

public WorkflowRun getBuildByNumber(int n)

Overrides:

getBuildByNumber in class hudson.model.Job<WorkflowJob,WorkflowRun>

getFirstBuild

public WorkflowRun getFirstBuild()

Overrides:

getFirstBuild in class hudson.model.Job<WorkflowJob,WorkflowRun>

getLastBuild

public WorkflowRun getLastBuild()

Overrides:

getLastBuild in class hudson.model.Job<WorkflowJob,WorkflowRun>

getNearestBuild

public WorkflowRun getNearestBuild(int n)

Overrides:

getNearestBuild in class hudson.model.Job<WorkflowJob,WorkflowRun>

getNearestOldBuild

public WorkflowRun getNearestOldBuild(int n)

Overrides:

getNearestOldBuild in class hudson.model.Job<WorkflowJob,WorkflowRun>

createHistoryWidget

protected hudson.widgets.HistoryWidget createHistoryWidget()

Overrides:

createHistoryWidget in class hudson.model.Job<WorkflowJob,WorkflowRun>

scheduleBuild2

@CheckForNull
public hudson.model.queue.QueueTaskFuture<WorkflowRun> scheduleBuild2(int quietPeriod,
                                                                                    hudson.model.Action... actions)

Specified by:

scheduleBuild2 in interface jenkins.model.ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

Specified by:

scheduleBuild2 in interface jenkins.triggers.SCMTriggerItem

makeSearchIndex

protected hudson.search.SearchIndexBuilder makeSearchIndex()

Overrides:

makeSearchIndex in class hudson.model.Job<WorkflowJob,WorkflowRun>

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface jenkins.model.ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

setDisabled

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public void setDisabled(boolean disabled)

Specified by:

setDisabled in interface jenkins.model.ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

supportsMakeDisabled

public boolean supportsMakeDisabled()

Specified by:

supportsMakeDisabled in interface jenkins.model.ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

getIconColor

public hudson.model.BallColor getIconColor()

Overrides:

getIconColor in class hudson.model.Job<WorkflowJob,WorkflowRun>

getAuthToken

public hudson.model.BuildAuthorizationToken getAuthToken()

Specified by:

getAuthToken in interface jenkins.model.ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

getQuietPeriod

public int getQuietPeriod()

Specified by:

getQuietPeriod in interface jenkins.model.ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

Specified by:

getQuietPeriod in interface jenkins.triggers.SCMTriggerItem

getHasCustomQuietPeriod

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public boolean getHasCustomQuietPeriod()

setQuietPeriod

public void setQuietPeriod(Integer seconds)
                    throws IOException

Throws:

IOException

getCauseOfBlockage

public hudson.model.queue.CauseOfBlockage getCauseOfBlockage()

Specified by:

getCauseOfBlockage in interface hudson.model.Queue.Task

isConcurrentBuild

@Exported
public boolean isConcurrentBuild()

Specified by:

isConcurrentBuild in interface hudson.model.Queue.Task

isResumeBlocked

@Exported
public boolean isResumeBlocked()

Specified by:

isResumeBlocked in interface org.jenkinsci.plugins.workflow.flow.BlockableResume

setResumeBlocked

public void setResumeBlocked(boolean resumeBlocked)

Specified by:

setResumeBlocked in interface org.jenkinsci.plugins.workflow.flow.BlockableResume

setConcurrentBuild

public void setConcurrentBuild(boolean b)
                        throws IOException

Throws:

IOException

getACL

public hudson.security.ACL getACL()

Specified by:

getACL in interface hudson.security.AccessControlled

Overrides:

getACL in class hudson.model.Job<WorkflowJob,WorkflowRun>

checkAbortPermission

public void checkAbortPermission()

Specified by:

checkAbortPermission in interface hudson.model.Queue.Task

hasAbortPermission

public boolean hasAbortPermission()

Specified by:

hasAbortPermission in interface hudson.model.Queue.Task

getSubTasks

public Collection<? extends hudson.model.queue.SubTask> getSubTasks()

Specified by:

getSubTasks in interface hudson.model.Queue.Task

getAssignedLabel

public hudson.model.Label getAssignedLabel()

Specified by:

getAssignedLabel in interface hudson.model.queue.SubTask

getLastBuiltOn

public hudson.model.Node getLastBuiltOn()

Specified by:

getLastBuiltOn in interface hudson.model.queue.SubTask

getSameNodeConstraint

public Object getSameNodeConstraint()

Specified by:

getSameNodeConstraint in interface hudson.model.queue.SubTask

getPronoun

public String getPronoun()

Overrides:

getPronoun in class hudson.model.Job<WorkflowJob,WorkflowRun>

getDescriptor

public hudson.model.TopLevelItemDescriptor getDescriptor()

Specified by:

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

Specified by:

getDescriptor in interface hudson.model.TopLevelItem

getTriggers

public Map<hudson.triggers.TriggerDescriptor,hudson.triggers.Trigger<?>> getTriggers()

Specified by:

getTriggers in interface jenkins.model.ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

getTriggersJobProperty

public PipelineTriggersJobProperty getTriggersJobProperty()

addTriggersJobPropertyWithoutStart

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void addTriggersJobPropertyWithoutStart(PipelineTriggersJobProperty prop)
                                                                                                               throws IOException

Throws:

IOException

setTriggers

public void setTriggers(List<hudson.triggers.Trigger<?>> inputTriggers)
                 throws IOException

Throws:

IOException

addTrigger

public void addTrigger(hudson.triggers.Trigger trigger)
                throws IOException

Throws:

IOException

removeProperty

public void removeProperty(hudson.model.JobProperty jobProperty)
                    throws IOException

Overrides:

removeProperty in class hudson.model.Job<WorkflowJob,WorkflowRun>

Throws:

IOException

addAction

public void addAction(hudson.model.Action a)

Overrides:

addAction in class hudson.model.Actionable

replaceAction

public void replaceAction(hudson.model.Action a)

Overrides:

replaceAction in class hudson.model.Actionable

asItem

public hudson.model.Item asItem()

Specified by:

asItem in interface jenkins.triggers.SCMTriggerItem

getSCMTrigger

public hudson.triggers.SCMTrigger getSCMTrigger()

Specified by:

getSCMTrigger in interface jenkins.triggers.SCMTriggerItem

getSCMs

public Collection<? extends hudson.scm.SCM> getSCMs()

Specified by:

getSCMs in interface jenkins.triggers.SCMTriggerItem

getTypicalSCM

@CheckForNull
public hudson.scm.SCM getTypicalSCM()

poll

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

Specified by:

poll in interface jenkins.triggers.SCMTriggerItem

performDelete

protected void performDelete()
                      throws IOException,
                             InterruptedException

Overrides:

performDelete in class hudson.model.AbstractItem

Throws:

IOException

InterruptedException

alias

@Initializer(before=EXTENSIONS_AUGMENTED)
public static void alias()