nl.nn.adapterframework.extensions.mqtt

Class MqttListener

java.lang.Object

nl.nn.adapterframework.extensions.mqtt.MqttFacade

nl.nn.adapterframework.extensions.mqtt.MqttListener

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, IListener<org.eclipse.paho.client.mqttv3.MqttMessage>, INamedObject, IPushingListener<org.eclipse.paho.client.mqttv3.MqttMessage>, IScopeProvider, ReceiverAware<org.eclipse.paho.client.mqttv3.MqttMessage>, org.eclipse.paho.client.mqttv3.MqttCallback, org.eclipse.paho.client.mqttv3.MqttCallbackExtended, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class MqttListener
extends MqttFacade
implements ReceiverAware<org.eclipse.paho.client.mqttv3.MqttMessage>, IPushingListener<org.eclipse.paho.client.mqttv3.MqttMessage>, org.eclipse.paho.client.mqttv3.MqttCallbackExtended

MQTT listener which will connect to a broker and subscribe to a topic.

Configuration:

attributes	description	default
className	nl.nn.adapterframework.extensions.mqtt.MqttListener
name	name of the listener
clientId	see MqttClient(java.lang.String serverURI, java.lang.String clientId, MqttClientPersistence persistence)
brokerUrl	see MqttClient(java.lang.String serverURI, java.lang.String clientId, MqttClientPersistence persistence)
topic	see MqttClient.subscribe(java.lang.String topicFilter)
qos	see MqttClient(java.lang.String serverURI, java.lang.String clientId, MqttClientPersistence persistence)	2
cleanSession	see MqttConnectOptions.setCleanSession(boolean cleanSession)	true
persistenceDirectory	see MqttDefaultFilePersistence and MqttClient	true
automaticReconnect	see MqttConnectOptions.setAutomaticReconnect(boolean automaticReconnect) (apart from this recover job will also try to recover)	true
charset	character encoding of received messages	UTF-8

Links to https://www.eclipse.org/paho/files/javadoc are opened in a new window/tab because the response from eclipse.org contains header X-Frame-Options:SAMEORIGIN which will make the browser refuse to open the link inside this frame.

Author:

Jaco de Groot, Niels Meijer

Field Summary

Fields inherited from class nl.nn.adapterframework.extensions.mqtt.MqttFacade

client, connectOptions, log

Constructor Summary

Constructors

Constructor and Description
MqttListener()

Method Summary

Modifier and Type	Method and Description
void	afterMessageProcessed(PipeLineResult processResult, Object rawMessageOrWrapper, Map<String,Object> context) Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
void	configure() configure() is called once at startup of the framework in the configure() method of the owner of this listener.
void	connectComplete(boolean reconnect, String brokerUrl)
void	connectionLost(Throwable throwable)
void	deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken token)
Message	extractMessage(org.eclipse.paho.client.mqttv3.MqttMessage rawMessage, Map<String,Object> context) Extracts string from message obtained from IPullingListener.getRawMessage(Map).
String	getIdFromRawMessage(org.eclipse.paho.client.mqttv3.MqttMessage rawMessage, Map<String,Object> context) Extracts ID-string from message obtained from IPullingListener.getRawMessage(Map).
Receiver<org.eclipse.paho.client.mqttv3.MqttMessage>	getReceiver()
void	messageArrived(String topic, org.eclipse.paho.client.mqttv3.MqttMessage message)
void	open() Prepares the listener for receiving messages.
void	setExceptionListener(IbisExceptionListener ibisExceptionListener) Set a (single) listener that will be notified of any exceptions.
void	setHandler(IMessageHandler<org.eclipse.paho.client.mqttv3.MqttMessage> messageHandler) Set the handler that will do the processing of the message.
void	setReceiver(Receiver<org.eclipse.paho.client.mqttv3.MqttMessage> receiver)

Methods inherited from class nl.nn.adapterframework.extensions.mqtt.MqttFacade

close, getAuthAlias, getBrokerUrl, getCharset, getClientId, getKeepAliveInterval, getLogPrefix, getName, getPassword, getPersistenceDirectory, getPhysicalDestinationName, getQos, getTimeout, getTopic, getUsername, isAutomaticReconnect, isCleanSession, setAuthAlias, setAutomaticReconnect, setBrokerUrl, setCharset, setCleanSession, setClientId, setKeepAliveInterval, setName, setPassword, setPersistenceDirectory, setQos, setTimeout, setTopic, setUsername, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.IListener

close

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName, setName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination

getDomain

Constructor Detail

MqttListener

public MqttListener()

Method Detail

setReceiver

public void setReceiver(Receiver<org.eclipse.paho.client.mqttv3.MqttMessage> receiver)

Specified by:

setReceiver in interface ReceiverAware<org.eclipse.paho.client.mqttv3.MqttMessage>

getReceiver

public Receiver<org.eclipse.paho.client.mqttv3.MqttMessage> getReceiver()

Specified by:

getReceiver in interface ReceiverAware<org.eclipse.paho.client.mqttv3.MqttMessage>

setHandler

public void setHandler(IMessageHandler<org.eclipse.paho.client.mqttv3.MqttMessage> messageHandler)

Description copied from interface: IPushingListener

Set the handler that will do the processing of the message. Each of the received messages must be pushed through handler.processMessage()

Specified by:

setHandler in interface IPushingListener<org.eclipse.paho.client.mqttv3.MqttMessage>

setExceptionListener

public void setExceptionListener(IbisExceptionListener ibisExceptionListener)

Description copied from interface: IPushingListener

Set a (single) listener that will be notified of any exceptions. The listener should use this listener to notify the receiver of any exception that occurs outside the processing of a message.

Specified by:

setExceptionListener in interface IPushingListener<org.eclipse.paho.client.mqttv3.MqttMessage>

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IListener

configure() is called once at startup of the framework in the configure() method of the owner of this listener. Purpose of this method is to reduce creating connections to databases etc. in the IPullingListener.getRawMessage(Map) method. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IListener<org.eclipse.paho.client.mqttv3.MqttMessage>

Overrides:

configure in class MqttFacade

Throws:

ConfigurationException

open

public void open()
          throws ListenerException

Description copied from interface: IListener

Prepares the listener for receiving messages. open() is called once each time the listener is started.

Specified by:

open in interface IListener<org.eclipse.paho.client.mqttv3.MqttMessage>

Overrides:

open in class MqttFacade

Throws:

ListenerException

connectComplete

public void connectComplete(boolean reconnect,
                            String brokerUrl)

Specified by:

connectComplete in interface org.eclipse.paho.client.mqttv3.MqttCallbackExtended

connectionLost

public void connectionLost(Throwable throwable)

Specified by:

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

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(String topic,
                           org.eclipse.paho.client.mqttv3.MqttMessage message)
                    throws Exception

Specified by:

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

Throws:

Exception

getIdFromRawMessage

public String getIdFromRawMessage(org.eclipse.paho.client.mqttv3.MqttMessage rawMessage,
                                  Map<String,Object> context)
                           throws ListenerException

Description copied from interface: IListener

Extracts ID-string from message obtained from IPullingListener.getRawMessage(Map). May also extract other parameters from the message and put those in the context.
Common entries in the session context are:

• id: messageId, identifies the current transportation of the message
• cid: correlationId, identifies the processing of the message in the global chain
• tsReceived: timestamp of reception of the message, formatted as yyyy-MM-dd HH:mm:ss.SSS
• tsSent: timestamp of sending of the message (only when available), formatted as yyyy-MM-dd HH:mm:ss.SSS

Specified by:

getIdFromRawMessage in interface IListener<org.eclipse.paho.client.mqttv3.MqttMessage>

Returns:

Correlation ID string.

Throws:

ListenerException

extractMessage

public Message extractMessage(org.eclipse.paho.client.mqttv3.MqttMessage rawMessage,
                              Map<String,Object> context)
                       throws ListenerException

Description copied from interface: IListener

Extracts string from message obtained from IPullingListener.getRawMessage(Map). May also extract other parameters from the message and put those in the threadContext.

Specified by:

extractMessage in interface IListener<org.eclipse.paho.client.mqttv3.MqttMessage>

Returns:

input message for adapter.

Throws:

ListenerException

afterMessageProcessed

public void afterMessageProcessed(PipeLineResult processResult,
                                  Object rawMessageOrWrapper,
                                  Map<String,Object> context)
                           throws ListenerException

Description copied from interface: IListener

Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.

Specified by:

afterMessageProcessed in interface IListener<org.eclipse.paho.client.mqttv3.MqttMessage>

Throws:

ListenerException