KafkaConnectionResolver

Resolves a Kafka connection and credential parameters, validates them and generates connection options.

Description

KafkaConnectionResolver is used to resolve Kafka connections and credential parameters, validate them and generate connection options.

Configuration parameters

  • connection(s):
    • discovery_key: (optional) 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) key to retrieve the credentials from ICredentialStore
    • username: username
    • password: user’s password

References

  • *:discovery:*:*:1.0 - (optional) IDiscovery services
  • *:credential-store:*:*:1.0 - (optional) credential stores to resolve credentials

Constructors

NewKafkaConnectionResolver

Method that creates a new instance of the connection resolver component.

NewKafkaConnectionResolver() *KafkaConnectionResolver

Fields

ConnectionResolver

Connection resolver.

ConnectionResolver: *ConnectionResolver

CredentialResolver

Credential resolver.

CredentialResolver: *CredentialResolver

Methods

Compose

Composes Kafka connection options from connection and credential parameters.

(c [*KafkaConnectionResolver]) Compose(correlationId string, connections []*ConnectionParams, credential *CredentialParams) (*ConfigParams, error)

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • connections: []*ConnectionParams - connection parameters
  • credential: *CredentialParams - credential parameters
  • returns: (*ConfigParams, error) - resolved Kafka connection options.

Configure

Configures the component by passing its configuration parameters.

(c [*KafkaConnectionResolver]) Configure(ctx context.Context, config *ConfigParams)

  • ctx: context.Context - operation context.
  • config: ConfigParams - configuration parameters to be set.

Resolve

Resolves Kafka connection options from connection and credential parameters.

(c [*KafkaConnectionResolver]) Resolve(correlationId string) (*ConfigParams, error)

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • returns: (*ConfigParams, error) - resolved Kafka connection options.

SetReferences

Sets references to dependent components.

(c [*KafkaConnectionResolver]) SetReferences(ctx context.Context,references IReferences)

  • ctx: context.Context - operation context.
  • references: IReferences - references to locate the component’s dependencies.