pip_services3_kafka.connect.KafkaConnectionResolver module

class pip_services3_kafka.connect.KafkaConnectionResolver.KafkaConnectionResolver

Bases: pip_services3_commons.refer.IReferenceable.IReferenceable, pip_services3_commons.config.IConfigurable.IConfigurable

Helper class that resolves Kafka 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 connection

  • *:credential-store:*:*:1.0 (optional) Credential stores to resolve credentials

compose(correlation_id: Optional[str], connections: List[pip_services3_components.connect.ConnectionParams.ConnectionParams], credential: pip_services3_components.auth.CredentialParams.CredentialParams) → Any

Composes Kafka connection options from connection and credential parameters.

Parameters

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

  • connections – connection parameters

  • credential – credential parameters

Returns

resolved Kafka connection options.

configure(config: pip_services3_commons.config.ConfigParams.ConfigParams)

Configures component by passing configuration parameters.

Parameters

config – configuration parameters to be set.

resolve(correlation_id: Optional[str]) → pip_services3_commons.config.ConfigParams.ConfigParams

Resolves Kafka connection options from connection and credential parameters.

Parameters

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

Returns

resolved Kafka connection options.

set_references(references: pip_services3_commons.refer.IReferences.IReferences)

Sets references to dependent components.

Parameters

references – references to locate the component dependencies.