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) a 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) 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 ICredentialStore

Fields

Instance methods

compose

Composes Composite connection options from connection and credential parameters.

compose(correlation_id: Optional[str], connections: List[ConnectionParams], credential: CredentialParams, parameters: ConfigParams): ConfigParams

• correlation_id: Optional[str] - (optional) transaction id 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.

_compose_options

A composite of several merger options

_compose_options(connections: List[ConnectionParams], credential: CredentialParams, parameters: ConfigParams): ConfigParams

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

configure

Configures component by passing configuration parameters.

configure(config: ConfigParams)

• config: ConfigParams - configuration parameters to be set.

_finalize_options

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

_finalize_options(options: ConfigParams): ConfigParams

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

_merge_connection

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

_merge_connection(options: ConfigParams, connection: ConnectionParams): ConfigParams

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

_merge_credential

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

_merge_credential(options: ConfigParams, credential: CredentialParams): ConfigParams

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

_merge_optional

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

_merge_optional(options: ConfigParams, parameters: ConfigParams): ConfigParams

• 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.

resolve(correlation_id: Optional[str]): ConfigParams

• correlation_id: Optional[str] - (optional) transaction id to trace execution through call chain.
• returns: ConfigParams - resolved options or error

set_references

Sets references to dependent components.

set_references(references: IReferences)

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

_validate_connection

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

_validate_connection(correlation_id: Optional[str], connection: ConnectionParams)

• correlation_id: Optional[str] - (optional) transaction id to trace execution through a call chain.
• connection: ConnectionParams - connection parameters to be validated

_validate_credential

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

_validate_credential(correlation_id: Optional[str], credential: CredentialParams)

• correlation_id: Optional[str] - (optional) transaction id to trace execution through call chain.
• credential: CredentialParams - credential parameters to be validated