nl.nn.adapterframework.extensions.mqtt

Class MqttSender

java.lang.Object

nl.nn.adapterframework.extensions.mqtt.MqttFacade

nl.nn.adapterframework.extensions.mqtt.MqttSender

All Implemented Interfaces:

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

public class MqttSender
extends MqttFacade
implements ISenderWithParameters

MQTT listener which will connect to a broker and subscribe to a topic. 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:

Niels Meijer

Field Summary

Fields

Modifier and Type	Field and Description
protected ParameterList	paramList

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

client, connectOptions, log

Constructor Summary

Constructors

Constructor and Description
MqttSender()

Method Summary

Modifier and Type	Method and Description
void	addParameter(Parameter p)
void	close() Stop/close the sender and deallocate resources.
void	configure() configure() is called once at startup of the framework in the configure method of the owner of this sender.
ParameterList	getParameterList()
boolean	isSynchronous() When true, the result of sendMessage is the reply of the request.
void	open() This method will be called to start the sender.
SenderResult	sendMessage(Message message, PipeLineSession session) Send a message to some destination (as configured in the Sender object).
Message	sendMessage(Message message, PipeLineSession session, String soapHeader)

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

getLogPrefix, getPhysicalDestinationName, 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.ISenderWithParameters

consumesSessionVariable

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

sendMessageOrThrow

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

Field Detail

paramList

protected ParameterList paramList

Constructor Detail

MqttSender

public MqttSender()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from interface: ISender

configure() is called once at startup of the framework in the configure method of the owner of this sender. Purpose of this method is to check whether the static configuration of the sender is correct. 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 ISender

Overrides:

configure in class MqttFacade

Throws:

ConfigurationException

open

public void open()
          throws SenderException

Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

open in interface ISender

Overrides:

open in class MqttFacade

Throws:

SenderException

close

public void close()

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

close in interface ISender

Overrides:

close in class MqttFacade

addParameter

public void addParameter(Parameter p)

Specified by:

addParameter in interface IWithParameters

getParameterList

public ParameterList getParameterList()

Specified by:

getParameterList in interface IWithParameters

sendMessage

public SenderResult sendMessage(Message message,
                                PipeLineSession session)
                         throws SenderException,
                                TimeoutException

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
ISender.isSynchronous() returns	true	false
return value of sendMessage() is	the reply-message	the messageId of the message sent
the correlationID specified with sendMessage()	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Specified by:

sendMessage in interface ISender

Throws:

SenderException

TimeoutException

sendMessage

public Message sendMessage(Message message,
                           PipeLineSession session,
                           String soapHeader)
                    throws SenderException,
                           TimeoutException

Throws:

SenderException

TimeoutException

isSynchronous

public boolean isSynchronous()

Description copied from interface: ISender

When true, the result of sendMessage is the reply of the request.

Specified by:

isSynchronous in interface ISender