Skip to main content

EnsLib.Kafka.Common

abstract class EnsLib.Kafka.Common extends %Library.RegisteredObject

Property Inventory

Parameters

parameter SETTINGS = Servers:Kafka Settings,Credentials:Kafka Settings:credentialsSelector,SecurityProtocol:Kafka Settings,SASLMechanism:Kafka Settings,TrustStoreLocation:Kafka Settings,TrustStoreCredentials:Kafka Settings:credentialsSelector,KeyStoreLocation:Kafka Settings,KeyStoreCredentials:Kafka Settings:credentialsSelector,KeyCredentials:Kafka Settings:credentialsSelector;

Properties

property Credentials as %String (MAXLEN = 200);
This is the ID name of the set of credentials values (Username, Password) used to access the Kafka server.
Property methods: CredentialsDisplayToLogical(), CredentialsGet(), CredentialsIsValid(), CredentialsLogicalToDisplay(), CredentialsLogicalToOdbc(), CredentialsNormalize(), CredentialsSet()
property KeyCredentials as %String (MAXLEN = 200);
Credentials ID containing key password
Property methods: KeyCredentialsDisplayToLogical(), KeyCredentialsGet(), KeyCredentialsIsValid(), KeyCredentialsLogicalToDisplay(), KeyCredentialsLogicalToOdbc(), KeyCredentialsNormalize(), KeyCredentialsSet()
property KeyStoreCredentials as %String (MAXLEN = 200);
Credentials ID containing key store password
Property methods: KeyStoreCredentialsDisplayToLogical(), KeyStoreCredentialsGet(), KeyStoreCredentialsIsValid(), KeyStoreCredentialsLogicalToDisplay(), KeyStoreCredentialsLogicalToOdbc(), KeyStoreCredentialsNormalize(), KeyStoreCredentialsSet()
property KeyStoreLocation as %String (MAXLEN = 200);
Key store location
Property methods: KeyStoreLocationDisplayToLogical(), KeyStoreLocationGet(), KeyStoreLocationIsValid(), KeyStoreLocationLogicalToDisplay(), KeyStoreLocationLogicalToOdbc(), KeyStoreLocationNormalize(), KeyStoreLocationSet()
property SASLMechanism as %String (DISPLAYLIST = ",PLAIN,SCRAM-SHA-256,SCRAM-SHA-512", VALUELIST = ",PLAIN,SCRAM-SHA-256,SCRAM-SHA-512") [ InitialExpression = "PLAIN" ];
SASL mechanism
Posssible values: GSSAPI,PLAIN,SCRAM-SHA-256,SCRAM-SHA-512,OAUTHBEARER
Supported mechanism: PLAIN,SCRAM-SHA-256,SCRAM-SHA-512
Property methods: SASLMechanismDisplayToLogical(), SASLMechanismGet(), SASLMechanismIsValid(), SASLMechanismLogicalToDisplay(), SASLMechanismLogicalToOdbc(), SASLMechanismNormalize(), SASLMechanismSet()
property SecurityProtocol as %String (DISPLAYLIST = ",PLAINTEXT,SSL,SASL_PLAINTEXT,SASL_SSL", VALUELIST = ",PLAINTEXT,SSL,SASL_PLAINTEXT,SASL_SSL") [ InitialExpression = "PLAINTEXT" ];
Security protocol between Kafka client and broker
Supported protocol: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL
Property methods: SecurityProtocolDisplayToLogical(), SecurityProtocolGet(), SecurityProtocolIsValid(), SecurityProtocolLogicalToDisplay(), SecurityProtocolLogicalToOdbc(), SecurityProtocolNormalize(), SecurityProtocolSet()
property Servers as %String (MAXLEN = 1000) [ InitialExpression = "localhost:9092" ];
Kafka server host and port.
Property methods: ServersDisplayToLogical(), ServersGet(), ServersIsValid(), ServersLogicalToDisplay(), ServersLogicalToOdbc(), ServersNormalize(), ServersSet()
property TrustStoreCredentials as %String (MAXLEN = 200);
Credentials ID containing trust store password
Property methods: TrustStoreCredentialsDisplayToLogical(), TrustStoreCredentialsGet(), TrustStoreCredentialsIsValid(), TrustStoreCredentialsLogicalToDisplay(), TrustStoreCredentialsLogicalToOdbc(), TrustStoreCredentialsNormalize(), TrustStoreCredentialsSet()
property TrustStoreLocation as %String (MAXLEN = 200);
Trust store location
Property methods: TrustStoreLocationDisplayToLogical(), TrustStoreLocationGet(), TrustStoreLocationIsValid(), TrustStoreLocationLogicalToDisplay(), TrustStoreLocationLogicalToOdbc(), TrustStoreLocationNormalize(), TrustStoreLocationSet()

Inherited Members

Inherited Methods

Subclasses

FeedbackOpens in a new tab