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

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

RundeckNotifier.RundeckDescriptor()

Method Summary

boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
hudson.util.FormValidation	doCheckJobIdentifier(String jobIdentifier)
hudson.util.FormValidation	doTestConnection(String url, String login, String password, String token, Integer apiversion)
static org.rundeck.api.domain.RundeckJob	findJob(String jobIdentifier, org.rundeck.api.RundeckClient rundeckInstance) Find a RundeckJob with the given identifier
String	getDisplayName()
org.rundeck.api.RundeckClient	getRundeckInstance()
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> jobType)
hudson.tasks.Publisher	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
void	setRundeckInstance(org.rundeck.api.RundeckClient rundeckInstance)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, getCheckUrl, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getPropertyType, getPropertyType, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

RundeckNotifier.RundeckDescriptor

public RundeckNotifier.RundeckDescriptor()

Method Detail

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

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)

findJob

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

Find a RundeckJob with the given identifier

Parameters:

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

rundeckInstance -

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

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>

getRundeckInstance

public org.rundeck.api.RundeckClient getRundeckInstance()

setRundeckInstance

public void setRundeckInstance(org.rundeck.api.RundeckClient rundeckInstance)