IRISLIB database
KafkaClient Class Reference
Inheritance diagram for KafkaClient:
Collaboration diagram for KafkaClient:

Public Member Functions

_.Library.Status CreateTopic (_.Library.String topicName, _.Library.Integer numberOfPartitions, _.Library.TinyInt replicationFactor)
 Applicable to Kafka. More...
 
_.Library.Status DeleteTopic (_.Library.String topicName)
 Delete a Kafka Topic with the name

 
_.Library.Status UpdateAdminConfig (_.Library.String adminConfig)
 Applicable to Kafka. More...
 
_.Library.Status UpdateConsumerConfig (_.Library.String consumerConfig)
 Applicable to Kafka. More...
 
_.Library.Status UpdateProducerConfig (_.Library.String producerConfig)
 Applicable to Kafka. More...
 
- Public Member Functions inherited from Client
_.Library.Status Close ()
 Close connections and release resources.
 
_.Library.Status Connect (_.Library.String jclientClass, _.Library.String settings, _.Library.String additionalClasspaths)
 Connect to gateway and instantiate Java messaging client.
 
_.Library.Status CreateQueueOrTopic (_.Library.String queueOrTopicName, _.Library.String settings)
 Applicable to all except JMS. More...
 
_.Library.Status DeleteQueueOrTopic (_.Library.String queueOrTopicName)
 Applicable to all except JMS.
 
_.Library.Status ReceiveMessage (_.Library.String queueOrTopicName, _.Library.ListOfObjects messages, _.Library.String settings)
 Applicable to all except SNS. More...
 
_.Library.Status SendMessage (_.External.Messaging.Message message)
 Applicable to all. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Client
_.External.Messaging.Client CreateClient (_.External.Messaging.Settings settings, _.Library.Status sc, _.Library.String additionalClasspaths)
 Factory method to create an instance of messaging client. More...
 
_.External.Messaging.JMSClient CreateJMSClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
 Connects to JMS using the passed in settings JSON string. More...
 
_.External.Messaging.KafkaClient CreateKafkaClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
 Connects to Kafka using the passed in settings JSON string. More...
 
_.External.Messaging.RabbitMQClient CreateRabbitMQClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
 Connects to RabbitMQ using the passed in settings JSON string. More...
 
_.External.Messaging.SNSClient CreateSNSClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
 Connects to SNS using the passed in settings JSON string. More...
 
_.External.Messaging.SQSClient CreateSQSClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
 Connects to SQS using the passed in settings JSON string. More...
 
- Public Attributes inherited from Client
 gateway
 Connection to a Java Gateway. More...
 
 jclient
 Remote Java messaging client object. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Member Function Documentation

◆ CreateTopic()

_.Library.Status CreateTopic ( _.Library.String  topicName,
_.Library.Integer  numberOfPartitions,
_.Library.TinyInt  replicationFactor 
)

Applicable to Kafka.


Create a Kafka Topic with the name

◆ UpdateAdminConfig()

_.Library.Status UpdateAdminConfig ( _.Library.String  adminConfig)

Applicable to Kafka.


Updates the Admin Client Configurations using the passed in JSON string.
Only pass in configuratiton properties that are applicable to the Kafka's Admin Client. For possilbe admin client configuration properties, please refer to https://kafka.apache.org/documentation/#adminclientconfigs.

◆ UpdateConsumerConfig()

_.Library.Status UpdateConsumerConfig ( _.Library.String  consumerConfig)

Applicable to Kafka.


Updates the Consumer Configurations using the passed in JSON string.
Only pass in configuratiton properties that are applicable to the Kafka Consumer. For possible consumer configuration properties, please refer to https://kafka.apache.org/documentation/#consumerconfigs. Sample settings: "{\"key.deserializer":"org.apache.kafka.common.serialization.StringDeserializer"}"

◆ UpdateProducerConfig()

_.Library.Status UpdateProducerConfig ( _.Library.String  producerConfig)

Applicable to Kafka.


Updates the Producer Configurations using the passed in JSON string.
Only pass in configuratiton properties that are applicable to the Kafka Producer. For possible producer configuration properties, please refer to https://kafka.apache.org/documentation/#producerconfigs. Sample settings: "{\"key.serializer":"org.apache.kafka.common.serialization.StringSerializer"}"