MqttConnectionResolver

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

Description

The MqttConnectionResolver class allows you to resolve MQTT connections and credential parameters, validate them, and generate connection options.

Configuration parameters

  • connection(s):
    • discovery_key: (optional) 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) key to retrieve the credentials from ICredentialStore
    • username: username
    • password: user’s password

References

  • *:discovery:*:*:1.0 - (optional) IDiscovery services
  • *:credential-store:*:*:1.0 - (optional) credential stores to resolve credentials

Constructors

NewMqttConnectionResolver

Creates a new instance of connection resolver component.

NewMqttConnectionResolver() *MqttConnectionResolver

Fields

ConnectionResolver

Connection resolver

ConnectionResolver: ConnectionResolver

CredentialResolver

Credential resolver

CredentialResolver: CredentialResolver

Methods

Compose

Composes MQTT connection options from connection and credential parameters.

(c *MqttConnectionResolver) Compose(correlationId string, connection *ConnectionParams, credential *CredentialParams) (options *ConfigParams, err error)

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • connection: *ConnectionParams - connection parameters
  • credential: *CredentialParams - credential parameters
  • returns: (options *ConfigParams, err error) - resolved MQTT connection options

Configure

Configures the component by passing its configuration parameters.

(c *MqttConnectionResolver) Configure(ctx context.Context, config *ConfigParams)

  • ctx: context.Context - operation context.
  • config: *ConfigParams - configuration parameters to be set.

Resolve

Resolves MQTT connection options from connection and credential parameters.

(c *MqttConnectionResolver) Resolve(correlationId string) (options *ConfigParams, err error)

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • returns: (options *ConfigParams, err error) - resolved MQTT connection options.

SetReferences

Sets references to dependent components.

(c *MqttConnectionResolver) SetReferences(ctx context.Context, references IReferences)

  • ctx: context.Context - operation context.
  • references: IReferences - references to locate the component’s dependencies.