services.moleculer.transporter

Class MqttTransporter

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.transporter.Transporter

services.moleculer.transporter.MqttTransporter

All Implemented Interfaces:

org.eclipse.paho.client.mqttv3.MqttCallback, MetricConstants, MoleculerLifecycle

public class MqttTransporter
extends Transporter
implements org.eclipse.paho.client.mqttv3.MqttCallback

MQTT Transporter (eg. for Mosquitto MQTT Server or ActiveMQ Server). MQTT is a machine-to-machine (M2M)/"Internet of Things" connectivity protocol. It was designed as an extremely lightweight publish/subscribe messaging transport (website: http://mqtt.org). Usage:

 ServiceBroker broker = ServiceBroker.builder().nodeID("node1").transporter(new MqttTransporter("localhost"))
                .build();
 

Required dependency:

// https://mvnrepository.com/artifact/org.eclipse.paho/org.eclipse.paho.client. mqttv3
compile group: 'org.eclipse.paho', name: 'org.eclipse.paho.client.mqttv3', version: '1.2.5'

See Also:

TcpTransporter, RedisTransporter, NatsTransporter, NatsStreamingTransporter, JmsTransporter, KafkaTransporter, AmqpTransporter

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cleanSession
protected org.eclipse.paho.client.mqttv3.MqttAsyncClient	client
protected int	connectionTimeout
protected java.util.Properties	customWebSocketHeaders
protected int	executorServiceTimeout
protected javax.net.ssl.HostnameVerifier	hostnameVerifier
protected boolean	httpsHostnameVerificationEnabled
protected int	keepAliveInterval
protected int	maxInflight
protected int	mqttVersion
protected java.lang.String	password
protected org.eclipse.paho.client.mqttv3.persist.MemoryPersistence	persistence
protected int	qos
protected javax.net.SocketFactory	socketFactory
protected java.util.Properties	sslClientProps
protected java.lang.String[]	urls
protected java.lang.String	username

Fields inherited from class services.moleculer.transporter.Transporter

checkTimeoutTimer, counterTransporterPacketsReceivedBytes, counterTransporterPacketsReceivedTotal, counterTransporterPacketsSentBytes, counterTransporterPacketsSentTotal, debug, debugHeartbeats, disconnectChannel, discoverBroadcastChannel, discoverChannel, eventbus, eventChannel, executor, gaugeTransitConnected, heartbeatChannel, heartbeatInterval, heartbeatTimeout, heartBeatTimer, infoBroadcastChannel, infoChannel, infoScheduled, infoScheduledAt, instanceID, lastReceivedMessageAt, metrics, monitor, namespace, nodeID, nodes, offlineTimeout, PACKET_DISCONNECT, PACKET_DISCOVER, PACKET_EVENT, PACKET_HEARTBEAT, PACKET_INFO, PACKET_PING, PACKET_PONG, PACKET_REQUEST, PACKET_RESPONSE, pingChannel, pongChannel, preferHostname, prefix, protocolVersion, registry, requestChannel, responseChannel, scheduler, serializer, serviceInvoker, subscriptionTimeout, uidGenerator, usingJsonSerializer

Fields inherited from class services.moleculer.service.MoleculerComponent

broker, logger, name

Fields inherited from interface services.moleculer.metrics.MetricConstants

MOLECULER_CACHER_CLEAN_TIME, MOLECULER_CACHER_CLEAN_TIME_DESC, MOLECULER_CACHER_CLEAN_TOTAL, MOLECULER_CACHER_CLEAN_TOTAL_DESC, MOLECULER_CACHER_DEL_TIME, MOLECULER_CACHER_DEL_TIME_DESC, MOLECULER_CACHER_DEL_TOTAL, MOLECULER_CACHER_DEL_TOTAL_DESC, MOLECULER_CACHER_EXPIRED_TOTAL, MOLECULER_CACHER_EXPIRED_TOTAL_DESC, MOLECULER_CACHER_FOUND_TOTAL, MOLECULER_CACHER_FOUND_TOTAL_DESC, MOLECULER_CACHER_GET_TIME, MOLECULER_CACHER_GET_TIME_DESC, MOLECULER_CACHER_GET_TOTAL, MOLECULER_CACHER_GET_TOTAL_DESC, MOLECULER_CACHER_SET_TIME, MOLECULER_CACHER_SET_TIME_DESC, MOLECULER_CACHER_SET_TOTAL, MOLECULER_CACHER_SET_TOTAL_DESC, MOLECULER_CIRCUIT_BREAKER_HALF_OPENED_ACTIVE, MOLECULER_CIRCUIT_BREAKER_HALF_OPENED_ACTIVE_DESC, MOLECULER_CIRCUIT_BREAKER_OPENED_ACTIVE, MOLECULER_CIRCUIT_BREAKER_OPENED_ACTIVE_DESC, MOLECULER_CIRCUIT_BREAKER_OPENED_TOTAL, MOLECULER_CIRCUIT_BREAKER_OPENED_TOTAL_DESC, MOLECULER_EVENT_BROADCAST_TOTAL, MOLECULER_EVENT_BROADCAST_TOTAL_DESC, MOLECULER_EVENT_BROADCASTLOCAL_TOTAL, MOLECULER_EVENT_BROADCASTLOCAL_TOTAL_DESC, MOLECULER_EVENT_EMIT_TOTAL, MOLECULER_EVENT_EMIT_TOTAL_DESC, MOLECULER_EVENT_RECEIVED_ACTIVE, MOLECULER_EVENT_RECEIVED_ACTIVE_DESC, MOLECULER_EVENT_RECEIVED_ERROR_TOTAL, MOLECULER_EVENT_RECEIVED_ERROR_TOTAL_DESC, MOLECULER_EVENT_RECEIVED_TIME, MOLECULER_EVENT_RECEIVED_TIME_DESC, MOLECULER_EVENT_RECEIVED_TOTAL, MOLECULER_EVENT_RECEIVED_TOTAL_DESC, MOLECULER_EXECUTOR, MOLECULER_REQUEST_ACTIVE, MOLECULER_REQUEST_ACTIVE_DESC, MOLECULER_REQUEST_ERROR_TOTAL, MOLECULER_REQUEST_ERROR_TOTAL_DESC, MOLECULER_REQUEST_LEVELS, MOLECULER_REQUEST_LEVELS_DESC, MOLECULER_REQUEST_RETRY_ATTEMPTS_TOTAL, MOLECULER_REQUEST_RETRY_ATTEMPTS_TOTAL_DESC, MOLECULER_REQUEST_TIME, MOLECULER_REQUEST_TIME_DESC, MOLECULER_REQUEST_TIMEOUT_TOTAL, MOLECULER_REQUEST_TIMEOUT_TOTAL_DESC, MOLECULER_REQUEST_TOTAL, MOLECULER_REQUEST_TOTAL_DESC, MOLECULER_SCHEDULER, MOLECULER_TRANSIT_CONNECTED, MOLECULER_TRANSIT_CONNECTED_DESC, MOLECULER_TRANSIT_ORPHAN_RESPONSE_TOTAL, MOLECULER_TRANSIT_ORPHAN_RESPONSE_TOTAL_DESC, MOLECULER_TRANSIT_REQUESTS_ACTIVE, MOLECULER_TRANSIT_REQUESTS_ACTIVE_DESC, MOLECULER_TRANSIT_STREAMS_RECEIVE_ACTIVE, MOLECULER_TRANSIT_STREAMS_RECEIVE_ACTIVE_DESC, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_BYTES, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_BYTES_DESC, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_TOTAL, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_TOTAL_DESC, MOLECULER_TRANSPORTER_PACKETS_SENT_BYTES, MOLECULER_TRANSPORTER_PACKETS_SENT_BYTES_DESC, MOLECULER_TRANSPORTER_PACKETS_SENT_TOTAL, MOLECULER_TRANSPORTER_PACKETS_SENT_TOTAL_DESC

Constructor Summary

Constructors

Constructor and Description
MqttTransporter()
MqttTransporter(java.lang.String... urls)
MqttTransporter(java.lang.String username, java.lang.String password, java.lang.String... urls)

Method Summary

Modifier and Type	Method and Description
void	connect()
void	connectionLost(java.lang.Throwable cause)
void	deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken token)
protected void	disconnect()
protected void	error(java.lang.Throwable cause) Any I/O error occurred.
int	getConnectionTimeout()
java.util.Properties	getCustomWebSocketHeaders()
int	getExecutorServiceTimeout()
javax.net.ssl.HostnameVerifier	getHostnameVerifier()
int	getKeepAliveInterval()
int	getMaxInflight()
int	getMqttVersion()
java.lang.String	getPassword()
org.eclipse.paho.client.mqttv3.persist.MemoryPersistence	getPersistence()
int	getQos()
javax.net.SocketFactory	getSocketFactory()
java.util.Properties	getSslClientProps()
java.lang.String[]	getUrls()
java.lang.String	getUsername()
boolean	isCleanSession()
boolean	isHttpsHostnameVerificationEnabled()
void	messageArrived(java.lang.String topic, org.eclipse.paho.client.mqttv3.MqttMessage message)
void	publish(java.lang.String channel, io.datatree.Tree message)
protected void	reconnect(java.lang.Throwable cause)
void	setCleanSession(boolean cleanSession)
void	setConnectionTimeout(int connectionTimeout)
void	setCustomWebSocketHeaders(java.util.Properties customWebSocketHeaders)
void	setExecutorServiceTimeout(int executorServiceTimeout)
void	setHostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier)
void	setHttpsHostnameVerificationEnabled(boolean httpsHostnameVerificationEnabled)
void	setKeepAliveInterval(int keepAliveInterval)
void	setMaxInflight(int maxInflight)
void	setMqttVersion(int mqttVersion)
void	setPassword(java.lang.String password)
void	setPersistence(org.eclipse.paho.client.mqttv3.persist.MemoryPersistence persistence)
void	setQos(int qos)
void	setSocketFactory(javax.net.SocketFactory socketFactory)
void	setSslClientProps(java.util.Properties sslClientProps)
void	setUrls(java.lang.String... urls)
void	setUsername(java.lang.String username)
void	stopped() Closes transporter.
io.datatree.Promise	subscribe(java.lang.String channel)

Methods inherited from class services.moleculer.transporter.Transporter

broadcastInfoPacket, broadcastNodeConnected, broadcastNodeDisconnected, broadcastNodeUpdated, broadcastTransporterConnected, broadcastTransporterDisconnected, channel, checkTimeouts, connected, connected, createPingPacket, getAddress, getAllNodeIDs, getCpuUsage, getDescriptor, getHeartbeatInterval, getHeartbeatTimeout, getInstanceID, getLastHeartbeatTime, getNamespace, getOfflineTimeout, getPrefix, getSerializer, getSubscriptionTimeout, isDebug, isDebugHeartbeats, isOnline, isPreferHostname, processReceivedMessage, processReceivedMessage, publish, received, scheduleInfoPacket, sendClosePacket, sendDataPacket, sendDisconnectPacket, sendDiscoverPacket, sendErrorPacket, sendEventPacket, sendHeartbeatPacket, sendInfoPacket, sendPongPacket, sendRequestPacket, setDebug, setDebugHeartbeats, setHeartbeatInterval, setHeartbeatTimeout, setNamespace, setOfflineTimeout, setPreferHostname, setPrefix, setSerializer, setSubscriptionTimeout, started, subscribe, updateNodeInfo

Methods inherited from class services.moleculer.service.MoleculerComponent

getBroker, getLogger, getName

Methods inherited from class java.lang.Object

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

Field Detail

username

protected java.lang.String username

password

protected java.lang.String password

urls

protected java.lang.String[] urls

qos

protected int qos

cleanSession

protected boolean cleanSession

persistence

protected org.eclipse.paho.client.mqttv3.persist.MemoryPersistence persistence

connectionTimeout

protected int connectionTimeout

executorServiceTimeout

protected int executorServiceTimeout

httpsHostnameVerificationEnabled

protected boolean httpsHostnameVerificationEnabled

keepAliveInterval

protected int keepAliveInterval

maxInflight

protected int maxInflight

mqttVersion

protected int mqttVersion

socketFactory

protected javax.net.SocketFactory socketFactory

hostnameVerifier

protected javax.net.ssl.HostnameVerifier hostnameVerifier

sslClientProps

protected java.util.Properties sslClientProps

customWebSocketHeaders

protected java.util.Properties customWebSocketHeaders

client

protected org.eclipse.paho.client.mqttv3.MqttAsyncClient client

Constructor Detail

MqttTransporter

public MqttTransporter()

MqttTransporter

public MqttTransporter(java.lang.String... urls)

MqttTransporter

public MqttTransporter(java.lang.String username,
                       java.lang.String password,
                       java.lang.String... urls)

Method Detail

connect

public void connect()

Specified by:

connect in class Transporter

disconnect

protected void disconnect()

reconnect

protected void reconnect(java.lang.Throwable cause)

connectionLost

public void connectionLost(java.lang.Throwable cause)

Specified by:

connectionLost in interface org.eclipse.paho.client.mqttv3.MqttCallback

error

protected void error(java.lang.Throwable cause)

Description copied from class: Transporter

Any I/O error occurred. Implementation-specific error handling goes here (reconnection, etc.).

Overrides:

error in class Transporter

Parameters:

cause - I/O error

stopped

public void stopped()

Closes transporter.

Specified by:

stopped in interface MoleculerLifecycle

Overrides:

stopped in class Transporter

subscribe

public io.datatree.Promise subscribe(java.lang.String channel)

Specified by:

subscribe in class Transporter

publish

public void publish(java.lang.String channel,
                    io.datatree.Tree message)

Specified by:

publish in class Transporter

deliveryComplete

public void deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken token)

Specified by:

deliveryComplete in interface org.eclipse.paho.client.mqttv3.MqttCallback

messageArrived

public void messageArrived(java.lang.String topic,
                           org.eclipse.paho.client.mqttv3.MqttMessage message)
                    throws java.lang.Exception

Specified by:

messageArrived in interface org.eclipse.paho.client.mqttv3.MqttCallback

Throws:

java.lang.Exception

getUrls

public java.lang.String[] getUrls()

setUrls

public void setUrls(java.lang.String... urls)

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String username)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getQos

public int getQos()

setQos

public void setQos(int qos)

isCleanSession

public boolean isCleanSession()

setCleanSession

public void setCleanSession(boolean cleanSession)

getPersistence

public org.eclipse.paho.client.mqttv3.persist.MemoryPersistence getPersistence()

setPersistence

public void setPersistence(org.eclipse.paho.client.mqttv3.persist.MemoryPersistence persistence)

getConnectionTimeout

public int getConnectionTimeout()

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

getExecutorServiceTimeout

public int getExecutorServiceTimeout()

setExecutorServiceTimeout

public void setExecutorServiceTimeout(int executorServiceTimeout)

isHttpsHostnameVerificationEnabled

public boolean isHttpsHostnameVerificationEnabled()

setHttpsHostnameVerificationEnabled

public void setHttpsHostnameVerificationEnabled(boolean httpsHostnameVerificationEnabled)

getKeepAliveInterval

public int getKeepAliveInterval()

setKeepAliveInterval

public void setKeepAliveInterval(int keepAliveInterval)

getMaxInflight

public int getMaxInflight()

setMaxInflight

public void setMaxInflight(int maxInflight)

getMqttVersion

public int getMqttVersion()

setMqttVersion

public void setMqttVersion(int mqttVersion)

getSocketFactory

public javax.net.SocketFactory getSocketFactory()

setSocketFactory

public void setSocketFactory(javax.net.SocketFactory socketFactory)

getHostnameVerifier

public javax.net.ssl.HostnameVerifier getHostnameVerifier()

setHostnameVerifier

public void setHostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier)

getSslClientProps

public java.util.Properties getSslClientProps()

setSslClientProps

public void setSslClientProps(java.util.Properties sslClientProps)

getCustomWebSocketHeaders

public java.util.Properties getCustomWebSocketHeaders()

setCustomWebSocketHeaders

public void setCustomWebSocketHeaders(java.util.Properties customWebSocketHeaders)