CompositeConnectionResolver

Implements: IConfigurable, IReferenceable

Description

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

Configuration parameters

connection(s):

• discovery_key: (optional) key to retrieve the connection from IDiscovery
• protocol: communication protocol
• 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 to resolve connections
• *:credential-store:*:*:1.0 - (optional) Credential stores to resolve credentials ICredentialStore

Fields

Instance methods

compose

Composes composite connection options from connection and credential parameters.

ConfigParams compose(correlationId: String, List<ConnectionParams> connections, CredentialParams credential, ConfigParams parameters)

• correlationId: String? - (optional) transaction id used to trace execution through a call chain.
• connections: List<ConnectionParams> - connection parameters
• credential: CredentialParams - credential parameters
• parameters: ConfigParams - optional parameters
• returns: ConfigParams - resolved options or error.

composeOptions

A composite of several merger options

ConfigParams composeOptions(List<ConnectionParams> connections, CredentialParams credential, ConfigParams parameters)

• connections: List<ConnectionParams> - connection parameters
• credential: CredentialParams - credential parameters
• parameters: ConfigParams - optional parameters
• returns: ConfigParams - resolved options or error

configure

Configures a component by passing its configuration parameters.

@override

void configure(ConfigParams config)

• config: ConfigParams - configuration parameters to be set.

finalizeOptions

Finalize merged options. This method can be overriden in child classes.

ConfigParams finalizeOptions(ConfigParams options)

• options: ConfigParams - options: connection options
• returns: ConfigParams - finalized connection options

mergeConnection

Merges connection options with connection parameters. This method can be overriden in child classes.

ConfigParams mergeConnection(ConfigParams options, ConnectionParams connection)

• options: ConfigParams - connection options
• connection: ConnectionParams - connection parameters to be merged
• returns: ConfigParams - merged connection options.

mergeCredential

Merges connection options with credential parameters. This method can be overriden in child classes.

ConfigParams mergeCredential(ConfigParams options, CredentialParams credential)

• options: ConfigParams - connection options
• credential: CredentialParams - credential parameters to be merged
• returns: ConfigParams - merged connection options.

mergeOptional

Merges connection options with optional parameters. This method can be overriden in child classes.

ConfigParams mergeOptional(ConfigParams options, ConfigParams parameters)

• options: ConfigParams - connection options
• parameters: CredentialParams - optional parameters to be merged
• returns: ConfigParams - merged connection options.

resolve

Resolves connection options from connection and credential parameters.

Future<ConfigParams> resolve(String? correlationId)

• correlationId: String? - (optional) transaction id used to trace execution through the call chain.
• returns: Future<ConfigParams> - resolved options or error

setReferences

Sets references to dependent components.

@override

void setReferences(IReferences references)

• references: IReferences - references to locate the component dependencies.

validateConnection

Validates connection parameters. Throws error if validation failed. This method can be overriden in child classes.

void validateConnection(String? correlationId, ConnectionParams? connection)

• correlationId: String? - (optional) transaction id used to trace execution through the call chain.
• connection: ConnectionParams? - connection parameters to be validated

validateCredential

Validates credential parameters. This method can be overriden in child classes.

void validateCredential(String? correlationId, CredentialParams? credential)

• correlationId: String? - (optional) transaction id used to trace execution through the call chain.
• credential: CredentialParams - credential parameters to be validated