org.jenkinsci.plugins.rundeck

Class RundeckNotifier.RundeckDescriptor

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

org.jenkinsci.plugins.rundeck.RundeckNotifier.RundeckDescriptor

All Implemented Interfaces:

hudson.model.Saveable

Enclosing class:

RundeckNotifier

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

Nested Class Summary

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

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.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, org.rundeck.api.RundeckClient instance)
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
hudson.util.FormValidation	doCheckJobIdentifier(String jobIdentifier, String rundeckInstance, String user, String password, String token) check valid job
hudson.util.FormValidation	doDisplayCacheStatistics()
hudson.util.FormValidation	doInvalidateCache()
hudson.util.FormValidation	doTestConnection(String url, String login, String password, String token, Integer apiversion)
static org.rundeck.api.domain.RundeckJob	findJob(String jobIdentifier, String rundeckInstanceName, org.rundeck.api.RundeckClient rundeckInstance) Find a RundeckJob with the given identifier using internal cache if possible.
static org.rundeck.api.domain.RundeckJob	findJobUncached(String jobIdentifier, org.rundeck.api.RundeckClient rundeckInstance)
String	getApiVersion(org.rundeck.api.RundeckClient instance)
String	getDisplayName()
org.rundeck.api.RundeckClient	getRundeckInstance(String key)
Map<String,org.rundeck.api.RundeckClient>	getRundeckInstances()
RundeckJobCacheConfig	getRundeckJobCacheConfig()
org.rundeck.api.RundeckClient	getRundeckJobInstance(String rundeckInstanceName, String jobUser, String jobPassword, String jobToken) get RundeckClient if optional user is given
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> jobType)
void	load()
hudson.tasks.Publisher	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
protected Object	readResolve()
void	setRundeckInstances(Map<String,org.rundeck.api.RundeckClient> 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, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, 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 hudson.model.Descriptor<hudson.tasks.Publisher>

readResolve

protected Object readResolve()

configure

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

Overrides:

configure in class hudson.model.Descriptor<hudson.tasks.Publisher>

Throws:

hudson.model.Descriptor.FormException

newInstance

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

Overrides:

newInstance in class hudson.model.Descriptor<hudson.tasks.Publisher>

Throws:

hudson.model.Descriptor.FormException

doDisplayCacheStatistics

public hudson.util.FormValidation doDisplayCacheStatistics()

doInvalidateCache

public hudson.util.FormValidation doInvalidateCache()

doTestConnection

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

doCheckJobIdentifier

public hudson.util.FormValidation doCheckJobIdentifier(@QueryParameter(value="jobIdentifier")
                                                       String jobIdentifier,
                                                       @QueryParameter(value="rundeckInstance")
                                                       String rundeckInstance,
                                                       @QueryParameter(value="jobUser")
                                                       String user,
                                                       @QueryParameter(value="jobPassword")
                                                       String password,
                                                       @QueryParameter(value="jobToken")
                                                       String token)

check valid job

Parameters:

jobIdentifier -

rundeckInstance -

user -

password -

token -

Returns:

findJob

public static org.rundeck.api.domain.RundeckJob findJob(String jobIdentifier,
                                                        String rundeckInstanceName,
                                                        org.rundeck.api.RundeckClient rundeckInstance)
                                                 throws org.rundeck.api.RundeckApiException,
                                                        IllegalArgumentException

Find a RundeckJob 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 RundeckJob found, or null if not found

Throws:

org.rundeck.api.RundeckApiException - in case of error, or if no job with this ID

IllegalArgumentException - if the identifier is not valid

findJobUncached

public static org.rundeck.api.domain.RundeckJob findJobUncached(String jobIdentifier,
                                                                org.rundeck.api.RundeckClient rundeckInstance)
                                                         throws org.rundeck.api.RundeckApiException,
                                                                IllegalArgumentException

Throws:

org.rundeck.api.RundeckApiException

IllegalArgumentException

isApplicable

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

Specified by:

isApplicable in class hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in class hudson.model.Descriptor<hudson.tasks.Publisher>

getApiVersion

public String getApiVersion(org.rundeck.api.RundeckClient instance)

getRundeckInstance

public org.rundeck.api.RundeckClient getRundeckInstance(String key)

getRundeckJobInstance

public org.rundeck.api.RundeckClient 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,
                               org.rundeck.api.RundeckClient instance)

getRundeckInstances

public Map<String,org.rundeck.api.RundeckClient> getRundeckInstances()

setRundeckInstances

public void setRundeckInstances(Map<String,org.rundeck.api.RundeckClient> instances)

getRundeckJobCacheConfig

public RundeckJobCacheConfig getRundeckJobCacheConfig()