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:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class RundeckNotifier
extends Notifier
implements SimpleBuildStep

Jenkins Notifier that runs a job on Rundeck (via the RundeckClientManager)

Author:

Vincent Behar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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

Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
RundeckNotifier(String rundeckInstance, String jobId, String options, String nodeFilters, String tags, Boolean shouldWaitForRundeckJob, Boolean shouldFailTheBuild, Boolean notifyOnAllStatus, Boolean includeRundeckLogs, Boolean tailLog, String jobUser, Secret jobPassword, Secret jobToken)

Method Summary

Modifier and Type	Method and Description
RundeckNotifier.RundeckDescriptor	getDescriptor()
Boolean	getIncludeRundeckLogs()
String	getJobId()
String	getJobIdentifier()
Secret	getJobPassword()
Secret	getJobToken()
String	getJobUser() optional non default rundeck user for actual job
String	getNodeFilters()
Boolean	getNotifyOnAllStatus()
String	getOptions()
String	getPassword()
Action	getProjectAction(AbstractProject<?,?> project)
BuildStepMonitor	getRequiredMonitorService()
String	getRundeckInstance()
Boolean	getShouldFailTheBuild()
Boolean	getShouldWaitForRundeckJob()
String	getTag()
String	getTags()
String[]	getTagsList()
Boolean	getTailLog()
String	getToken()
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
void	perform(Run<?,?> run, FilePath filePath, Launcher launcher, TaskListener listener)
Object	readResolve()

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectActions, perform, 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

getProjectActions, perform, prebuild

Constructor Detail

RundeckNotifier

@DataBoundConstructor
public RundeckNotifier(String rundeckInstance,
                                             String jobId,
                                             String options,
                                             String nodeFilters,
                                             String tags,
                                             Boolean shouldWaitForRundeckJob,
                                             Boolean shouldFailTheBuild,
                                             Boolean notifyOnAllStatus,
                                             Boolean includeRundeckLogs,
                                             Boolean tailLog,
                                             String jobUser,
                                             Secret jobPassword,
                                             Secret jobToken)

Method Detail

readResolve

public Object readResolve()

perform

public void perform(@Nonnull
                    Run<?,?> run,
                    @Nonnull
                    FilePath filePath,
                    @Nonnull
                    Launcher launcher,
                    @Nonnull
                    TaskListener listener)
             throws IOException

Specified by:

perform in interface SimpleBuildStep

Throws:

IOException

getProjectAction

public Action getProjectAction(AbstractProject<?,?> project)

Specified by:

getProjectAction in interface BuildStep

Overrides:

getProjectAction in class BuildStepCompatibilityLayer

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 Publisher

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep

getRundeckInstance

public String getRundeckInstance()

getJobIdentifier

public String getJobIdentifier()

getJobId

public String getJobId()

getOptions

public String getOptions()

getNodeFilters

public String getNodeFilters()

getTag

public String getTag()

getTags

public String getTags()

getTagsList

public String[] getTagsList()

getShouldWaitForRundeckJob

public Boolean getShouldWaitForRundeckJob()

getShouldFailTheBuild

public Boolean getShouldFailTheBuild()

getNotifyOnAllStatus

public Boolean getNotifyOnAllStatus()

getIncludeRundeckLogs

public Boolean getIncludeRundeckLogs()

getTailLog

public Boolean getTailLog()

getJobUser

public String getJobUser()

optional non default rundeck user for actual job

getJobPassword

public Secret getJobPassword()

getJobToken

public Secret getJobToken()

getPassword

public String getPassword()

getToken

public String getToken()

getDescriptor

public RundeckNotifier.RundeckDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<Publisher>

Overrides:

getDescriptor in class Notifier