Package 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:

ExtensionPoint, BuildableItem, Describable<TopLevelItem>, DescriptorByNameOwner, Item, ModelObject, PersistenceRoot, Queue.FlyweightTask, SubTask, Queue.Task, ResourceActivity, Saveable, TopLevelItem, SearchableModelObject, SearchItem, AccessControlled, LazyBuildMixIn.LazyLoadingJob<WorkflowJob,WorkflowRun>, Loadable, ModelObjectWithChildren, ModelObjectWithContextMenu, ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>, SCMTriggerItem, TriggeredItem, OnMaster, HasWidgets, org.jenkinsci.plugins.workflow.flow.BlockableResume, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerOverridable, org.kohsuke.stapler.StaplerProxy

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

Nested Class Summary

Nested Classes

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

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

Job.LastItemListener, Job.SubItemBuildsLocationImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface org.kohsuke.stapler.HttpDeletable

org.kohsuke.stapler.HttpDeletable.HttpDeletableDispatcher

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem, ModelObjectWithContextMenu.MenuItemType

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

SCMTriggerItem.SCMTriggerItems

Field Summary

Fields

Modifier and Type	Field	Description
static final 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	Description
WorkflowJob(ItemGroup parent, String name)

Method Summary

Modifier and Type	Method	Description
protected RunMap<WorkflowRun>	_getRuns()
void	addAction(Action a)
void	addProperty(JobProperty jobProp)
void	addTrigger(Trigger trigger)
void	addTriggersJobPropertyWithoutStart(PipelineTriggersJobProperty prop)
static void	alias()
Item	asItem()
ACL	getACL()
Label	getAssignedLabel()
BuildAuthorizationToken	getAuthToken()
WorkflowRun	getBuild(String id)	Deprecated.
WorkflowRun	getBuildByNumber(int n)
CauseOfBlockage	getCauseOfBlockage()
org.jenkinsci.plugins.workflow.flow.FlowDefinition	getDefinition()
TopLevelItemDescriptor	getDescriptor()
protected List<WorkflowRun>	getEstimatedDurationCandidates()
WorkflowRun	getFirstBuild()
boolean	getHasCustomQuietPeriod()
BallColor	getIconColor()
WorkflowRun	getLastBuild()
Node	getLastBuiltOn()
LazyBuildMixIn<WorkflowJob,WorkflowRun>	getLazyBuildMixIn()
WorkflowRun	getNearestBuild(int n)
WorkflowRun	getNearestOldBuild(int n)
String	getPronoun()
Queue.Item	getQueueItem()
int	getQuietPeriod()
Object	getSameNodeConstraint()
Collection<? extends SCM>	getSCMs()
SCMTrigger	getSCMTrigger()
Collection<? extends SubTask>	getSubTasks()
Map<TriggerDescriptor,Trigger<?>>	getTriggers()
PipelineTriggersJobProperty	getTriggersJobProperty()
SCM	getTypicalSCM()
boolean	isBuildable()
boolean	isConcurrentBuild()
boolean	isDisabled()
boolean	isInQueue()
boolean	isResumeBlocked()
protected SearchIndexBuilder	makeSearchIndex()
void	onCreatedFromScratch()
void	onLoad(ItemGroup<? extends Item> parent, String name)
protected void	performDelete()
PollingResult	poll(TaskListener listener)
void	removeProperty(JobProperty jobProperty)
protected void	removeRun(WorkflowRun run)
void	replaceAction(Action a)
QueueTaskFuture<WorkflowRun>	scheduleBuild2(int quietPeriod, 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<Trigger<?>> inputTriggers)
protected void	submit(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
boolean	supportsMakeDisabled()

Methods inherited from class hudson.model.Job

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

Methods inherited from class hudson.model.AbstractItem

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

Methods inherited from class hudson.model.Actionable

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

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, requirePOST, sendError, sendError, sendError, 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.security.AccessControlled

checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface hudson.model.BuildableItem

scheduleBuild, scheduleBuild

Methods inherited from interface hudson.model.DescriptorByNameOwner

getDescriptorByName

Methods inherited from interface jenkins.widgets.HasWidgets

getWidget, getWidgets

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

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

Methods inherited from interface hudson.model.PersistenceRoot

getRootDir

Methods inherited from interface hudson.model.Queue.Task

checkAbortPermission, getAffinityKey, getDefaultAuthentication, getDefaultAuthentication, getDefaultAuthentication2, getDefaultAuthentication2, getFullDisplayName, getName, getUrl, getWhyBlocked, hasAbortPermission, isBuildBlocked

Methods inherited from interface hudson.model.ResourceActivity

getDisplayName, getResourceList

Methods inherited from interface jenkins.triggers.SCMTriggerItem

getNextBuildNumber, schedulePolling

Methods inherited from interface hudson.search.SearchableModelObject

getSearch

Methods inherited from interface hudson.search.SearchItem

getSearchIndex, getSearchName, getSearchUrl

Methods inherited from interface hudson.model.queue.SubTask

getEstimatedDuration, getOwnerExecutable, getOwnerTask

Field Details

ABORT

@Deprecated
public static final Permission ABORT

Deprecated.

Just use Item.CANCEL.

Constructor Details

WorkflowJob

public WorkflowJob(ItemGroup parent,
 String name)

Method Details

onCreatedFromScratch

public void onCreatedFromScratch()

Specified by:

onCreatedFromScratch in interface Item

Overrides:

onCreatedFromScratch in class Job<WorkflowJob,WorkflowRun>

onLoad

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

Specified by:

onLoad in interface Item

Overrides:

onLoad in class 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.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
               throws IOException,
jakarta.servlet.ServletException,
Descriptor.FormException

Overrides:

submit in class Job<WorkflowJob,WorkflowRun>

Throws:

IOException

jakarta.servlet.ServletException

Descriptor.FormException

addProperty

public void addProperty(JobProperty jobProp)
                 throws IOException

Overrides:

addProperty in class Job<WorkflowJob,WorkflowRun>

Throws:

IOException

isBuildable

public boolean isBuildable()

Specified by:

isBuildable in interface ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

Specified by:

isBuildable in class Job<WorkflowJob,WorkflowRun>

_getRuns

protected RunMap<WorkflowRun> _getRuns()

Specified by:

_getRuns in class Job<WorkflowJob,WorkflowRun>

getLazyBuildMixIn

public LazyBuildMixIn<WorkflowJob,WorkflowRun> getLazyBuildMixIn()

Specified by:

getLazyBuildMixIn in interface LazyBuildMixIn.LazyLoadingJob<WorkflowJob,WorkflowRun>

removeRun

protected void removeRun(WorkflowRun run)

Specified by:

removeRun in class Job<WorkflowJob,WorkflowRun>

getBuild

@Deprecated
public WorkflowRun getBuild(String id)

Deprecated.

Overrides:

getBuild in class Job<WorkflowJob,WorkflowRun>

getBuildByNumber

public WorkflowRun getBuildByNumber(int n)

Overrides:

getBuildByNumber in class Job<WorkflowJob,WorkflowRun>

getFirstBuild

public WorkflowRun getFirstBuild()

Overrides:

getFirstBuild in class Job<WorkflowJob,WorkflowRun>

getLastBuild

public WorkflowRun getLastBuild()

Overrides:

getLastBuild in class Job<WorkflowJob,WorkflowRun>

getNearestBuild

public WorkflowRun getNearestBuild(int n)

Overrides:

getNearestBuild in class Job<WorkflowJob,WorkflowRun>

getNearestOldBuild

public WorkflowRun getNearestOldBuild(int n)

Overrides:

getNearestOldBuild in class Job<WorkflowJob,WorkflowRun>

getEstimatedDurationCandidates

protected List<WorkflowRun> getEstimatedDurationCandidates()

Overrides:

getEstimatedDurationCandidates in class Job<WorkflowJob,WorkflowRun>

scheduleBuild2

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

Specified by:

scheduleBuild2 in interface ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

Specified by:

scheduleBuild2 in interface SCMTriggerItem

makeSearchIndex

protected SearchIndexBuilder makeSearchIndex()

Overrides:

makeSearchIndex in class Job<WorkflowJob,WorkflowRun>

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

setDisabled

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

Specified by:

setDisabled in interface ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

supportsMakeDisabled

public boolean supportsMakeDisabled()

Specified by:

supportsMakeDisabled in interface ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

getIconColor

public BallColor getIconColor()

Overrides:

getIconColor in class Job<WorkflowJob,WorkflowRun>

getAuthToken

public BuildAuthorizationToken getAuthToken()

Specified by:

getAuthToken in interface ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

getQuietPeriod

public int getQuietPeriod()

Specified by:

getQuietPeriod in interface ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>

Specified by:

getQuietPeriod in interface SCMTriggerItem

getHasCustomQuietPeriod

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

setQuietPeriod

public void setQuietPeriod(Integer seconds)
                    throws IOException

Throws:

IOException

isInQueue

@Exported
public boolean isInQueue()

Overrides:

isInQueue in class Job<WorkflowJob,WorkflowRun>

getQueueItem

@Exported
public Queue.Item getQueueItem()

Overrides:

getQueueItem in class Job<WorkflowJob,WorkflowRun>

getCauseOfBlockage

public CauseOfBlockage getCauseOfBlockage()

Specified by:

getCauseOfBlockage in interface Queue.Task

isConcurrentBuild

@Exported
public boolean isConcurrentBuild()

Specified by:

isConcurrentBuild in interface 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

@NonNull
public ACL getACL()

Specified by:

getACL in interface AccessControlled

Overrides:

getACL in class Job<WorkflowJob,WorkflowRun>

getSubTasks

public Collection<? extends SubTask> getSubTasks()

Specified by:

getSubTasks in interface Queue.Task

getAssignedLabel

public Label getAssignedLabel()

Specified by:

getAssignedLabel in interface SubTask

getLastBuiltOn

public Node getLastBuiltOn()

Specified by:

getLastBuiltOn in interface SubTask

getSameNodeConstraint

public Object getSameNodeConstraint()

Specified by:

getSameNodeConstraint in interface SubTask

getPronoun

public String getPronoun()

Overrides:

getPronoun in class Job<WorkflowJob,WorkflowRun>

getDescriptor

public TopLevelItemDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<TopLevelItem>

Specified by:

getDescriptor in interface TopLevelItem

getTriggers

public Map<TriggerDescriptor,Trigger<?>> getTriggers()

Specified by:

getTriggers in interface TriggeredItem

getTriggersJobProperty

public PipelineTriggersJobProperty getTriggersJobProperty()

addTriggersJobPropertyWithoutStart

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

Throws:

IOException

setTriggers

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

Throws:

IOException

addTrigger

public void addTrigger(Trigger trigger)
                throws IOException

Throws:

IOException

removeProperty

public void removeProperty(JobProperty jobProperty)
                    throws IOException

Overrides:

removeProperty in class Job<WorkflowJob,WorkflowRun>

Throws:

IOException

addAction

public void addAction(@NonNull
 Action a)

Overrides:

addAction in class Actionable

replaceAction

public void replaceAction(@NonNull
 Action a)

Overrides:

replaceAction in class Actionable

asItem

public Item asItem()

Specified by:

asItem in interface SCMTriggerItem

getSCMTrigger

public SCMTrigger getSCMTrigger()

Specified by:

getSCMTrigger in interface SCMTriggerItem

getSCMs

@NonNull
public Collection<? extends SCM> getSCMs()

Specified by:

getSCMs in interface SCMTriggerItem

getTypicalSCM

@CheckForNull
public SCM getTypicalSCM()

poll

@NonNull
public PollingResult poll(@NonNull
 TaskListener listener)

Specified by:

poll in interface SCMTriggerItem

performDelete

protected void performDelete()
                      throws IOException,
InterruptedException

Overrides:

performDelete in class AbstractItem

Throws:

IOException

InterruptedException

alias

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