Kafka Settings

Summary

The Kafka adapters and business hosts have the following settings:

The remaining settings are common to all business hosts. For information, see Settings for All Business Services and Settings for All Business Operations.

ClientID

(For the outbound adapter and business operation) Defines the Kafka client ID of the Producer.

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.

ExtraClassPaths

Additional Gateway class paths delimited by "|".

GroupID

(For the inbound adapter and business service) Defines the ID of the Consumer’s consumer group.

KeyCredentials

Optionally ) 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

KeyStoreCredentials

Optionally defines the InterSystems credentials which can be used to gain password-protected access to the keystore at the location specified by KeyStoreLocation.

KeyStoreLocation

Optionally specifies the file system path to the keystore which contains the keys necessary to establish an SSL/TLS connection with your Kafka broker cluster.

ReceiveSettings

An optional 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 cluster.

SASLMechanism

Specifies the SASL authentication mechanism used to authenticate the Consumer using the credentials specified by Credentials. Choose one of the following:

• PLAIN

• SCRAM-SHA-256

• SCRAM-SHA-512

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.

Topic

(For the inbound adapter and business service) Defines the Kafka topic from which to retrieve messages.

TrustStoreCredentials

Optionally defines the InterSystems credentials which can be used to gain password-protected access to the truststore at the location specified by TrustStoreLocation.

TrustStoreLocation

Optionally 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.

See Also

• Retrieving Kafka Messages from a Production

• Sending Messages to Kafka from a Production

• Using the Kafka Messaging API (for use without a production)