org.jenkinsci.plugins.asyncjob

Class AsyncJob<P extends AsyncJob<P,R>,R extends AsyncRun<P,R>>

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.AbstractItem

hudson.model.Job<P,R>

org.jenkinsci.plugins.asyncjob.AsyncJob<P,R>

All Implemented Interfaces:

hudson.ExtensionPoint, 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.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, jenkins.model.ModelObjectWithContextMenu, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerOverridable

public abstract class AsyncJob<P extends AsyncJob<P,R>,R extends AsyncRun<P,R>>
extends hudson.model.Job<P,R>
implements hudson.model.Queue.FlyweightTask

Author:

Kohsuke Kawaguchi

Nested Class Summary

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

Modifier	Constructor and Description
protected	AsyncJob(hudson.model.ItemGroup parent, String name)

Method Summary

Methods

Modifier and Type	Method and Description
protected SortedMap<Integer,R>	_getRuns()
void	checkAbortPermission()
R	createExecutable()
void	doBuild(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Schedules a new build command.
hudson.model.Label	getAssignedLabel() Because we are modeling an asynchronous task that runs elsewhere, we don't care where we run.
protected Class<R>	getBuildClass() Determines Class<R>.
hudson.model.queue.CauseOfBlockage	getCauseOfBlockage()
hudson.model.Node	getLastBuiltOn() Flyweight task doesn't really care where to run.
hudson.model.Queue.Task	getOwnerTask() This is the master task.
hudson.model.ResourceList	getResourceList() Default implementation: no constraint.
Object	getSameNodeConstraint() No constraint because we don't care where to run.
Collection<? extends hudson.model.queue.SubTask>	getSubTasks()
String	getWhyBlocked()
boolean	hasAbortPermission()
boolean	isBuildable()
boolean	isBuildBlocked()
boolean	isConcurrentBuild() Most subtypes probably want to support concurrent builds, although some may want to override.
protected R	loadBuild(File dir) Loads an existing build record from disk.
void	onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent, String name)
protected void	removeRun(R run)

Methods inherited from class hudson.model.Job

addProperty, assignBuildNumber, createHistoryWidget, doBuildStatus, doConfigSubmit, doDescription, doDoRename, doRssAll, doRssFailed, getACL, getAllJobs, getAllProperties, getBuild, getBuildByNumber, getBuildDir, getBuildForCLI, getBuildHealth, getBuildHealthReports, getBuilds, getBuilds, getBuildsAsMap, getBuildsByTimestamp, getBuildStatusUrl, getBuildTimeGraph, getDynamic, getEstimatedDuration, getFirstBuild, getIconColor, getLastBuild, getLastBuildsOverThreshold, getLastCompletedBuild, getLastFailedBuild, getLastStableBuild, getLastSuccessfulBuild, getLastUnstableBuild, getLastUnsuccessfulBuild, getLogRotator, getNearestBuild, getNearestOldBuild, getNextBuildNumber, getOverrides, getPermalinks, getPronoun, getProperties, getProperty, getProperty, getQueueItem, getTimeline, getWidgets, isBuilding, isHoldOffBuildUntilSave, isInQueue, isKeepDependencies, isLogUpdated, isNameEditable, logRotate, makeSearchIndex, onCopiedFrom, performDelete, removeProperty, removeProperty, renameTo, save, saveNextBuildNumber, setLogRotator, submit, supportsLogRotator, updateNextBuildNumber

Methods inherited from class hudson.model.AbstractItem

checkPermission, delete, delete, doConfigDotXml, doDoDelete, doSetName, doSubmitDescription, getAbsoluteUrl, getApi, getConfigFile, getDescription, getDescriptorByName, getDisplayName, getDisplayNameOrNull, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getRootDir, getSearchName, getSearchUrl, getShortUrl, getUrl, hasPermission, onCreatedFromScratch, resolveForCLI, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml

Methods inherited from class hudson.model.Actionable

addAction, doContextMenu, getAction, getAction, getActions, 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.Queue.Task

getFullDisplayName, getName, getUrl

Methods inherited from interface hudson.model.ModelObject

getDisplayName

Methods inherited from interface hudson.model.queue.SubTask

getEstimatedDuration

Methods inherited from interface hudson.model.ResourceActivity

getDisplayName

Methods inherited from interface hudson.search.SearchableModelObject

getSearch

Methods inherited from interface hudson.search.SearchItem

getSearchIndex

Constructor Detail

AsyncJob

protected AsyncJob(hudson.model.ItemGroup parent,
        String name)

Method Detail

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<P extends AsyncJob<P,R>,R extends AsyncRun<P,R>>

Throws:

IOException

doBuild

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

Schedules a new build command.

Throws:

IOException

javax.servlet.ServletException

isConcurrentBuild

public boolean isConcurrentBuild()

Most subtypes probably want to support concurrent builds, although some may want to override.

Specified by:

isConcurrentBuild in interface hudson.model.Queue.Task

isBuildable

public boolean isBuildable()

Specified by:

isBuildable in class hudson.model.Job<P extends AsyncJob<P,R>,R extends AsyncRun<P,R>>

isBuildBlocked

public final boolean isBuildBlocked()

Specified by:

isBuildBlocked in interface hudson.model.Queue.Task

getWhyBlocked

public final String getWhyBlocked()

Specified by:

getWhyBlocked in interface hudson.model.Queue.Task

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

getOwnerTask

public hudson.model.Queue.Task getOwnerTask()

This is the master task.

Specified by:

getOwnerTask in interface hudson.model.queue.SubTask

getSameNodeConstraint

public Object getSameNodeConstraint()

No constraint because we don't care where to run.

Specified by:

getSameNodeConstraint in interface hudson.model.queue.SubTask

getAssignedLabel

public hudson.model.Label getAssignedLabel()

Because we are modeling an asynchronous task that runs elsewhere, we don't care where we run.

Specified by:

getAssignedLabel in interface hudson.model.queue.SubTask

getLastBuiltOn

public hudson.model.Node getLastBuiltOn()

Flyweight task doesn't really care where to run.

Specified by:

getLastBuiltOn in interface hudson.model.queue.SubTask

getCauseOfBlockage

public hudson.model.queue.CauseOfBlockage getCauseOfBlockage()

Specified by:

getCauseOfBlockage in interface hudson.model.Queue.Task

getBuildClass

protected Class<R> getBuildClass()

Determines Class<R>.

loadBuild

protected R loadBuild(File dir)
                                     throws IOException

Loads an existing build record from disk.

Throws:

IOException

createExecutable

public R createExecutable()
                                         throws IOException

Specified by:

createExecutable in interface hudson.model.queue.SubTask

Throws:

IOException

_getRuns

protected SortedMap<Integer,R> _getRuns()

Specified by:

_getRuns in class hudson.model.Job<P extends AsyncJob<P,R>,R extends AsyncRun<P,R>>

removeRun

protected void removeRun(R run)

Specified by:

removeRun in class hudson.model.Job<P extends AsyncJob<P,R>,R extends AsyncRun<P,R>>

getResourceList

public hudson.model.ResourceList getResourceList()

Default implementation: no constraint.

Specified by:

getResourceList in interface hudson.model.ResourceActivity