t_ChannelConnections_KafkaConnection

KafkaConnection

A Kafka environment specific connection.

Description Additional Kafka producer properties may be added to the sender channel's SenderProperties. For a list of these properties, see http://kafka.apache.org/documentation.html#producerconfigs. For a list of properties applicable to the ReceiverProperties, see http://kafka.apache.org/documentation.html#consumerconfigs. If your NexJ application uses the Avro format to send Kafka messages, the Kafka channel requires additional configuration. For more information, see Additional configuration for sending Avro messages in NexJ's documentation. Properties

authentication

Authentication mode: none - anonymous, basic - basic user/password, server - silent SPNEGO w/server process account.

Valid values based on“string”.
none	Log in anonymously. This is an error if Kafka server requires authorization.
basic	Authenticate using a username and password. (default)
server	Authenticate using SPNEGO silent sign-on and the server process account.
certificate	Authenticate using an X.509 certificate.

certificate : string

The Kafka sender's certificate and private key, for logging in to the remote system. Certificate must be base64-encoded PKCS #12 representation.

channel : string

Connection channel.

condition : string

The property to which the directive is applied.

The property specified here is typically set in the .environment file. It must be prefixed with "-Dnexj" if specified on the JVM command line.

Example: condition="reporting.enabled" ... reporting.enabled="true" or "-Dnexj.reporting.enabled=true"

description : string

Channel connection description.

directive : directive

A conditional directive determining the operation to apply to the property specified in "condition".

If the operation is set to "if" or "ifnot", the property can be null. "ifdef" means "if defined". "ifndef" means "if not defined". If the operation is set to either, the property must not be null.

Example: "if", "ifnot", "ifdef", "ifndef"

Valid values based on“string”.
if
ifnot
ifdef
ifndef

enabled : boolean

The default state of enablement. (default="true")

encoding : string

Character encoding for string messages. Overrides the channel setting.

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. Overrides the channel setting.

groupId : string

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

maxPollInterval : positiveInt

The maximum delay between poll requests (in ms) before the Kafka cluster considers the consumer to be failed. Overrides the channel setting.

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

maxPollRecords : positiveInt

Maximum number of records returned by a poll request Overrides the channel setting.

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

maxReceivers : integer

Maximum Kafka receiver threads per server. Overrides the channel setting.

maxSenders : integer

Maximum Kafka producers per server. Overrides the channel setting.

For unlimited producers, enter -1 as the value. Applies to sender channels only.

merged : boolean

password : password

Kafka password.

Valid values based on“string”.

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. Must not be negative. Overrides the channel setting.

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

requestTimeout : nonNegativeInt

The request timeout in ms. Overrides the channel setting.

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

secure : boolean

True to require SSL security. Defaults to secureTransport in the server configuration.

servers : string

A space-separated list of host/port pairs to use for establishing the initial connection to the Kafka cluster.

The client will make use of all available servers irrespective of which servers are specified so the list need not be exhaustive.

Example: localhost:9092

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. Overrides the channel setting.

trust : string

The X.509 certificate, or signer's certificate thereof, for the remote system. Unspecified to trust the global trust certificate, if any.

user : string

Kafka user.

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_KafkaConnection_SenderProperties [0..1] - Kafka sender properties.
- t_KafkaConnection_ReceiverProperties [0..1] - Kafka receiver properties.

Parents

t_KafkaConnection_SenderProperties
Kafka sender properties.
t_KafkaConnection_ReceiverProperties
Kafka receiver properties.

Parent topic: t_Connections_ChannelConnections

Parent topic: t_Environment_ChannelConnections