com.mulesoft.connectors.mqtt3.internal.connection

Class DefaultMQTT3Connection

java.lang.Object

com.mulesoft.connectors.mqtt3.internal.connection.DefaultMQTT3Connection

All Implemented Interfaces:

MQTT3Connection

public class DefaultMQTT3Connection
extends Object
implements MQTT3Connection

The default implementation of an MQTT3Connection

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADDITIONAL_PROCESSING_TIME

Constructor Summary

Constructors

Constructor and Description
DefaultMQTT3Connection(String url, String clientId, MQTT3ConnectionOptions connectionOptions, MQTT3FilePersistenceOptions filePersistenceOptions, LWTMessage lwtMessage) Returns an instance of a DefaultMQTT3Connection.

Method Summary

Modifier and Type	Method and Description
void	addSourceCallbackToConnectionLostHandler(org.mule.runtime.extension.api.runtime.source.SourceCallback<byte[],MQTT3MessageAttributes> callback) Adds a SourceCallback to the MQTT3ConnectionLostHandler.
void	connect() Attempts to establish a connection to the mqtt broker.
void	disconnect() Closes the connection to the broker for this connection instance.
boolean	equals(Object o)
int	hashCode()
boolean	isCleanSessionEnabled()
boolean	isConnected()
boolean	isSessionPresent()
CompletableFuture<Integer>	publish(String topic, byte[] message, int qos, boolean isRetained) Publishes a message to a topic, with the specified quality of service and retention flag.
void	registerMessageHandler(List<Topic> topics, MQTT3MessageHandler messageHandler) Registers a MQTT3MessageHandler locally for the provided topics without subscribing to the broker.
void	setFailOverServers(String[] failOverServerArray) Sets a list of fail over servers to be iterated over until a connection is successfully established.
void	setTLSOptions(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory) Sets a TlsContextFactory for the connection.
void	setUsernamePassword(String username, String password) Sets a username and a password for authentication.
void	subscribeToTopics(List<Topic> topics) Subscribes to the provided topics on the broker.
boolean	testConnectivity() Tests if the connection can be established without changing the current connection state.
void	unsubscribeListenerFromTopics(List<Topic> topics, MQTT3MessageHandler messageHandler) Unsubscribes the client with the connection's client id from the provided list of Topics.

Methods inherited from class java.lang.Object

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

Field Detail

ADDITIONAL_PROCESSING_TIME

public static final int ADDITIONAL_PROCESSING_TIME

See Also:

Constant Field Values

Constructor Detail

DefaultMQTT3Connection

public DefaultMQTT3Connection(String url,
                              String clientId,
                              MQTT3ConnectionOptions connectionOptions,
                              MQTT3FilePersistenceOptions filePersistenceOptions,
                              LWTMessage lwtMessage)
                       throws org.mule.runtime.api.connection.ConnectionException

Returns an instance of a DefaultMQTT3Connection.

Parameters:

url - the URL to connect to.

clientId - the client id that identifies this connection.

connectionOptions - an instance of MQTT3ConnectionOptions

lwtMessage - an instance of LWTMessage

Throws:

org.mule.runtime.api.connection.ConnectionException

Method Detail

isCleanSessionEnabled

public boolean isCleanSessionEnabled()

Returns:

true if the clean session flag is set to true.

setUsernamePassword

public void setUsernamePassword(String username,
                                String password)

Sets a username and a password for authentication.

Specified by:

setUsernamePassword in interface MQTT3Connection

Parameters:

username - the authentication username.

password - the authentication password.

setFailOverServers

public void setFailOverServers(String[] failOverServerArray)

Sets a list of fail over servers to be iterated over until a connection is successfully established.

Specified by:

setFailOverServers in interface MQTT3Connection

Parameters:

failOverServerArray - the list of servers to iterate over.

connect

public void connect()
             throws org.mule.runtime.api.connection.ConnectionException

Attempts to establish a connection to the mqtt broker.

Specified by:

connect in interface MQTT3Connection

Throws:

org.mule.runtime.api.connection.ConnectionException - if connection attempt was unsuccessful.

registerMessageHandler

public void registerMessageHandler(List<Topic> topics,
                                   MQTT3MessageHandler messageHandler)

Registers a MQTT3MessageHandler locally for the provided topics without subscribing to the broker. This allows handlers to be ready before connecting to prevent race conditions.

Specified by:

registerMessageHandler in interface MQTT3Connection

Parameters:

topics - the list of Topic filters for which the handler will be registered.

messageHandler - a MQTT3MessageHandler to be called when messages for these topics are received.

subscribeToTopics

public void subscribeToTopics(List<Topic> topics)
                       throws org.mule.runtime.api.connection.ConnectionException

Subscribes to the provided topics on the broker. The message handlers should already be registered.

Specified by:

subscribeToTopics in interface MQTT3Connection

Parameters:

topics - the list of Topic filters to subscribe to on the broker.

Throws:

org.mule.runtime.api.connection.ConnectionException - if an error occurs during subscription.

unsubscribeListenerFromTopics

public void unsubscribeListenerFromTopics(List<Topic> topics,
                                          MQTT3MessageHandler messageHandler)

Unsubscribes the client with the connection's client id from the provided list of Topics. Removes the provided MQTT3MessageHandler from each of the Topic's callback list.

Specified by:

unsubscribeListenerFromTopics in interface MQTT3Connection

Parameters:

topics - the list of Topic filters from which the connection will be unsubscribed.

messageHandler - a MQTT3MessageHandler to be removed from each of the Topic's callback list.

addSourceCallbackToConnectionLostHandler

public void addSourceCallbackToConnectionLostHandler(org.mule.runtime.extension.api.runtime.source.SourceCallback<byte[],MQTT3MessageAttributes> callback)

Adds a SourceCallback to the MQTT3ConnectionLostHandler.

Specified by:

addSourceCallbackToConnectionLostHandler in interface MQTT3Connection

isConnected

public boolean isConnected()

Specified by:

isConnected in interface MQTT3Connection

Returns:

true if the connection is still alive.

testConnectivity

public boolean testConnectivity()

Description copied from interface: MQTT3Connection

Tests if the connection can be established without changing the current connection state. This is useful for validation purposes during redeployments.

Specified by:

testConnectivity in interface MQTT3Connection

Returns:

true if the connection can be established successfully.

publish

public CompletableFuture<Integer> publish(String topic,
                                          byte[] message,
                                          int qos,
                                          boolean isRetained)
                                   throws MQTT3PublishException,
                                          org.mule.runtime.api.connection.ConnectionException

Publishes a message to a topic, with the specified quality of service and retention flag.

Specified by:

publish in interface MQTT3Connection

Parameters:

topic - the topic to which the message should be published.

message - the message content to be sent.

qos - the quality of service with which the message should be published.

isRetained - whether the message should be retained by the broker for the specified topic.

Returns:

a CompletableFuture that returns the published message id on success.

Throws:

MQTT3PublishException - if an error occurred publishing the message to the broker.

org.mule.runtime.api.connection.ConnectionException - if a connectivity issue occurred while publishing the message.

isSessionPresent

public boolean isSessionPresent()

Specified by:

isSessionPresent in interface MQTT3Connection

Returns:

true if there is a session present for this connection's client id.

setTLSOptions

public void setTLSOptions(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory)
                   throws org.mule.runtime.api.connection.ConnectionException

Sets a TlsContextFactory for the connection.

Specified by:

setTLSOptions in interface MQTT3Connection

Parameters:

tlsContextFactory - the TlsContextFactory with the required data.

Throws:

org.mule.runtime.api.connection.ConnectionException

disconnect

public void disconnect()

Closes the connection to the broker for this connection instance.

Specified by:

disconnect in interface MQTT3Connection

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object