org.jenkinsci.plugins.asyncjob

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

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.Run<P,R>

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

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.DescriptorByNameOwner, hudson.model.ModelObject, hudson.model.PersistenceRoot, hudson.model.Queue.Executable, hudson.model.Saveable, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, Comparable<R>, Runnable, jenkins.model.ModelObjectWithContextMenu

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

Author:

Kohsuke Kawaguchi

Nested Class Summary

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

hudson.model.Run.Artifact, hudson.model.Run.ArtifactList, hudson.model.Run.KeepLogBuildBadge, hudson.model.Run.RedirectUp, hudson.model.Run.Runner, hudson.model.Run.RunnerAbortedException, hudson.model.Run.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.Run

ARTIFACTS, charset, DELETE, description, duration, FEED_ADAPTER, FEED_ADAPTER_LATEST, ID_FORMATTER, LIST_CUTOFF, nextBuild, number, ORDER_BY_DATE, PERMISSIONS, previousBuild, project, result, state, timestamp, TREE_CUTOFF, UPDATE, XSTREAM, XSTREAM2

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AsyncRun(P job)
protected	AsyncRun(P job, Calendar timestamp)
protected	AsyncRun(P project, File buildDir)
protected	AsyncRun(P job, long timestamp)

Method Summary

Methods

Modifier and Type	Method and Description
hudson.model.TaskListener	createListener() For writing stuff from asynchronous tasks.
abstract void	doStop(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Aborts the build if it's indeed in progress.
hudson.model.BallColor	getIconColor()
boolean	isAsyncCompleted() Indicates if the actual asynchronous portion of the work has been completed (by invoking markCompleted(Result).
boolean	isBuilding()
void	markCompleted(hudson.model.Result result) Marks the asynchronous task complete.

Methods inherited from class hudson.model.Run

addAction, checkPermission, compareTo, delete, deleteArtifacts, doArtifact, doBuildNumber, doBuildStatus, doBuildTimestamp, doConfigSubmit, doConsoleText, doDoDelete, doProgressiveLog, doSubmitDescription, doToggleLogKeep, fromExternalizableId, getAbsoluteUrl, getACL, getApi, getArtifacts, getArtifactsDir, getArtifactsUpTo, getBadgeActions, getBuildStatusSummary, getBuildStatusUrl, getCause, getCauses, getCharacteristicEnvVars, getCharset, getDescription, getDescriptorByName, getDisplayName, getDuration, getDurationString, getDynamic, getEnvironment, getEnvironment, getEnvVars, getEstimatedDuration, getExecutor, getExternalizableId, getFullDisplayName, getHasArtifacts, getId, getIDFormatter, getLog, getLog, getLogFile, getLogInputStream, getLogReader, getLogText, getNextBuild, getNumber, getOneOffExecutor, getParent, getPreviousBuild, getPreviousBuildInProgress, getPreviousBuildsOverThreshold, getPreviousBuiltBuild, getPreviousCompletedBuild, getPreviousFailedBuild, getPreviousNotFailedBuild, getPreviousSuccessfulBuild, getResult, getRootDir, getSearchUrl, getTime, getTimeInMillis, getTimestamp, getTimestampString, getTimestampString2, getTransientActions, getTruncatedDescription, getUrl, getWhyKeepLog, hasCustomDisplayName, hasntStartedYet, hasPermission, isKeepLog, isLogUpdated, keepLog, keepLog, makeSearchIndex, onEndBuilding, onLoad, onStartBuilding, reload, run, save, setDescription, setDisplayName, setResult, submit, toString, writeLogTo

Methods inherited from class hudson.model.Actionable

doContextMenu, getAction, getAction, getActions, getActions

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, 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.Executable

getEstimatedDuration, getParent, run, toString

Constructor Detail

AsyncRun

protected AsyncRun(P job)
            throws IOException

Throws:

IOException

AsyncRun

protected AsyncRun(P job,
        Calendar timestamp)

AsyncRun

protected AsyncRun(P job,
        long timestamp)

AsyncRun

protected AsyncRun(P project,
        File buildDir)
            throws IOException

Throws:

IOException

Method Detail

markCompleted

public void markCompleted(hudson.model.Result result)
                   throws IOException

Marks the asynchronous task complete.

Throws:

IOException

isBuilding

public boolean isBuilding()

Overrides:

isBuilding in class hudson.model.Run<P extends AsyncJob<P,R>,R extends AsyncRun<P,R>>

isAsyncCompleted

public boolean isAsyncCompleted()

Indicates if the actual asynchronous portion of the work has been completed (by invoking markCompleted(Result).

getIconColor

public hudson.model.BallColor getIconColor()

Overrides:

getIconColor in class hudson.model.Run<P extends AsyncJob<P,R>,R extends AsyncRun<P,R>>

createListener

public hudson.model.TaskListener createListener()
                                         throws IOException

For writing stuff from asynchronous tasks.

Throws:

IOException

doStop

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

Aborts the build if it's indeed in progress.

Throws:

IOException

javax.servlet.ServletException