net.randomsync.robotframework.mqtt

Class MQTTLibrary

java.lang.Object

org.robotframework.javalib.library.KeywordFactoryBasedLibrary<org.robotframework.javalib.keyword.DocumentedKeyword>

org.robotframework.javalib.library.AnnotationLibrary

net.randomsync.robotframework.mqtt.MQTTLibrary

All Implemented Interfaces:

org.robotframework.javalib.library.KeywordDocumentationRepository, org.robotframework.javalib.library.RobotJavaLibrary

Direct Known Subclasses:

MQTTLibrary

public class MQTTLibrary
extends org.robotframework.javalib.library.AnnotationLibrary

A keyword library for Robot Framework. It provides keywords for performing various operations on an MQTT broker. See MQTT for more details on MQTT specification.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEYWORD_PATTERN
static String	ROBOT_LIBRARY_DOC_FORMAT
static String	ROBOT_LIBRARY_SCOPE
static String	ROBOT_LIBRARY_VERSION

Fields inherited from class org.robotframework.javalib.library.AnnotationLibrary

beanLoaders, classFilter

Constructor Summary

Constructors

Constructor and Description
MQTTLibrary()

Method Summary

Modifier and Type	Method and Description
void	connectToMQTTBroker(String broker, String clientId) Connect to an MQTT broker.
void	disconnectFromMQTTBroker() Disconnect from MQTT Broker
String	getKeywordDocumentation(String keywordName)
void	publishToMQTTSynchronously(String topic, Object message) Publish a message to a topic
void	publishToMQTTSynchronously(String topic, Object message, int qos, boolean retained) Publish a message to a topic with specified qos and retained flag
void	subscribeToMQTTAndValidate(String broker, String clientId, String topic, String expectedPayload, long timeout) Subscribe to an MQTT broker and validate that a message with specified payload is received

Methods inherited from class org.robotframework.javalib.library.AnnotationLibrary

addKeywordPattern, autowireFields, createKeywordFactory, getKeywordArguments, runKeyword

Methods inherited from class org.robotframework.javalib.library.KeywordFactoryBasedLibrary

getClassLoader, getKeywordNames, setClassLoader

Methods inherited from class java.lang.Object

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

Field Detail

KEYWORD_PATTERN

public static final String KEYWORD_PATTERN

See Also:

Constant Field Values

ROBOT_LIBRARY_SCOPE

public static final String ROBOT_LIBRARY_SCOPE

See Also:

Constant Field Values

ROBOT_LIBRARY_VERSION

public static final String ROBOT_LIBRARY_VERSION

See Also:

Constant Field Values

ROBOT_LIBRARY_DOC_FORMAT

public static final String ROBOT_LIBRARY_DOC_FORMAT

See Also:

Constant Field Values

Constructor Detail

MQTTLibrary

public MQTTLibrary()

Method Detail

connectToMQTTBroker

public void connectToMQTTBroker(String broker,
                                String clientId)
                         throws org.eclipse.paho.client.mqttv3.MqttException

Connect to an MQTT broker.

Parameters:

broker - Uri of the broker to connect to

clientId - Client Id

Throws:

org.eclipse.paho.client.mqttv3.MqttException - if there is an issue connecting to the broker

publishToMQTTSynchronously

public void publishToMQTTSynchronously(String topic,
                                       Object message)
                                throws org.eclipse.paho.client.mqttv3.MqttException

Publish a message to a topic

Parameters:

topic - topic to which the message will be published

message - message payload to publish

Throws:

org.eclipse.paho.client.mqttv3.MqttException - if there is an issue publishing to the broker

publishToMQTTSynchronously

public void publishToMQTTSynchronously(String topic,
                                       Object message,
                                       int qos,
                                       boolean retained)
                                throws org.eclipse.paho.client.mqttv3.MqttException

Publish a message to a topic with specified qos and retained flag

Parameters:

topic - topic to which the message will be published

message - message payload to publish

qos - qos of the message

retained - retained flag

Throws:

org.eclipse.paho.client.mqttv3.MqttException - if there is an issue publishing to the broker

disconnectFromMQTTBroker

public void disconnectFromMQTTBroker()

Disconnect from MQTT Broker

subscribeToMQTTAndValidate

public void subscribeToMQTTAndValidate(String broker,
                                       String clientId,
                                       String topic,
                                       String expectedPayload,
                                       long timeout)

Subscribe to an MQTT broker and validate that a message with specified payload is received

Parameters:

broker - Uri of broker to subscribe to

clientId - Client Id

topic - topic to subscribe to

expectedPayload - payload to validate

timeout - timeout for the payload to be received

getKeywordDocumentation

public String getKeywordDocumentation(String keywordName)

Specified by:

getKeywordDocumentation in interface org.robotframework.javalib.library.KeywordDocumentationRepository

Overrides:

getKeywordDocumentation in class org.robotframework.javalib.library.AnnotationLibrary