Package jenkins.plugins.mqttnotification

Class MqttNotifier

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

jenkins.plugins.mqttnotification.MqttNotifier

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class MqttNotifier
extends Notifier
implements SimpleBuildStep

A simple build result notifier that publishes the result via MQTT.

Author:

Gareth Western

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MqttNotifier.DescriptorImpl

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

Publisher.DescriptorExtensionListImpl

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

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

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
MqttNotifier(String brokerUrl, String topic, String message, String qos, boolean retainMessage, String credentialsId)

Method Summary

Modifier and Type	Method	Description
String	getBrokerUrl()
String	getCredentialsId()
String	getEffectiveStartMessage()
String	getEffectiveStartTopic()
String	getMessage()
String	getQos()
BuildStepMonitor	getRequiredMonitorService()
String	getStartMessage()
String	getStartTopic()
String	getTopic()
boolean	isNotifyOnComplete()
boolean	isNotifyOnStart()
boolean	isRetainMessage()
boolean	needsToRunAfterFinalized()
void	perform(Run<?,?> run, FilePath workspace, Launcher launcher, TaskListener listener)
void	sendNotification(String rawTopic, String rawMessage, Run<?,?> run, TaskListener listener)
void	setBrokerUrl(String brokerUrl)
void	setCredentialsId(String credentialsId)
void	setMessage(String message)
void	setNotifyOnComplete(boolean notifyOnComplete)
void	setNotifyOnStart(boolean notifyOnStart)
void	setQos(String qos)
void	setRetainMessage(boolean retainMessage)
void	setStartMessage(String startMessage)
void	setStartTopic(String startTopic)
void	setTopic(String topic)

Methods inherited from class hudson.tasks.Notifier

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, 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

getProjectAction, getProjectActions, perform, prebuild

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Constructor Details

MqttNotifier

@DataBoundConstructor
public MqttNotifier(String brokerUrl,
 String topic,
 String message,
 String qos,
 boolean retainMessage,
 String credentialsId)

Method Details

getCredentialsId

public String getCredentialsId()

setCredentialsId

@DataBoundSetter
public void setCredentialsId(String credentialsId)

getBrokerUrl

public String getBrokerUrl()

setBrokerUrl

@DataBoundSetter
public void setBrokerUrl(String brokerUrl)

getTopic

public String getTopic()

setTopic

@DataBoundSetter
public void setTopic(String topic)

getMessage

public String getMessage()

setMessage

@DataBoundSetter
public void setMessage(String message)

isNotifyOnStart

public boolean isNotifyOnStart()

setNotifyOnStart

@DataBoundSetter
public void setNotifyOnStart(boolean notifyOnStart)

isNotifyOnComplete

public boolean isNotifyOnComplete()

setNotifyOnComplete

@DataBoundSetter
public void setNotifyOnComplete(boolean notifyOnComplete)

getStartTopic

public String getStartTopic()

setStartTopic

@DataBoundSetter
public void setStartTopic(String startTopic)

getEffectiveStartTopic

public String getEffectiveStartTopic()

getStartMessage

public String getStartMessage()

setStartMessage

@DataBoundSetter
public void setStartMessage(String startMessage)

getEffectiveStartMessage

public String getEffectiveStartMessage()

getQos

public String getQos()

setQos

@DataBoundSetter
public void setQos(String qos)

isRetainMessage

public boolean isRetainMessage()

setRetainMessage

@DataBoundSetter
public void setRetainMessage(boolean retainMessage)

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep

needsToRunAfterFinalized

public boolean needsToRunAfterFinalized()

Overrides:

needsToRunAfterFinalized in class Publisher

sendNotification

public void sendNotification(String rawTopic,
 String rawMessage,
 Run<?,?> run,
 TaskListener listener)

perform

public void perform(Run<?,?> run,
 FilePath workspace,
 Launcher launcher,
 TaskListener listener)
             throws InterruptedException,
IOException

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException