Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MqttConnectionResolver

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

Configuration parameters

  • 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

Hierarchy

  • MqttConnectionResolver

Implements

  • any
  • any

Index

Properties

Methods

Properties

Protected _connectionResolver

_connectionResolver: ConnectionResolver = new ConnectionResolver()

The connections resolver.

Protected _credentialResolver

_credentialResolver: CredentialResolver = new CredentialResolver()

The credentials resolver.

Methods

compose

  • compose(correlationId: string, connection: ConnectionParams, credential: CredentialParams, callback: function): void

  • Composes MQTT connection options from connection and credential parameters.

    Parameters

    • correlationId: string

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

    • connection: ConnectionParams

      connection parameters

    • credential: CredentialParams

      credential parameters

    • callback: function

      callback function that receives resolved options or error.

        • (err: any, options: any): void

        • Parameters

          • err: any
          • options: any

          Returns void

    Returns void

configure

  • configure(config: ConfigParams): void

  • Configures component by passing configuration parameters.

    Parameters

    • config: ConfigParams

      configuration parameters to be set.

    Returns void

resolve

  • resolve(correlationId: string, callback: function): void

  • Resolves MQTT connection options from connection and credential parameters.

    Parameters

    • correlationId: string

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

    • callback: function

      callback function that receives resolved options or error.

        • (err: any, options: any): void

        • Parameters

          • err: any
          • options: any

          Returns void

    Returns void

setReferences

  • setReferences(references: IReferences): void

  • Sets references to dependent components.

    Parameters

    • references: IReferences

      references to locate the component dependencies.

    Returns void

Generated using TypeDoc