Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsLib] >  [Kafka] >  [InboundAdapter]
Private  Storage   

class EnsLib.Kafka.InboundAdapter extends EnsLib.Messaging.Common, EnsLib.Kafka.Common, EnsLib.PEX.InboundAdapter

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 3 1


Summary

Properties
%CredentialsObj %WarnedLatest %gatewayConnection %gatewayExtraClasspaths
%gatewayHost %gatewayName %gatewayPort %gatewayProxy
%gatewayTimeout %remoteClassname %remoteSettings BusinessHost
CallInterval Credentials ExtraClasspaths GroupID
KeepaliveInterval KeyCredentials KeyStoreCredentials KeyStoreLocation
ReceiveSettings RegistryID SASLMechanism SecurityProtocol
Servers Topic TrustStoreCredentials TrustStoreLocation

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 OnInit
OnKeepalive OnTask OnTearDown SetPropertyValues
deserialize dispatchSendRequestAsync dispatchSendRequestSync getCredentials
serialize


Parameters

• parameter SETTINGS = "Topic:Kafka Settings,GroupID:Kafka Settings,ReceiveSettings:Kafka Settings";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property GroupID as %String(MAXLEN=100);
Kafka consumer group ID. Within the same group, each message is only read once.
• property ReceiveSettings as %String(MAXLEN=300);
Parameters to receive messages as JSON string
• property Topic as %String(MAXLEN=100);
Topic that the messages are read from.

Methods

• method OnInit() as %Status
This user callback method is called just after %OnNew()


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.