Class ExternalJob

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.AbstractItem

hudson.model.Job<ExternalJob, ExternalRun>

hudson.model.ViewJob<ExternalJob, ExternalRun>

hudson.model.ExternalJob

All Implemented Interfaces:

ExtensionPoint, Describable<TopLevelItem>, DescriptorByNameOwner, Item, ModelObject, PersistenceRoot, Saveable, TopLevelItem, SearchableModelObject, SearchItem, AccessControlled, Loadable, ModelObjectWithChildren, ModelObjectWithContextMenu, OnMaster, HasWidgets, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerOverridable, org.kohsuke.stapler.StaplerProxy

public class ExternalJob
extends ViewJob<ExternalJob, ExternalRun>
implements TopLevelItem

Job that runs outside Hudson whose result is submitted to Hudson (either via web interface, or simply by placing files on the file system, for compatibility.)

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ExternalJob.DescriptorImpl

Nested classes/interfaces inherited from class Job

Job.LastItemListener, Job.SubItemBuildsLocationImpl

Nested classes/interfaces inherited from interface ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

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

org.kohsuke.stapler.HttpDeletable.HttpDeletableDispatcher

Nested classes/interfaces inherited from interface ModelObjectWithContextMenu

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

Field Summary

Fields

Modifier and Type	Field	Description
static final TopLevelItemDescriptor	DESCRIPTOR

Fields inherited from class ViewJob

reloadPeriodically, runs

Fields inherited from class Job

HISTORY_ADAPTER, nextBuildNumber, properties, runIdMigrator

Fields inherited from class AbstractItem

description, displayName, name, PRONOUN, SKIP_PERMISSION_CHECK, TASK_NOUN

Fields inherited from interface Item

BUILD, CANCEL, CONFIGURE, CREATE, DELETE, DISCOVER, EXTENDED_READ, PERMISSIONS, READ, WIPEOUT, WORKSPACE

Fields inherited from interface Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
ExternalJob(ItemGroup parent, String name)
ExternalJob(String name)

Method Summary

Modifier and Type	Method	Description
void	doAcceptBuildResult(org.kohsuke.stapler.StaplerResponse2 rsp)	Used to check if this is an external job and ready to accept a build result.
void	doPostBuildResult(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Used to post the build result from a remote machine.
TopLevelItemDescriptor	getDescriptor()
String	getPronoun()
ExternalRun	newBuild()	Creates a new build of this project for immediate execution.
protected void	reload()

Methods inherited from class ViewJob

_getRuns, isBuildable, onLoad, removeRun, submit, submit

Methods inherited from class Job

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

Methods inherited from class 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, performDelete, resolveForCLI, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXml, writeConfigDotXml, writeReplace

Methods inherited from class Actionable

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

Methods inherited from class AbstractModelObject

getSearch, getSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendError

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface AccessControlled

checkAnyPermission, checkPermission, getACL, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface DescriptorByNameOwner

getDescriptorByName

Methods inherited from interface HasWidgets

getWidget, getWidgets

Methods inherited from interface Item

delete, getAbsoluteUrl, getAllJobs, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl, onCopiedFrom, onCreatedFromScratch, onLoad, save

Methods inherited from interface PersistenceRoot

getRootDir

Methods inherited from interface SearchableModelObject

getSearch

Methods inherited from interface SearchItem

getSearchIndex, getSearchName, getSearchUrl

Field Details

DESCRIPTOR

@Extension
public static final TopLevelItemDescriptor DESCRIPTOR

Constructor Details

ExternalJob

public ExternalJob(String name)

ExternalJob

public ExternalJob(ItemGroup parent,
 String name)

Method Details

reload

protected void reload()

Specified by:

reload in class ViewJob<ExternalJob, ExternalRun>

newBuild

public ExternalRun newBuild()
                     throws IOException

Creates a new build of this project for immediate execution. Needs to be synchronized so that two newBuild() invocations serialize each other.

Returns:

ExternalRun a reference to the new build

Throws:

IOException

doAcceptBuildResult

public void doAcceptBuildResult(org.kohsuke.stapler.StaplerResponse2 rsp)
                         throws IOException,
jakarta.servlet.ServletException

Used to check if this is an external job and ready to accept a build result.

Throws:

IOException

jakarta.servlet.ServletException

doPostBuildResult

@POST
public void doPostBuildResult(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                       throws IOException,
jakarta.servlet.ServletException

Used to post the build result from a remote machine.

Parameters:

req - Remote request

rsp - Remote response

Throws:

IOException

jakarta.servlet.ServletException

getDescriptor

public TopLevelItemDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<TopLevelItem>

Specified by:

getDescriptor in interface TopLevelItem

getPronoun

public String getPronoun()

Overrides:

getPronoun in class Job<ExternalJob, ExternalRun>