org.jenkinsci.plugins.rundeck

Class RundeckNotifier.RundeckDescriptor

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<Publisher>

org.jenkinsci.plugins.rundeck.RundeckNotifier.RundeckDescriptor

All Implemented Interfaces:

Saveable, OnMaster

Enclosing class:

RundeckNotifier

@Extension(ordinal=1000.0)
public static final class RundeckNotifier.RundeckDescriptor
extends BuildStepDescriptor<Publisher>

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
RundeckDescriptor()

Method Summary

Modifier and Type	Method and Description
void	addRundeckInstance(String key, RundeckInstance instance)
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
FormValidation	doCheckJobIdentifier(String jobIdentifier, String rundeckInstance, String user, Secret password, Secret token, Item item) check valid job
FormValidation	doDisplayCacheStatistics()
FormValidation	doInvalidateCache()
FormValidation	doTestConnection(String url, String login, Secret password, Secret token, Integer apiversion)
static org.rundeck.client.api.model.JobItem	findJob(String jobIdentifier, String rundeckInstanceName, RundeckManager rundeckInstance) Find a JobItem with the given identifier using internal cache if possible.
static org.rundeck.client.api.model.JobItem	findJobUncached(String jobIdentifier, RundeckManager rundeckClient)
protected XmlFile	getConfigFile()
String	getDisplayName()
RundeckInstanceBuilder	getRundeckBuilder()
RundeckInstance	getRundeckInstance(String key)
Map<String,RundeckInstance>	getRundeckInstances()
RundeckJobCacheConfig	getRundeckJobCacheConfig()
RundeckManager	getRundeckJobInstance(String rundeckInstanceName, String jobUser, String jobPassword, String jobToken) get RundeckClient if optional user is given
boolean	isApplicable(Class<? extends AbstractProject> jobType)
void	load()
Publisher	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
protected Object	readResolve()
void	setRundeckBuilder(RundeckInstanceBuilder rundeckBuilder)
void	setRundeckInstances(Map<String,RundeckInstance> instances)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

RundeckDescriptor

public RundeckDescriptor()

Method Detail

load

public void load()

Overrides:

load in class Descriptor<Publisher>

getRundeckBuilder

public RundeckInstanceBuilder getRundeckBuilder()

setRundeckBuilder

public void setRundeckBuilder(RundeckInstanceBuilder rundeckBuilder)

readResolve

protected Object readResolve()

getConfigFile

protected XmlFile getConfigFile()

Overrides:

getConfigFile in class Descriptor<Publisher>

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject json)
                  throws Descriptor.FormException

Overrides:

configure in class Descriptor<Publisher>

Throws:

Descriptor.FormException

newInstance

public Publisher newInstance(org.kohsuke.stapler.StaplerRequest req,
                             net.sf.json.JSONObject formData)
                      throws Descriptor.FormException

Overrides:

newInstance in class Descriptor<Publisher>

Throws:

Descriptor.FormException

doDisplayCacheStatistics

public FormValidation doDisplayCacheStatistics()

doInvalidateCache

public FormValidation doInvalidateCache()

doTestConnection

public FormValidation doTestConnection(@QueryParameter(value="rundeck.url")
                                       String url,
                                       @QueryParameter(value="rundeck.login")
                                       String login,
                                       @QueryParameter(value="rundeck.password")
                                       Secret password,
                                       @QueryParameter(value="rundeck.authtoken")
                                       Secret token,
                                       @QueryParameter(value="rundeck.apiversion",fixEmpty=true)
                                       Integer apiversion)

doCheckJobIdentifier

public FormValidation doCheckJobIdentifier(@QueryParameter(value="jobIdentifier")
                                           String jobIdentifier,
                                           @QueryParameter(value="rundeckInstance")
                                           String rundeckInstance,
                                           @QueryParameter(value="jobUser")
                                           String user,
                                           @QueryParameter(value="jobPassword")
                                           Secret password,
                                           @QueryParameter(value="jobToken")
                                           Secret token,
                                           @AncestorInPath
                                           Item item)

check valid job

findJob

public static org.rundeck.client.api.model.JobItem findJob(String jobIdentifier,
                                                           String rundeckInstanceName,
                                                           RundeckManager rundeckInstance)

Find a JobItem with the given identifier using internal cache if possible.

Parameters:

jobIdentifier - either a simple ID, an UUID or a reference (project:group/name)

rundeckInstanceName - Rundeck instance name

rundeckInstance - Rundeck client instance

Returns:

the JobItem found, or null if not found

Throws:

Exception - in case of error, or if no job with this ID

findJobUncached

public static org.rundeck.client.api.model.JobItem findJobUncached(String jobIdentifier,
                                                                   RundeckManager rundeckClient)

isApplicable

public boolean isApplicable(Class<? extends AbstractProject> jobType)

Specified by:

isApplicable in class BuildStepDescriptor<Publisher>

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<Publisher>

getRundeckInstance

public RundeckInstance getRundeckInstance(String key)

getRundeckJobInstance

public RundeckManager getRundeckJobInstance(String rundeckInstanceName,
                                            String jobUser,
                                            String jobPassword,
                                            String jobToken)

get RundeckClient if optional user is given

Parameters:

rundeckInstanceName -

jobUser -

jobPassword -

jobToken -

Returns:

addRundeckInstance

public void addRundeckInstance(String key,
                               RundeckInstance instance)

getRundeckInstances

public Map<String,RundeckInstance> getRundeckInstances()

setRundeckInstances

public void setRundeckInstances(Map<String,RundeckInstance> instances)

getRundeckJobCacheConfig

public RundeckJobCacheConfig getRundeckJobCacheConfig()