EnsLib.Kafka.InboundAdapter
class EnsLib.Kafka.InboundAdapter extends EnsLib.Messaging.Common, EnsLib.PEX.InboundAdapter
Property Inventory
Method Inventory
Parameters
parameter SETTINGS = Servers:Kafka Settings,Topic:Kafka Settings,GroupID:Kafka Settings,ReceiveSettings:Kafka Settings,Credentials:Kafka Settings:credentialsSelector;
Inherited description: List of properties can be set as settings in the configuration file
format is a comma separated list of property names
Properties
property Credentials as %String (MAXLEN = 200);
This is the ID name of the set of credentials values (Username, Password) to be used to access the Kafka server.
Property methods: CredentialsDisplayToLogical(), CredentialsGet(), CredentialsIsValid(), CredentialsLogicalToDisplay(), CredentialsLogicalToOdbc(), CredentialsNormalize()
property GroupID as %String (MAXLEN = 100);
Kafka consumer group ID. Within the same group, each message is only read once.
Property methods: GroupIDDisplayToLogical(), GroupIDGet(), GroupIDIsValid(), GroupIDLogicalToDisplay(), GroupIDLogicalToOdbc(), GroupIDNormalize(), GroupIDSet()
property ReceiveSettings as %String (MAXLEN = 300);
Parameters to receive messages as JSON string
Property methods: ReceiveSettingsDisplayToLogical(), ReceiveSettingsGet(), ReceiveSettingsIsValid(), ReceiveSettingsLogicalToDisplay(), ReceiveSettingsLogicalToOdbc(), ReceiveSettingsNormalize(), ReceiveSettingsSet()
property Servers as %String (MAXLEN = 200) [ InitialExpression = "localhost:9092" ];
Kafka server host and port.
Property methods: ServersDisplayToLogical(), ServersGet(), ServersIsValid(), ServersLogicalToDisplay(), ServersLogicalToOdbc(), ServersNormalize(), ServersSet()
property Topic as %String (MAXLEN = 100);
Topic that the messages are read from.
Property methods: TopicDisplayToLogical(), TopicGet(), TopicIsValid(), TopicLogicalToDisplay(), TopicLogicalToOdbc(), TopicNormalize(), TopicSet()
Methods
method OnInit() as %Status
Inherited description: This user callback method is called just after %OnNew()
Inherited Members
Inherited Properties
- %CredentialsObj
- %WarnedLatest
- %gatewayConnection
- %gatewayExtraClasspaths
- %gatewayHost
- %gatewayName
- %gatewayPort
- %gatewayProxy
- %gatewayTimeout
- %remoteClassname
- %remoteSettings
- BusinessHost
- CallInterval
- ExtraClasspaths
- KeepaliveInterval
- RegistryID
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- AssignOneSetting()
- CheckGatewayConnection()
- CheckGatewayDisconnection()
- ClearAllAppData()
- ClearRuntimeAppData()
- ClearStaticAppData()
- Connect()
- CredentialsSet()
- Disconnect()
- EnumerateSettingsClose()
- EnumerateSettingsExecute()
- EnumerateSettingsFetch()
- GetMessagingClientJARPaths()
- GetSettings()
- OnGetConnections()
- OnKeepalive()
- OnTask()
- OnTearDown()
- SetPropertyValues()
- deserialize()
- dispatchSendRequestAsync()
- dispatchSendRequestSync()
- getCredentials()
- serialize()