hudson.model

Class ExternalJob

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.AbstractItem

hudson.model.Job<JobT,RunT>

hudson.model.ViewJob<ExternalJob,ExternalRun>

hudson.model.ExternalJob

All Implemented Interfaces:

ExtensionPoint, Describable<TopLevelItem>, DescriptorByNameOwner, Item, ModelObject, PersistenceRoot, Saveable, TopLevelItem, SearchableModelObject, SearchItem, AccessControlled, ModelObjectWithChildren, ModelObjectWithContextMenu, OnMaster, 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 and Description
static class	ExternalJob.DescriptorImpl

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 jenkins.model.ModelObjectWithContextMenu

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem

Field Summary

Fields

Modifier and Type	Field and Description
static TopLevelItemDescriptor	DESCRIPTOR

Fields inherited from class hudson.model.ViewJob

reloadPeriodically, runs

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
ExternalJob(ItemGroup parent, String name)
ExternalJob(String name)

Method Summary

Modifier and Type	Method and Description
void	doAcceptBuildResult(org.kohsuke.stapler.StaplerResponse rsp) Used to check if this is an external job and ready to accept a build result.
void	doPostBuildResult(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse 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 hudson.model.ViewJob

_getRuns, isBuildable, onLoad, removeRun, submit

Methods inherited from class hudson.model.Job

addProperty, assignBuildNumber, checkRename, createHistoryWidget, delete, doBuildStatus, doChildrenContextMenu, doConfigSubmit, doDescription, doDoRename, doRssAll, doRssChangelog, doRssFailed, getACL, getAllJobs, getAllProperties, getBuild, getBuildByNumber, getBuildDir, getBuildDiscarder, getBuildForCLI, getBuildHealth, getBuildHealthReports, getBuilds, getBuilds, getBuildsAsMap, getBuildsByTimestamp, getBuildStatusIconClassName, getBuildStatusUrl, getBuildTimeGraph, getCharacteristicEnvVars, 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, getWidgets, isBuilding, isHoldOffBuildUntilSave, isInQueue, isKeepDependencies, isLogUpdated, isNameEditable, logRotate, makeSearchIndex, movedTo, onCopiedFrom, onCreatedFromScratch, removeProperty, 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, performDelete, resolveForCLI, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXml, writeConfigDotXml

Methods inherited from class hudson.model.Actionable

addAction, addOrReplaceAction, doContextMenu, getAction, getAction, getActions, getActions, getAllActions, removeAction, removeActions, replaceAction, 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 hudson.model.Item

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

Methods inherited from interface hudson.model.DescriptorByNameOwner

getDescriptorByName

Field Detail

DESCRIPTOR

@Extension
public static final TopLevelItemDescriptor DESCRIPTOR

Constructor Detail

ExternalJob

public ExternalJob(String name)

ExternalJob

public ExternalJob(ItemGroup parent,
                   String name)

Method Detail

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.StaplerResponse rsp)
                         throws IOException,
                                javax.servlet.ServletException

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

Throws:

IOException

javax.servlet.ServletException

doPostBuildResult

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

Used to post the build result from a remote machine.

Parameters:

req - Remote request

rsp - Remote response

Throws:

IOException

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