org.jenkinsci.plugins.rundeck
Class RundeckNotifier

java.lang.Object
  hudson.tasks.BuildStepCompatibilityLayer
      hudson.tasks.Publisher
          hudson.tasks.Notifier
              org.jenkinsci.plugins.rundeck.RundeckNotifier

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep

public class RundeckNotifier
extends hudson.tasks.Notifier

Jenkins Notifier that schedule a job execution on RunDeck (via the RundeckInstance)

Author:

Vincent Behar

Nested Class Summary

static class	RundeckNotifier.RundeckDescriptor
static class	RundeckNotifier.RundeckExecutionBuildBadgeAction BuildBadgeAction used to display a RunDeck icon + a link to the RunDeck execution page, on the Jenkins build history and build result page.

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

RundeckNotifier(java.lang.String groupPath, java.lang.String jobName, java.lang.String[] options, java.lang.String tag, java.lang.Boolean shouldFailTheBuild)

Method Summary

RundeckNotifier.RundeckDescriptor	getDescriptor()
java.lang.String	getGroupPath()
java.lang.String	getJobName()
java.lang.String	getOptions()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
java.lang.Boolean	getShouldFailTheBuild()
java.lang.String	getTag()
boolean	needsToRunAfterFinalized() If we should not fail the build, we need to run after finalized, so that the result of "perform" is not used by Jenkins
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, prebuild

Constructor Detail

RundeckNotifier

@DataBoundConstructor
public RundeckNotifier(java.lang.String groupPath,
                                            java.lang.String jobName,
                                            java.lang.String[] options,
                                            java.lang.String tag,
                                            java.lang.Boolean shouldFailTheBuild)

Method Detail

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws java.lang.InterruptedException,
                       java.io.IOException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

java.lang.InterruptedException

java.io.IOException

needsToRunAfterFinalized

public boolean needsToRunAfterFinalized()

If we should not fail the build, we need to run after finalized, so that the result of "perform" is not used by Jenkins

Overrides:

needsToRunAfterFinalized in class hudson.tasks.Publisher

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

getGroupPath

public java.lang.String getGroupPath()

getJobName

public java.lang.String getJobName()

getOptions

public java.lang.String getOptions()

Returns:

a multi-lines string representation, for use in the view (jelly textarea)

getTag

public java.lang.String getTag()

getShouldFailTheBuild

public java.lang.Boolean getShouldFailTheBuild()

getDescriptor

public RundeckNotifier.RundeckDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>

Overrides:

getDescriptor in class hudson.tasks.Notifier