com.testoptimal.plugin

Class MqttPlugin

java.lang.Object

com.testoptimal.plugin.PluginAncestor

com.testoptimal.plugin.MqttPlugin

All Implemented Interfaces:

MScriptInterface

public final class MqttPlugin
extends PluginAncestor

MQTT Plugin provides a set of functions to send and receive message to/from MQTT compliant servers.

Since:

6.0

Author:

yxl01

Nested Class Summary

Nested classes/interfaces inherited from interface com.testoptimal.plugin.MScriptInterface

MScriptInterface.IGNORE_INHERITED_METHOD, MScriptInterface.NOT_MSCRIPT_METHOD, MScriptInterface.TO_PLUGIN

Constructor Summary

Constructors

Constructor and Description
MqttPlugin()

Method Summary

Modifier and Type	Method and Description
void	close() INTERNAL USE ONLY
void	connectAndSubscribe() makes connection to MQTT server and subscribe to the subTopic.
org.eclipse.paho.client.mqttv3.MqttConnectOptions	getConnectionOptions() returns MQTT connection option object to be used to connect to MQTT server.
String	getPluginDesc()
String	getPluginID() INTERNAL USE ONLY
void	initialize(MbtScriptExecutor scriptExec_p) INTERNAL USE ONLY
void	sendBytes(byte[] byteArray_p) sends a message.
Object	sendReceiveBytes(byte[] byteArray_p, long timeoutMillis_p) sends a byte[] message, wait for the result and return the results.
Object	sendReceiveString(String msg_p, long timeoutMillis_p) sends a message, wait for the result and return the results.
void	sendString(String msg_p) sends a message.
void	setAutoConnect(boolean autoConnect_p) sets plugin to automatically makes connection to MQTT server on starting.
void	setRequiredOptions(String clientID_p, String brokerURL_p, String pubTopic_p, int pubQoS_p, String subTopic_p, int subQoS_p)
void	setResultTimeoutMillis(long resultTimeoutMillis_p) timeout in milliseconds to wait for the result response from the client.
void	setUsernamePassword(String username_p, String password_p) sets user name and password to be used to connect to MQTT.
void	start() Internal use, called when model execution starts (after MBT_Start trigger).

Methods inherited from class com.testoptimal.plugin.PluginAncestor

enterInitialState, exitFinalState

Methods inherited from class java.lang.Object

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

Constructor Detail

MqttPlugin

public MqttPlugin()

Method Detail

initialize

public void initialize(MbtScriptExecutor scriptExec_p)

INTERNAL USE ONLY

close

public void close()

INTERNAL USE ONLY

Specified by:

close in class PluginAncestor

getPluginID

public String getPluginID()

INTERNAL USE ONLY

Specified by:

getPluginID in class PluginAncestor

getPluginDesc

public String getPluginDesc()

Specified by:

getPluginDesc in class PluginAncestor

setAutoConnect

public void setAutoConnect(boolean autoConnect_p)

sets plugin to automatically makes connection to MQTT server on starting. The default setting is true.

Parameters:

autoConnect_p - boolean true or false

setRequiredOptions

public void setRequiredOptions(String clientID_p,
                               String brokerURL_p,
                               String pubTopic_p,
                               int pubQoS_p,
                               String subTopic_p,
                               int subQoS_p)

Parameters:

clientID_p -

brokerURL_p -

pubTopic_p -

pubQoS_p -

subTopic_p -

subQoS_p -

setResultTimeoutMillis

public void setResultTimeoutMillis(long resultTimeoutMillis_p)

timeout in milliseconds to wait for the result response from the client. Default 5000 (5 seconds).

Parameters:

resultTimeoutMillis_p -

start

public void start()
           throws Exception

Internal use, called when model execution starts (after MBT_Start trigger).

Specified by:

start in class PluginAncestor

Throws:

Exception

connectAndSubscribe

public void connectAndSubscribe()
                         throws Exception

makes connection to MQTT server and subscribe to the subTopic. Use this function when you set autoConnect = false to manually makes the connection.

Throws:

Exception

sendReceiveString

public Object sendReceiveString(String msg_p,
                                long timeoutMillis_p)

sends a message, wait for the result and return the results.

Parameters:

msg_p - string message

timeoutMillis_p - timeout waiting for the results.

Returns:

null if timeout or interrupted or errored while waiting for the results

sendReceiveBytes

public Object sendReceiveBytes(byte[] byteArray_p,
                               long timeoutMillis_p)

sends a byte[] message, wait for the result and return the results.

Parameters:

byteArray_p - byte[] message

timeoutMillis_p - timeout waiting for the results.

Returns:

null if timeout or interrupted or errored while waiting for the results

sendString

public void sendString(String msg_p)
                throws org.eclipse.paho.client.mqttv3.MqttException

sends a message.

Parameters:

msg_p - a string

Throws:

org.eclipse.paho.client.mqttv3.MqttException

sendBytes

public void sendBytes(byte[] byteArray_p)
               throws org.eclipse.paho.client.mqttv3.MqttException

sends a message.

Parameters:

byteArray_p - byte[] message

Throws:

org.eclipse.paho.client.mqttv3.MqttException

getConnectionOptions

public org.eclipse.paho.client.mqttv3.MqttConnectOptions getConnectionOptions()

returns MQTT connection option object to be used to connect to MQTT server. Use this connection option object to set user credential and other connection options. This must be called in MBT_Start trigger to be effective.

Returns:

setUsernamePassword

public void setUsernamePassword(String username_p,
                                String password_p)

sets user name and password to be used to connect to MQTT.

Parameters:

username_p - user name

password_p - password