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

public class MqttNotifier
extends hudson.tasks.Notifier

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

Constructors

Constructor and Description
MqttNotifier(String brokerUrl, String topic, String message, String qos, boolean retainMessage, com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials credentials)
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()
int	getQos()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
String	getTopic()
boolean	isRetainMessage()
static com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials	lookupSystemCredentials(String credentialsId)
boolean	needsToRunAfterFinalized()
boolean	perform(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MqttNotifier

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

MqttNotifier

public MqttNotifier(String brokerUrl,
                    String topic,
                    String message,
                    String qos,
                    boolean retainMessage,
                    com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials credentials)

Method Detail

getCredentialsId

public String getCredentialsId()

getBrokerUrl

public String getBrokerUrl()

getTopic

public String getTopic()

getMessage

public String getMessage()

getQos

public int getQos()

isRetainMessage

public boolean isRetainMessage()

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

needsToRunAfterFinalized

public boolean needsToRunAfterFinalized()

Overrides:

needsToRunAfterFinalized in class hudson.tasks.Publisher

lookupSystemCredentials

public static com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials lookupSystemCredentials(String credentialsId)

perform

public boolean perform(hudson.model.AbstractBuild build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer