-
Topic defines the Kafka topic from which the Consumer is retrieving messages.
-
GroupID defines the ID of the Consumer's consumer group.
-
ReceiveSettings (optional) a JSON string defining settings for message retrieval. The list of available settings is the same as the list of properties made available by the Kafka API KafkaReceiveSettings class, with each property name serving as the key.
-
Servers defines a comma-separated list of IP address:port entries that identify servers in the Kafka broker cluster.
-
Credentials defines the InterSystems credentials that correspond to the username and password of a Kafka client. For details on creating credentials, see Defining Reusable Items for Use in Settings.
-
SecurityProtocol specifies the security protocol which secures connections to your Kafka broker cluster. Currently, this property supports two values:
-
SASL_PLAINTEXT, which performs SASL authentication of the client over an unencrypted channel.
-
SASL_SSL, which uses the truststore and keystore information you provide to establish an SSL/TLS connection over which SASL authentication takes place.
-
SASLMechanism specifies the SASL authentication mechanism used to authenticate the Consumer using the credentials specified by Credentials. Currently, only PLAIN is supported.
-
TrustStoreLocation (optional) specifies the file system path to the truststore which contains the certificate authority certificates necessary to validate a certificate from your Kafka broker cluster and establish an SSL/TLS connection.
-
TrustStoreCredentials (optional) defines the InterSystems credentials which can be used to gain password-protected access to the truststore at the location specified by truststorelocation.
-
KeyStoreLocation (optional) specifies the file system path to the keystore which contains the keys necessary to establish an SSL/TLS connection with your Kafka broker cluster.
-
KeyStoreCredentials (optional) defines the InterSystems credentials which can be used to gain password-protected access to the keystore at the location specified by keystorelocation.
-
KeyCredentials (optional) defines the InterSystems credentials which can be used to gain password-protected access to a private key within the keystore at the location specified by keystorelocation.
For general information about building a custom business service that uses an inbound adapter, see Defining Business Services.