IBM MQ Source Connector Configuration Properties

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

connector.class=io.confluent.connect.ibm.mq.IbmMQSourceConnector

Connector-specific configuration properties are described below.

Note

These are properties for the self-managed connector. If you are using Confluent Cloud, see IBM MQ Source Connector for Confluent Cloud.

IBM MQ Connection

mq.hostname

The hostname of the IBM MQ broker.

Type: string
Importance: high

mq.port

The port of the IBM MQ broker.

Type: int
Default: 1414
Importance: high

mq.transport.type

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

Type: string
Default: client
Valid Values: [bindings, client, direct_tcpip, direct_http]
Importance: high
Dependents: mq.channel

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 distinguished name provided by the queue manager does not match this pattern.

Type: string
Default: “”
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

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 the versions are discouraged due to known security vulnerabilities.

Type: string
Default: TLSv1.2
Valid Values: [TLSv1.3, TLSv1.2, TLSv1.1, TLS, SSL, SSLv2, SSLv3]
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.

Type: string
Default: null
Importance: high

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: [hidden]
Importance: high

mq.tls.key.password

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

Type: password
Default: [hidden]
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.

Type: string
Default: null
Importance: high

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: [hidden]
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: [PKIX, SunX509]
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: [PKIX, SunX509]
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.

Type: string
Default: null
Valid Values: [PKCS11, NativePRNG, SHA1PRNG, NativePRNGBlocking, NativePRNGNonBlocking, Windows-PRNG]
Importance: low

IBM MQ Session

jms.destination.name

The name of the JMS destination (queue or topic) to read from.

Type: string
Importance: high

jms.destination.type

The type of JMS destination, which is either queue or topic.

Type: string
Default: queue
Valid Values: [queue, topic]
Importance: high

jms.subscription.durable

Whether the subscription of the connector tasks to a JMS topic is durable or not.

Type: boolean
Default: false
Importance: medium

jms.subscription.name

The name of the JMS subscription. Supported only in durable subscriptions and JMS topics.

Type: string
Default: null
Importance: medium

batch.size

The maximum number of records that a connector task may read from the JMS broker before writing to Kafka. The task holds these records until they are acknowledged in Kafka, so this may affect memory usage. The maximum batch size allowed is 10K for the IBM MQ connector, because IBM MQ allows, at most, 10K messages without acknowledgement.

Type: int
Default: 1024
Valid Values: [1,…]
Importance: low

max.pending.messages

The maximum number of messages per task that can be received from JMS brokers and produced to Kafka before the task acknowledges the JMS session/messages. If the task fails and is restarted, this is the maximum number of JMS messages the task may duplicate in Kafka. This is typically set larger than batch.size. A smaller value than batch.size limits the size of the batches.

Type: int
Default: 4096
Valid Values: [1,…]
Importance: low

max.poll.duration

The maximum amount of time each task can build a batch. The batch is closed and sent to Kafka if not enough messages are read during the time allotted. This helps limit connector lag when the JMS queue/topic has a lower throughput.

Type: int
Default: 60000
Valid Values: [1,…]
Importance: low

receiver.threads

The number of threads each task should use to consume messages from IBM MQ. Using multiple threads and fewer tasks may be more efficient than using more tasks with one thread. This is especially true in environments where the network latency from the connector to IBM MQ is high, and when most of the time receiving messages is waiting for the IBM MQ response.

Type: int
Default: 1
Valid Values: [1,…]
Importance: high

character.encoding

The character encoding to use while receiving 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

jms.message.selector

The message selector that should be applied to messages in the destination.

Type: string
Default: “”
Importance: high

jms.receive.block.duration

The maximum amount of time in milliseconds that a JMS receive call will be blocked. Setting the value helps in reducing the number of empty receive calls.

Type: long
Default: 5000
Valid Values: [5000,…,1800000]
Importance: low

Retry

max.retry.time

The maximum total time in milliseconds the connector will retry a retriable exception. This value must be at least 100 milliseconds for retry functionality to work. The default is 3600000 milliseconds (1 hour). Note that some retriable exceptions require establishing a new JMS session.

Type: long
Default: 3600000 (1 hour)
Importance: low

Kafka

kafka.topic

The name of the Kafka topic where the connector writes all records that were read from the JMS broker.

Type: string
Importance: high

Auto topic creation

For more information about Auto topic creation, see Configuring Auto Topic Creation for Source Connectors.

Configuration properties accept regular expressions (regex) that are defined as Java regex.

topic.creation.groups

A list of group aliases that are used to define per-group topic configurations for matching topics. A default group always exists and matches all topics.

Type: List of String types
Default: empty
Possible Values: The values of this property refer to any additional groups. A default group is always defined for topic configurations.

topic.creation.$alias.replication.factor

The replication factor for new topics created by the connector. This value must not be larger than the number of brokers in the Kafka cluster. If this value is larger than the number of Kafka brokers, an error occurs when the connector attempts to create a topic. This is a required property for the default group. This property is optional for any other group defined in topic.creation.groups. Other groups use the Kafka broker default value.

Type: int
Default: n/a
Possible Values: >= 1 for a specific valid value or -1 to use the Kafka broker’s default value.

topic.creation.$alias.partitions

The number of topic partitions created by this connector. This is a required property for the default group. This property is optional for any other group defined in topic.creation.groups. Other groups use the Kafka broker default value.

Type: int
Default: n/a
Possible Values: >= 1 for a specific valid value or -1 to use the Kafka broker’s default value.

topic.creation.$alias.include

A list of strings that represent regular expressions that match topic names. This list is used to include topics with matching values, and apply this group’s specific configuration to the matching topics. $alias applies to any group defined in topic.creation.groups. This property does not apply to the default group.

Type: List of String types
Default: empty
Possible Values: Comma-separated list of exact topic names or regular expressions.

topic.creation.$alias.exclude

A list of strings representing regular expressions that match topic names. This list is used to exclude topics with matching values from getting the group’s specfic configuration. $alias applies to any group defined in topic.creation.groups. This property does not apply to the default group. Note that exclusion rules override any inclusion rules for topics.

Type: List of String types
Default: empty
Possible Values: Comma-separated list of exact topic names or regular expressions.

topic.creation.$alias.${kafkaTopicSpecificConfigName}

Any of the Changing Broker Configurations Dynamically for the version of the Kafka broker where the records will be written. The broker’s topic-level configuration value is used if the configuration is not specified for the rule. $alias applies to the default group as well as any group defined in topic.creation.groups.

Type: property values
Default: Kafka broker value

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 will be discovered from the initial connection. This list should be in the form

host1:port1,host2:port2,...

Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, 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 replication factor for the Kafka topic used for Confluent Platform configuration, including licensing information. This is used only if the topic does not already exist, and the default 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.

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

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.