Namespace: OpenEdge.Messaging.Kafka
Type: Class KafkaClientBuilderUtil
Parent Classes:
Progress.Lang.Object
OpenEdge.Messaging.Kafka.KafkaClientBuilderUtil

Inherits: Progress.Lang.Object

/*
Copyright © 2021,2022 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
Purpose:
This is a utility class used by the Kafka client builders
to construct both the Consumer and Producer clients.



Method Summary
  Options Name Purpose
  ConvertAcksOption (IConfigBuilder, IStringStringMap) /* Convert acks specified as object to configuration string @param builder Configuration builder where Acks (required acknowledgements) option is stored @param config The destination map where the converted value for Acks (required acknowledgements) is stored */
  ConvertBootstrapServerOption (IConfigBuilder, IStringStringMap) /** Retrieves the bootstrap servers property and converts it to a format that librdkafka understands, and stores the result into the given configuration map. */
  ConvertSASLMechanismOption (IConfigBuilder, IStringStringMap) /** Convert SASLMechanism from enum to string if necessary. @param builder Configuration builder where SASL Mechanism option is stored @param config The destination map where the converted value for SASL Mechanism is stored */
  ConvertSecurityProtocolOption (IConfigBuilder, IStringStringMap) /* Convert security protocol enum to string appropriate for librdkafka @param builder Configuration builder where security protocol option is stored @param config The destination map where the converted value for security protocol is stored */
  CopyOptionsToBIO (IStringStringMap, IMessageClientDelegate, IOptionFilter, IOptionValidator) /** Copy options to the built-in consumer. This does not pass UNKNOWN value to kafka, rather lets Kafka keep its default value and behavior if any options that would normally go to Kafka are currently set as unknown. */
  CopyTopicOptionsToBIO (IStringKeyedMap, IMessageClientDelegate, IOptionFilter, IOptionValidator) /** Convert topic options from internal map over to BIO via the delegate */

Method Detail
Top

ConvertAcksOption (IConfigBuilder, IStringStringMap)

/*
Convert acks specified as object to configuration string
Parameters:
builder OpenEdge.Messaging.Kafka.IConfigBuilder
  Configuration builder where Acks (required acknowledgements) option is stored
config OpenEdge.Core.Collections.IStringStringMap
  The destination map where the converted value for Acks (required acknowledgements) is stored
Top

ConvertBootstrapServerOption (IConfigBuilder, IStringStringMap)

Purpose:
Retrieves the bootstrap servers property and converts it to a format that librdkafka understands,
and stores the result into the given configuration map.
Parameters:
builder OpenEdge.Messaging.Kafka.IConfigBuilder
 
config OpenEdge.Core.Collections.IStringStringMap
 
Top

ConvertSASLMechanismOption (IConfigBuilder, IStringStringMap)

Purpose:
Convert SASLMechanism from enum to string if necessary.
Parameters:
builder OpenEdge.Messaging.Kafka.IConfigBuilder
  Configuration builder where SASL Mechanism option is stored
config OpenEdge.Core.Collections.IStringStringMap
  The destination map where the converted value for SASL Mechanism is stored
Top

ConvertSecurityProtocolOption (IConfigBuilder, IStringStringMap)

/*
Convert security protocol enum to string appropriate for librdkafka
Parameters:
builder OpenEdge.Messaging.Kafka.IConfigBuilder
  Configuration builder where security protocol option is stored
config OpenEdge.Core.Collections.IStringStringMap
  The destination map where the converted value for security protocol is stored
Top

CopyOptionsToBIO (IStringStringMap, IMessageClientDelegate, IOptionFilter, IOptionValidator)

Purpose:
Copy options to the built-in consumer.
This does not pass UNKNOWN value to kafka, rather lets Kafka keep its default value
and behavior if any options that would normally go to Kafka are currently set as unknown.
Parameters:
config OpenEdge.Core.Collections.IStringStringMap
 
bioDelegate OpenEdge.Messaging.Internal.IMessageClientDelegate
 
optionFilter OpenEdge.Messaging.Kafka.IOptionFilter
 
optionValidator OpenEdge.Messaging.Kafka.IOptionValidator
 
Top

CopyTopicOptionsToBIO (IStringKeyedMap, IMessageClientDelegate, IOptionFilter, IOptionValidator)

Purpose:
Convert topic options from internal map over to BIO via the delegate
Parameters:
topicConfigurations OpenEdge.Core.Collections.IStringKeyedMap
 
messagingClientDelegate OpenEdge.Messaging.Internal.IMessageClientDelegate
 
optionFilter OpenEdge.Messaging.Kafka.IOptionFilter
 
optionValidator OpenEdge.Messaging.Kafka.IOptionValidator