Configuration Reference for IBM MQ Sink Connector for Confluent Platform

To use this connector, specify the name of the connector class in the connector.class configuration property.

connector.class=io.confluent.connect.jms.IbmMqSinkConnector

Connector-specific configuration properties are described below.

IBM MQ Connection

mq.hostname

The hostname of the IBM MQ broker.

  • Type: string
  • Importance: high
mq.port

The TCP listener port of the IBM MQ broker.

  • Type: int
  • Default: 1414
  • Importance: high
mq.username

The username to use when connecting to IBM MQ.

  • Type: string
  • Default: “”
  • Importance: high
mq.password

The password to use when connecting to IBM MQ.

  • Type: password
  • Default: [hidden]
  • Importance: high
mq.transport.type

The type of transport to use when connecting to IBM MQ.

  • Type: string
  • Default: client
  • Valid Values: one of [direct_http, bindings, client, direct_tcpip]
  • Importance: high
mq.queue.manager

The name of the queue manager.

  • Type: string
  • Importance: high
mq.channel

The channel for client connections. This is only required when mq.transport.type is set to client (the default); in other cases, it is ignored and can be set to an empty value.

  • Type: string
  • Importance: high
mq.ssl.cipher.suite

The CipherSuite for SSL connections.

  • Type: string
  • Default: “”
  • Importance: high
mq.ssl.fips.required

Whether SSL FIPS is required.

  • Type: boolean
  • Default: false
  • Importance: high
mq.ssl.peer.name

Sets a distinguished name (DN) pattern. If sslCipherSuite is set, this pattern can ensure that the correct queue manager is used. The connection attempt fails if the DN provided by the queue manager does not match this pattern.

  • Type: string
  • Default: “”
  • Importance: high
mq.destination.suppress.rfh2

Specifies whether or not to suppress or allow the inclusion of RFH2 Header.

  • Type: boolean
  • Default: false
  • Importance: low

IBM MQ Secure Connection

mq.tls.protocol

The TLS protocol version for secure connections to IBM MQ. The default is TLSv1.2, which should be fine for most cases, though the actual set of allowed values will depend on the JVM. Recent JVMs support TLSv1.3 and TLSv1.2, TLSv1.1 and TLS. Older JVMs may support SSL, SSLv2 and SSLv3, but these versions are discouraged due to known security vulnerabilities.

  • Type: string
  • Default: TLSv1.2
  • Valid Values: one of [SSLv2, SSLv3, TLSv1.3, TLSv1.2, TLSv1.1, TLS, SSL]
  • Importance: medium
mq.tls.keystore.type

The file format of the key store file. This is required only when using secure TLS communication with IBM MQ.

  • Type: string
  • Default: JKS
  • Importance: medium
mq.tls.keystore.location

The location of the key store file. This is required only when using secure TLS communication with IBM MQ.

mq.tls.keystore.password

The store password for the key store file. This is optional for client and only needed if mq.tls.keystore.location is configured.

  • Type: password
  • Default: null
  • Importance: high
mq.tls.key.password

The password of the private key used for secure TLS communication with IBM MQ.

  • Type: password
  • Default: null
  • Importance: high
mq.tls.truststore.type

The file format of the trust store file. This is required when using TLS and secure communication with IBM MQ.

  • Type: string
  • Default: JKS
  • Importance: medium
mq.tls.truststore.location

The location of the trust store file. This is required only when using secure TLS communication with IBM MQ.

mq.tls.truststore.password

The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled. This is required only when using secure TLS communication with IBM MQ.

  • Type: password
  • Default: null
  • Importance: high
mq.tls.keymanager.algorithm

The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine. This is required only when using secure TLS communication with IBM MQ.

  • Type: string
  • Default: SunX509
  • Valid Values: one of [SunX509, PKIX]
  • Importance: low
mq.tls.trustmanager.algorithm

The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine. This is required only when using secure TLS communication with IBM MQ.

  • Type: string
  • Default: PKIX
  • Valid Values: one of [SunX509, PKIX]
  • Importance: low
mq.tls.secure.random.implementation

The SecureRandom PRNG implementation to use for SSL cryptography operations. By default, tries PKCS11 implementation first. If PKCS11 is not supported, iterates through the provider and returns the first working implementation. This is required only when using secure TLS communication with IBM MQ.

JMS

jms.destination.name

The name of the JMS destination that messages are written to.

  • Type: string
  • Importance: high
jms.destination.type

The type of JMS destination.

  • Type: string
  • Default: queue
  • Valid Values: [queue, topic]
  • Importance: high
jms.forward.kafka.key

If enabled, the Kafka record key is converted to a string and forwarded on the JMSCorrelationID property of the JMS Message.

  • Type: boolean
  • Default: false
  • Importance: low
jms.forward.kafka.metadata

If enabled, metadata from the Kafka record is forwarded on the JMS Message properties. This includes the record’s topic, partition, and offset. The topic name is applied as a String property named KAFKA_TOPIC, the partition value is applied as an Int property named KAFKA_PARTITION, and the offset value is applied as a Long property named KAFKA_OFFSET.

  • Type: boolean
  • Default: false
  • Importance: low
jms.forward.kafka.headers

If enabled, Kafka record headers are added to the JMS Message as string properties.

  • Type: boolean
  • Default: false
  • Importance: low
jms.connection.max.retries

Connecting to a JMS broker may fail for multiple reasons. This determines the maximum number of times a task attempts to connect to the JMS broker.

  • Type: int
  • Default: 150
  • Valid Values: [0,…]
  • Importance: low
jms.connection.backoff.ms

Following a connection failure, this configuration parameter is the amount of time in milliseconds to wait before attempting to reconnect to the JMS broker. A value less than or equal to 0 removes the delay altogether.

  • Type: int
  • Default: 2000
  • Importance: low

JMS Formatter

jms.message.format

The format of the values on the JMS messages.

  • Type: string
  • Default: string
  • Valid Values: [string, avro, json, bytes]
  • Importance: high
  • Dependents: jms.message.format.schemas.cache.config, jms.message.format.connect.meta.data, jms.message.format.enhanced.avro.schema.support, jms.message.format.schemas.cache.size, jms.message.format.schemas.enable
character.encoding

The character encoding to use while writing the message.

  • Type: string
  • Default: UTF-8
  • Valid Values: one of [ISO-8859-1, UTF-8, UTF-16, UTF-16LE, UTF-16BE, US-ASCII]
  • Importance: low

Avro Formatter

jms.message.format.schemas.cache.config

Size of the converted schemas cache.

  • Type: int
  • Default: 128
  • Valid Values: [0,…,2048]
  • Importance: medium
jms.message.format.connect.meta.data

Toggle for enabling or disabling the connect converter so it either adds or does not add its metadata to the output schema.

  • Type: boolean
  • Default: false
  • Importance: medium
jms.message.format.enhanced.avro.schema.support

Toggle for enabling or disabling enhanced Avro schema support. Enhanced support includes enum symbol preservation and package name awareness.

  • Type: boolean
  • Default: false
  • Importance: medium

JSON Formatter

jms.message.format.schemas.cache.size

The maximum number of schemas that can be cached in the JSON formatter.

  • Type: int
  • Default: 128
  • Valid Values: [0,…,2048]
  • Importance: medium
jms.message.format.schemas.enable

Include schemas within each of the serialized values and keys.

  • Type: boolean
  • Default: false
  • Importance: medium

JMS MessageProducer

jms.producer.time.to.live.ms

Time to live (TTL) in milliseconds for messages sent to the JMS broker.

  • Type: long
  • Default: 0
  • Valid Values: [0,…,99999999900]
  • Importance: low
jms.producer.delivery.mode

The PERSISTENT delivery mode (the default) instructs the JMS provider to take extra care to ensure that a message is not lost in transit in case of a JMS provider failure. The NON_PERSISTENT delivery mode does not require the JMS provider to store the message or otherwise guarantee that it is not lost if the provider fails. Connectors using the PERSISTENT delivery mode will have lower overall throughput than those running with NON_PERSISTENT delivery mode. However, the NON_PERSISTENT delivery mode does not offer the same delivery guarantees as the PERSISTENT delivery mode.

  • Type: string
  • Default: persistent
  • Valid Values: one of [non_persistent, persistent]
  • Importance: low
jms.producer.disable.message.id

Sets whether message IDs are disabled. Since message IDs take some effort to create and increase a message’s size, some JMS providers may be able to optimize message overhead if they are given a hint that the message ID is not used by an application. JMS message Producers provide a hint to disable message ID. When a connector sets a Producer to disable message ID, the connector is indicating that it does not depend on the value of message ID for the messages it produces. These messages must either have the message ID set to null or, if the hint is ignored, the message ID must be set to its normal unique value. Message IDs are enabled by default.

  • Type: boolean
  • Default: false
  • Importance: low
jms.producer.disable.message.timestamp

Sets whether message timestamps are disabled. Since timestamps take some effort to create and increase a message’s size, some JMS providers may be able to optimize message overhead if they are given a hint that the timestamp is not used by an application. JMS message Producers provide a hint to disable timestamps. When a connector sets a Producer to disable timestamps, the connector is indicating that it does not depend on the value of timestamp for the messages it produces. These messages must either have the timestamp set to null or, if the hint is ignored, the timestamp must be set to its normal value. Message timestamps are enabled by default.

  • Type: boolean
  • Default: false
  • Importance: low

Confluent Platform license

confluent.topic.bootstrap.servers

A list of host/port pairs to use for establishing the initial connection to the Kafka cluster used for licensing. All servers in the cluster are discovered from the initial connection. This list should be in the form host1:port1,host2:port2,.... These servers are used only for the initial connection to discover the full cluster membership, which may change dynamically, so this list need not contain the full set of servers. You may want more than one, in case a server is down.

  • Type: list
  • Importance: high
confluent.topic

Name of the Kafka topic used for Confluent Platform configuration, including licensing information.

  • Type: string
  • Default: _confluent-command
  • Importance: low
confluent.topic.replication.factor

The Kafka topic replication factor used for the Confluent Platform configuration (includes licensing information). This is used only if the topic does not already exist. The default factor of 3 is appropriate for production use. If you are using a development environment with less than 3 brokers, you must set this to the number of brokers (often 1).

  • Type: int
  • Default: 3
  • Importance: low

Confluent license properties

You can put license-related properties in the connector configuration, or starting with Confluent Platform version 6.0, you can put license-related properties in the Connect worker configuration instead of in each connector configuration.

This connector is proprietary and requires a license. The license information is stored in the _confluent-command topic. If the broker requires SSL for connections, you must include the security-related confluent.topic.* properties as described below.

confluent.license

Confluent issues enterprise license keys to each subscriber. The license key is text that you can copy and paste as the value for confluent.license. A trial license allows using the connector for a 30-day trial period. A developer license allows using the connector indefinitely for single-broker development environments.

If you are a subscriber, contact Confluent Support for more information.

  • Type: string
  • Default: “”
  • Valid Values: Confluent Platform license
  • Importance: high
confluent.topic.ssl.truststore.location

The location of the trust store file.

  • Type: string
  • Default: null
  • Importance: high
confluent.topic.ssl.truststore.password

The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled.

  • Type: password
  • Default: null
  • Importance: high
confluent.topic.ssl.keystore.location

The location of the key store file. This is optional for client and can be used for two-way authentication for client.

  • Type: string
  • Default: null
  • Importance: high
confluent.topic.ssl.keystore.password

The store password for the key store file. This is optional for client and only needed if ssl.keystore.location is configured.

  • Type: password
  • Default: null
  • Importance: high
confluent.topic.ssl.key.password

The password of the private key in the key store file. This is optional for client.

  • Type: password
  • Default: null
  • Importance: high
confluent.topic.security.protocol

Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.

  • Type: string
  • Default: “PLAINTEXT”
  • Importance: medium

License topic configuration

A Confluent enterprise license is stored in the _confluent-command topic. This topic is created by default and contains the license that corresponds to the license key supplied through the confluent.license property. No public keys are stored in Kafka topics.

The following describes how the default _confluent-command topic is generated under different scenarios:

  • A 30-day trial license is automatically generated for the _confluent command topic if you do not add the confluent.license property or leave this property empty (for example, confluent.license=).
  • Adding a valid license key (for example, confluent.license=<valid-license-key>) adds a valid license in the _confluent-command topic.

Here is an example of the minimal properties for development and testing.

You can change the name of the _confluent-command topic using the confluent.topic property (for instance, if your environment has strict naming conventions). The example below shows this change and the configured Kafka bootstrap server.

confluent.topic=foo_confluent-command
confluent.topic.bootstrap.servers=localhost:9092

The example above shows the minimally required bootstrap server property that you can use for development and testing. For a production environment, you add the normal producer, consumer, and topic configuration properties to the connector properties, prefixed with confluent.topic..

License topic ACLs

The _confluent-command topic contains the license that corresponds to the license key supplied through the confluent.license property. It is created by default. Connectors that access this topic require the following ACLs configured:

  • CREATE and DESCRIBE on the resource cluster, if the connector needs to create the topic.

  • DESCRIBE, READ, and WRITE on the _confluent-command topic.

    Important

    You can also use DESCRIBE and READ without WRITE to restrict access to read-only for license topic ACLs. If a topic exists, the LicenseManager will not try to create the topic.

You can provide access either individually for each principal that will use the license or use a wildcard entry to allow all clients. The following examples show commands that you can use to configure ACLs for the resource cluster and _confluent-command topic.

  1. Set a CREATE and DESCRIBE ACL on the resource cluster:

    kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \
--add --allow-principal User:<principal> \
--operation CREATE --operation DESCRIBE --cluster

  2. Set a DESCRIBE, READ, and WRITE ACL on the _confluent-command topic:

    kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \
--add --allow-principal User:<principal> \
--operation DESCRIBE --operation READ --operation WRITE --topic _confluent-command

Override Default Configuration Properties

You can override the replication factor using confluent.topic.replication.factor. For example, when using a Kafka cluster as a destination with less than three brokers (for development and testing) you should set the confluent.topic.replication.factor property to 1.

You can override producer-specific properties by using the producer.override.* prefix (for source connectors) and consumer-specific properties by using the consumer.override.* prefix (for sink connectors).

You can use the defaults or customize the other properties as well. For example, the confluent.topic.client.id property defaults to the name of the connector with -licensing suffix. You can specify the configuration settings for brokers that require SSL or SASL for client connections using this prefix.

You cannot override the cleanup policy of a topic because the topic always has a single partition and is compacted. Also, do not specify serializers and deserializers using this prefix; they are ignored if added.