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

Class MQTT3ConnectionProvider

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

MQTT3FailOverConnectionProvider, MQTT3FormConnectionProvider, MQTT3UrlConnectionProvider

public abstract class MQTT3ConnectionProvider
extends Object
implements org.mule.runtime.api.connection.CachedConnectionProvider<MQTT3Connection>, org.mule.runtime.api.lifecycle.Initialisable

Cached Connection provider that creates MQTT3 Connections

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected ClientIDGenerator	clientIDGenerator A ClientIDGenerator that generates a Client ID to identify a connection to the MQTT broker.
protected MQTT3ConnectionOptions	connectionOptions The provided MQTT3ConnectionOptions.
protected static String	DRIVER_FILE_NAME_PATTERN
protected MQTT3FilePersistenceOptions	filePersistenceOptions The provided MQTT3FilePersistenceOptions.
protected LWTMessage	lastWillAndTestament The LWTMessage to be set.
protected static String	MQTT_CONNECTION_CLASS_NAME
protected static String	MQTT_DEPENDENCY
protected String	password Password to be used when providing authentication credentials to the MQTT broker.
protected org.mule.runtime.api.tls.TlsContextFactory	tlsContextFactory A factory for TLS contexts.
protected String	username Username to be used when providing authentication credentials to the MQTT broker.

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
MQTT3ConnectionProvider()

Method Summary

Modifier and Type	Method and Description
protected abstract void	configureMqttConnectOptions(MQTT3Connection mqtt3Connection) Sets specific configuration options for an MQTT3Connection
MQTT3Connection	connect()
void	disconnect(MQTT3Connection connection)
boolean	equals(Object o)
protected abstract String	getUrl()
int	hashCode()
void	initialise()
org.mule.runtime.api.connection.ConnectionValidationResult	validate(MQTT3Connection connection) Validates the provided MQTT3Connection by testing its connectivity.

Methods inherited from class java.lang.Object

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

Field Detail

DRIVER_FILE_NAME_PATTERN

protected static final String DRIVER_FILE_NAME_PATTERN

See Also:

Constant Field Values

MQTT_CONNECTION_CLASS_NAME

protected static final String MQTT_CONNECTION_CLASS_NAME

See Also:

Constant Field Values

MQTT_DEPENDENCY

protected static final String MQTT_DEPENDENCY

See Also:

Constant Field Values

clientIDGenerator

@Parameter
 @Summary(value="The generator used to create a connection\'s client id")
protected ClientIDGenerator clientIDGenerator

A ClientIDGenerator that generates a Client ID to identify a connection to the MQTT broker.

username

@Parameter
 @Optional
 @Username
 @Summary(value="The username used when providing authentication credentials to the MQTT broker")
protected String username

Username to be used when providing authentication credentials to the MQTT broker.

password

@Parameter
 @Optional
 @Password
 @Summary(value="The password to be used when providing authentication credentials to the MQTT broker")
protected String password

Password to be used when providing authentication credentials to the MQTT broker.

tlsContextFactory

@Parameter
 @Optional
 @Expression(value=NOT_SUPPORTED)
 @Placement(tab="SSL/TLS")
 @DisplayName(value="TLS Context")
 @Summary(value="The TLS factory used to create TLS secured connections")
protected org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory

A factory for TLS contexts. A TLS context is configured with a key store and a trust store. Allows to create TLS secured connections.

lastWillAndTestament

@Parameter
 @Expression(value=NOT_SUPPORTED)
 @Placement(tab="LWT")
 @DisplayName(value="Last Will and Testament (LWT)")
 @ParameterGroup(name="Last Will and Testament",
                showInDsl=true)
 @Summary(value="The Last Will And Testament message to be set for this client")
protected LWTMessage lastWillAndTestament

The LWTMessage to be set.

connectionOptions

@NullSafe
 @ParameterGroup(name="Connection Options",
                showInDsl=true)
 @Summary(value="A group of advanced connection options")
protected MQTT3ConnectionOptions connectionOptions

The provided MQTT3ConnectionOptions.

filePersistenceOptions

@NullSafe
 @ParameterGroup(name="File Persistence Options",
                showInDsl=true)
protected MQTT3FilePersistenceOptions filePersistenceOptions

The provided MQTT3FilePersistenceOptions.

Constructor Detail

MQTT3ConnectionProvider

public MQTT3ConnectionProvider()

Method Detail

initialise

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

Specified by:

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

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

connect

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

Specified by:

connect in interface org.mule.runtime.api.connection.ConnectionProvider<MQTT3Connection>

Throws:

org.mule.runtime.api.connection.ConnectionException

configureMqttConnectOptions

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

Sets specific configuration options for an MQTT3Connection

Parameters:

mqtt3Connection - an instance of MQTT3Connection

Throws:

org.mule.runtime.api.connection.ConnectionException

getUrl

protected abstract String getUrl()

Returns:

the URL to connect to.

disconnect

public void disconnect(MQTT3Connection connection)

Specified by:

disconnect in interface org.mule.runtime.api.connection.ConnectionProvider<MQTT3Connection>

validate

public org.mule.runtime.api.connection.ConnectionValidationResult validate(MQTT3Connection connection)

Validates the provided MQTT3Connection by testing its connectivity. Returns a ConnectionValidationResult indicating whether the connection is valid.

Specified by:

validate in interface org.mule.runtime.api.connection.ConnectionProvider<MQTT3Connection>

Parameters:

connection - the MQTT3Connection instance to validate

Returns:

a ConnectionValidationResult representing the outcome of the validation

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object