com.mulesoft.connectors.mqtt3.internal.connection.provider

Class MQTT3FormConnectionProvider

java.lang.Object

com.mulesoft.connectors.mqtt3.internal.connection.provider.MQTT3ConnectionProvider

com.mulesoft.connectors.mqtt3.internal.connection.provider.MQTT3FormConnectionProvider

All Implemented Interfaces:

org.mule.runtime.api.connection.CachedConnectionProvider<MQTT3Connection>, org.mule.runtime.api.connection.ConnectionProvider<MQTT3Connection>, org.mule.runtime.api.lifecycle.Initialisable

@Alias(value="form")
 @DisplayName(value="MQTT3 Form Connection")
 @ExternalLib(name="Eclipse Paho MQTT3",
             description="Eclipse Paho MQTT3 client library for MQTT v3",
             nameRegexpMatcher="(.*)\\.jar",
             requiredClassName="org.eclipse.paho.client.mqttv3.MqttAsyncClient",
             coordinates="org.eclipse.paho:org.eclipse.paho.client.mqttv3:1.2.5",
             type=JAR,
             optional=true)
public class MQTT3FormConnectionProvider
extends MQTT3ConnectionProvider

Cached Connection provider that creates MQTT Connections. Allows the user to specify a protocol, host and port to establish a connection with the broker.

Since:

1.0.0

Field Summary

Fields inherited from class com.mulesoft.connectors.mqtt3.internal.connection.provider.MQTT3ConnectionProvider

clientIDGenerator, connectionOptions, DRIVER_FILE_NAME_PATTERN, filePersistenceOptions, lastWillAndTestament, MQTT_CONNECTION_CLASS_NAME, MQTT_DEPENDENCY, password, tlsContextFactory, username

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
MQTT3FormConnectionProvider()

Method Summary

Modifier and Type	Method and Description
protected void	configureMqttConnectOptions(MQTT3Connection mqtt3Connection) Sets specific configuration options for an MQTT3Connection
boolean	equals(Object o)
protected String	getUrl()
int	hashCode()
void	initialise()

Methods inherited from class com.mulesoft.connectors.mqtt3.internal.connection.provider.MQTT3ConnectionProvider

connect, disconnect, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

MQTT3FormConnectionProvider

public MQTT3FormConnectionProvider()

Method Detail

configureMqttConnectOptions

protected void configureMqttConnectOptions(MQTT3Connection mqtt3Connection)
                                    throws org.mule.runtime.api.connection.ConnectionException

Description copied from class: MQTT3ConnectionProvider

Sets specific configuration options for an MQTT3Connection

Specified by:

configureMqttConnectOptions in class MQTT3ConnectionProvider

Parameters:

mqtt3Connection - an instance of MQTT3Connection

Throws:

org.mule.runtime.api.connection.ConnectionException

getUrl

protected String getUrl()

Specified by:

getUrl in class MQTT3ConnectionProvider

Returns:

the URL to connect to.

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Overrides:

initialise in class MQTT3ConnectionProvider

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

equals

public boolean equals(Object o)

Overrides:

equals in class MQTT3ConnectionProvider

hashCode

public int hashCode()

Overrides:

hashCode in class MQTT3ConnectionProvider