CompositeConnectionResolver class

Helper class that resolves 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
    • protocol: connection protocol like http, https, tcp, udp
    • 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

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

compose(String? correlationId, List<ConnectionParams> connections, CredentialParams credential, ConfigParams parameters) → ConfigParams
Composes Composite connection options from connection and credential parameters.
composeOptions(List<ConnectionParams> connections, CredentialParams credential, ConfigParams parameters) → ConfigParams
configure(ConfigParams config) → void
Configures component by passing configuration parameters.
finalizeOptions(ConfigParams options) → ConfigParams
Finalize merged options This method can be overriden in child classes.
mergeConnection(ConfigParams options, ConnectionParams connection) → ConfigParams
Merges connection options with connection parameters This method can be overriden in child classes.
mergeCredential(ConfigParams options, CredentialParams credential) → ConfigParams
Merges connection options with credential parameters This method can be overriden in child classes.
mergeOptional(ConfigParams options, ConfigParams parameters) → ConfigParams
Merges connection options with optional parameters This method can be overriden in child classes.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
resolve(String? correlationId) → Future<ConfigParams>
Resolves connection options from connection and credential parameters.
setReferences(IReferences references) → void
Sets references to dependent components.
toString() → String
A string representation of this object.
inherited
validateConnection(String? correlationId, ConnectionParams? connection) → void
Validates connection parameters and throws an exception on error. This method can be overriden in child classes.
validateCredential(String? correlationId, CredentialParams? credential) → void
Validates credential parameters and throws an exception on error. This method can be overriden in child classes.

Operators

operator ==(Object other) → bool
The equality operator.
inherited