nl.nn.adapterframework.extensions.mqtt

Class MqttFacade

java.lang.Object

nl.nn.adapterframework.extensions.mqtt.MqttFacade

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

MqttListener, MqttSender

public class MqttFacade
extends Object
implements HasPhysicalDestination, IConfigurable

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.paho.client.mqttv3.MqttClient	client
protected org.eclipse.paho.client.mqttv3.MqttConnectOptions	connectOptions
protected org.apache.logging.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
MqttFacade()

Method Summary

Modifier and Type	Method and Description
void	close()
void	configure()
protected String	getLogPrefix()
String	getPhysicalDestinationName()
void	open()
void	setAuthAlias(String authAlias)
void	setAutomaticReconnect(boolean automaticReconnect) see MqttConnectOptions.setAutomaticReconnect(boolean automaticReconnect) (apart from this recover job will also try to recover)
void	setBrokerUrl(String brokerUrl) see MqttClient(java.lang.String serverURI, java.lang.String clientId, MqttClientPersistence persistence)
void	setCharset(String charset) character encoding of received messages
void	setCleanSession(boolean cleanSession) see MqttConnectOptions.setCleanSession(boolean cleanSession)
void	setClientId(String clientId) see MqttClient(java.lang.String serverURI, java.lang.String clientId, MqttClientPersistence persistence)
void	setKeepAliveInterval(int keepAliveInterval)
void	setName(String newName) The functional name of the object.
void	setPassword(String password)
void	setPersistenceDirectory(String persistenceDirectory) see MqttDefaultFilePersistence and MqttClient
void	setQos(int qos) see MqttClient(java.lang.String serverURI, java.lang.String clientId, MqttClientPersistence persistence)
void	setTimeout(int timeOut)
void	setTopic(String topic) see MqttClient.subscribe(java.lang.String topicFilter)
void	setUsername(String username)
String	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.HasPhysicalDestination

getDomain

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

getName

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

Field Detail

log

protected org.apache.logging.log4j.Logger log

client

protected org.eclipse.paho.client.mqttv3.MqttClient client

connectOptions

protected org.eclipse.paho.client.mqttv3.MqttConnectOptions connectOptions

Constructor Detail

MqttFacade

public MqttFacade()

Method Detail

configure

public void configure()
               throws ConfigurationException

Specified by:

configure in interface IConfigurable

Throws:

ConfigurationException

open

public void open()
          throws Exception

Throws:

Exception

close

public void close()

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

toString

public String toString()

Overrides:

toString in class Object

setName

public void setName(String newName)

Description copied from interface: INamedObject

The functional name of the object.

Specified by:

setName in interface INamedObject

getLogPrefix

protected String getLogPrefix()

setTimeout

public void setTimeout(int timeOut)

setKeepAliveInterval

public void setKeepAliveInterval(int keepAliveInterval)

setClientId

public void setClientId(String clientId)

see MqttClient(java.lang.String serverURI, java.lang.String clientId, MqttClientPersistence persistence)

setBrokerUrl

public void setBrokerUrl(String brokerUrl)

see MqttClient(java.lang.String serverURI, java.lang.String clientId, MqttClientPersistence persistence)

setTopic

public void setTopic(String topic)

see MqttClient.subscribe(java.lang.String topicFilter)

setQos

public void setQos(int qos)

see MqttClient(java.lang.String serverURI, java.lang.String clientId, MqttClientPersistence persistence)

Default value

2

setCleanSession

public void setCleanSession(boolean cleanSession)

see MqttConnectOptions.setCleanSession(boolean cleanSession)

Default value

true

setPersistenceDirectory

public void setPersistenceDirectory(String persistenceDirectory)

see MqttDefaultFilePersistence and MqttClient

setAutomaticReconnect

public void setAutomaticReconnect(boolean automaticReconnect)

see MqttConnectOptions.setAutomaticReconnect(boolean automaticReconnect) (apart from this recover job will also try to recover)

Default value

true

setCharset

public void setCharset(String charset)

character encoding of received messages

Default value

UTF-8

setUsername

public void setUsername(String username)

setPassword

public void setPassword(String password)

setAuthAlias

public void setAuthAlias(String authAlias)