Kafka

Kafka

A Kafka Integration Channel.

Description Kafka channels are bound to concrete physical communication addresses and other communication parameters through Connections, with which applications are deployed. Properties

acknowledgement

Valid values based on“string”.
auto	Wait for a server acknowledgement after sending a message.
lazy	Defer the message acknowledgement until the transaction is committed.

category : string

The category of the channel.

combine

Resolution algorithm for multiple bound services processing the same message. (Default none - meaning multiple services with the same message is not supported)

Valid values based on“string”.
none	Multiple services declaring the same message in their associated Interface Request messages are not supported. (Default)
first	Only the first one among the bound services with a matching message in their Interface Request messages is invoked.
all	All the services with a matching message in their Interface Request messages are invoked. When multiple services are bound to a channel and a message is forwarded to more than one of those services, the initial "this" variable in those services refers to the same object. This should be taken into account if the original message object can be updated in any of the services – you might want to modify a copy of the message instead.

defaultUser : string

User account for processing the Kafka messages.

description : string

Channel description.

encoding : string

Character set for serializing/deserialzing string messages.

Example

UTF-8

errorTopic : string

The topic to send messages that encounter an error. Send must be enabled if specified. If left unspecified, a message will be logged on error level during failed message processing.

groupId : string

The consumer group id. Defaults to <namespace>:<model name>:<channel name> if unspecified.

idle : boolean

True to disable the channel if it is not used by an enabled channel.

latestReset : boolean

Kafka consumer setting that specifies what to do when there is no initial offset in Kafka or if the current offset does not exist anymore on the server (e.g. because that data has been deleted). true: automatically reset the offset to the latest offset. false: automatically reset the offset to the earliest offset.

maxPollInterval : positiveInt

The maximum delay between poll requests (in ms) before the Kafka cluster considers this consumer as failed.

Valid values based on“int”.
1 (minInclusive)

maxPollRecords : positiveInt

Maximum number of records returned by a poll request.

Valid values based on“int”.
1 (minInclusive)

maxReceivers : positiveInt

Maximum Kafka receiver threads per server.

Valid values based on“int”.
1 (minInclusive)

maxSenders : integer

Maximum Kafka producers per server, -1 for unlimited.

pollTimeout : nonNegativeInt

The time, in milliseconds, spent waiting in poll if data is not available in the buffer. If 0, returns immediately with any records that are available currently in the buffer, else returns empty.

Valid values based on“int”.
0 (minInclusive)

receive : boolean

True if the channel can receive messages.

requestTimeout : nonNegativeInt

The request timeout in ms.

Valid values based on“int”.
0 (minInclusive)

send : boolean

True if the channel can send messages.

stealth : boolean

True to supress the debug logging, unless nexj.system.core.meta.integration.Channel.<name> category dump logging is enabled.

subjectStrategy : string

Name of class which derives Avro subject name. One of RecordNameStrategy, TopicNameStrategy, TopicRecordNameStrategy, or the fully qualified name of a class that implements nexj.core.rpc.kafka.KafkaAvroSubjectNameStrategy.

test : boolean

Indicates if the test Kafka channel should be loaded.

topic : string

Sending: the topic to send to. Receiving: space-separated list of topics to receive from. If used for both sending and receiving, the first topic on the list is the topic that messages are sent to and receives messages from all the topics in the list, including the first one.

warningTimeout : nonNegativeLong

Timeout in milliseconds before a warning is generated, 0 for infinite timeout.

Valid values based on“long”.
0 (minInclusive)

Content

• Sequence of:

  • t_Channel_SenderProperties [0..1]

  • t_Channel_ReceiverProperties [0..1]

  • t_Channel_ServiceBindings [0..1] - Services bound to the incomming traffic on the channel.

• t_Channel_SenderProperties
  

• t_Channel_ReceiverProperties
  

• t_Channel_ServiceBindings
  Services bound to the incomming traffic on the channel.

Parent topic: references