Package org.jenkins.plugin.templateWorkflows

Class TemplatesWorkflowJob

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.AbstractItem

hudson.model.Job<JobT,RunT>

hudson.model.ViewJob<TemplatesWorkflowJob,TemplateswWorkflowRun>

org.jenkins.plugin.templateWorkflows.TemplatesWorkflowJob

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 TemplatesWorkflowJob
extends ViewJob<TemplatesWorkflowJob,TemplateswWorkflowRun>
implements TopLevelItem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TemplatesWorkflowJob.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, ModelObjectWithContextMenu.MenuItemType

Field Summary

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	Description
TemplatesWorkflowJob(ItemGroup itemGroup, String name)

Method Summary

Modifier and Type	Method	Description
net.sf.json.JSONObject	deleteInstance(String instanceName)
net.sf.json.JSONObject	executeWorkflow(String workflowName)
TopLevelItemDescriptor	getDescriptor()
Jenkins	getParent()
String	getProjectDesc()
String	getTemplateInstanceName()
Collection<TemplateWorkflowInstance>	getTemplateInstances()
String	getTemplateName()
Set<String>	getTemplateNames()
net.sf.json.JSONObject	refresh(String templateName)
protected void	reload()
net.sf.json.JSONObject	setTemplateInstanceName(String instanceName)
void	submit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
net.sf.json.JSONObject	validateJobIsNotRunning(String jobName)
net.sf.json.JSONObject	validateJobName(String newJobName, boolean allowUseOfExistingJob)
net.sf.json.JSONObject	validateTemplateName(String instanceNewName)

Methods inherited from class hudson.model.ViewJob

_getRuns, isBuildable, onLoad, removeRun

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, getPronoun, 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, getRelativeDisplayNameFrom, getRelativeNameFromGroup, getRootDir, getSearchName, getSearchUrl, getShortUrl, getTarget, getTaskNoun, getUrl, performDelete, resolveForCLI, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXml, writeConfigDotXml, writeReplace

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.security.AccessControlled

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

Methods inherited from interface hudson.model.DescriptorByNameOwner

getDescriptorByName

Methods inherited from interface hudson.model.Item

delete, getAbsoluteUrl, getAllJobs, getDisplayName, getFullDisplayName, getFullName, getName, 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

Constructor Details

TemplatesWorkflowJob

public TemplatesWorkflowJob(ItemGroup itemGroup,
 String name)

Method Details

getTemplateName

public String getTemplateName()

getTemplateInstanceName

public String getTemplateInstanceName()

getTemplateInstances

public Collection<TemplateWorkflowInstance> getTemplateInstances()

getProjectDesc

public String getProjectDesc()

getTemplateNames

public Set<String> getTemplateNames()

getParent

public Jenkins getParent()

Specified by:

getParent in interface Item

Overrides:

getParent in class AbstractItem

submit

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

Overrides:

submit in class ViewJob<TemplatesWorkflowJob,TemplateswWorkflowRun>

Throws:

IOException

javax.servlet.ServletException

Descriptor.FormException

getDescriptor

public TopLevelItemDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<TopLevelItem>

Specified by:

getDescriptor in interface TopLevelItem

setTemplateInstanceName

@JavaScriptMethod
public net.sf.json.JSONObject setTemplateInstanceName(String instanceName)

executeWorkflow

@JavaScriptMethod
public net.sf.json.JSONObject executeWorkflow(String workflowName)
                                       throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

deleteInstance

@JavaScriptMethod
public net.sf.json.JSONObject deleteInstance(String instanceName)
                                      throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

validateJobName

@JavaScriptMethod
public net.sf.json.JSONObject validateJobName(String newJobName,
 boolean allowUseOfExistingJob)

validateJobIsNotRunning

@JavaScriptMethod
public net.sf.json.JSONObject validateJobIsNotRunning(String jobName)

validateTemplateName

@JavaScriptMethod
public net.sf.json.JSONObject validateTemplateName(String instanceNewName)

refresh

@JavaScriptMethod
public net.sf.json.JSONObject refresh(String templateName)

reload

protected void reload()

Specified by:

reload in class ViewJob<TemplatesWorkflowJob,TemplateswWorkflowRun>