jenkins.plugins.mqttnotification

Class MqttNotifier

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

jenkins.plugins.mqttnotification.MqttNotifier

All Implemented Interfaces:

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

public class MqttNotifier
extends hudson.tasks.Notifier
implements jenkins.tasks.SimpleBuildStep

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

Author:

Gareth Western

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MqttNotifier.DescriptorImpl

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

hudson.tasks.Publisher.DescriptorExtensionListImpl

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

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

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

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getBrokerUrl()
String	getCredentialsId()
String	getMessage()
String	getQos()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
String	getTopic()
boolean	isRetainMessage()
boolean	needsToRunAfterFinalized()
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setBrokerUrl(String brokerUrl)
void	setCredentialsId(String credentialsId)
void	setMessage(String message)
void	setQos(String qos)
void	setRetainMessage(boolean retainMessage)
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

Constructor Detail

MqttNotifier

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

Method Detail

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)

getQos

public String getQos()

setQos

@DataBoundSetter
public void setQos(String qos)

isRetainMessage

public boolean isRetainMessage()

setRetainMessage

@DataBoundSetter
public void setRetainMessage(boolean retainMessage)

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

needsToRunAfterFinalized

public boolean needsToRunAfterFinalized()

Overrides:

needsToRunAfterFinalized in class hudson.tasks.Publisher

perform

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

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

InterruptedException

IOException