pip_services3_mqtt.connect.MqttConnectionResolver module

class pip_services3_mqtt.connect.MqttConnectionResolver.MqttConnectionResolver

Bases: pip_services3_commons.refer.IReferenceable.IReferenceable, pip_services3_commons.config.IConfigurable.IConfigurable

Helper class that resolves MQTT connection and credential parameters, validates them and generates connection options.

  • connection(s):

    • discovery_key: (optional) a key to retrieve the connection from IDiscovery

    • host: host name or IP address

    • port: port number

    • uri: resource URI or connection string with all parameters in it

  • credential(s):

    • store_key: (optional) a key to retrieve the credentials from ICredentialStore

    • username: user name

    • password: user password

### References ###

  • *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connections

  • *:credential-store:*:*:1.0 (optional) Credential stores to resolve credentials

Example:

TODO: add example
compose(correlation_id: Optional[str], connection: pip_services3_components.connect.ConnectionParams.ConnectionParams, credential: pip_services3_components.auth.CredentialParams.CredentialParams) → Any

Composes MQTT connection options from connection and credential parameters.

Parameters

  • correlation_id – (optional) transaction id to trace execution through call chain.

  • connection – connection parameters

  • credential – credential parameters

Returns

resolved MQTT connection options.

configure(config: pip_services3_commons.config.ConfigParams.ConfigParams)

Configures component by passing configuration parameters.

Parameters

config – configuration parameters to be set.

resolve(correlation_id: Optional[str]) → Any

Resolves MQTT connection options from connection and credential parameters.

Parameters

correlation_id – (optional) transaction id to trace execution through call chain.

Returns

resolved MQTT connection options.

set_references(references: pip_services3_commons.refer.IReferences.IReferences)

Sets references to dependent components.

Parameters

references – references to locate the component dependencies.