Configuration Properties

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

connector.class=io.confluent.connect.activemq.ActiveMQSourceConnector

Connector-specific configuration properties are described below.

ActiveMQ Connection

activemq.url

The URL of the ActiveMQ broker.

  • Type: string
  • Importance: high
activemq.username

The username to use when connecting to ActiveMQ.

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

The password to use when connecting to ActiveMQ.

  • Type: password
  • Default: [hidden]
  • Importance: high

ActiveMQ 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
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.

  • 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
jms.message.selector

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

  • Type: string
  • Default: “”
  • Importance: high
jms.session.acknowledge.mode

The acknowledgement mode for the JMS Session. See JMS documentation for auto, client, and dups_ok.

  • Type: string
  • Default: client
  • Valid Values: [client, auto, dups_ok]
  • Importance: medium
jms.session.transacted

Flag to determine if the session is transacted and the session completely controls. the message delivery by either committing or rolling back the session. See Connection.createSession(boolean, int) for more details.

  • Type: boolean
  • Default: true
  • Importance: low

Kafka

kafka.topic

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

  • Type: string
  • Importance: high

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 <code>host1:port1,host2:port2,…</code>. 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

Note

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, please 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. For example, confluent.topic.ssl.truststore.location=/kfkapps/Kafka/certs/MSPKI/CA1/ec_kfk_dev.ca1.cert.jks.

  • 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. For example, confluent.topic.ssl.keystore.location=/kfkapps/Kafka/certs/MSPKI/Truststore/DEV_cacerts.jks.

  • 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.

Note

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..

Overriding Default Configuration Properties

You can override the replication factor using confluent.topic.replication.factor. For example, when using an 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 confluent.topic.producer. prefix and consumer-specific properties by using the confluent.topic.consumer. prefix.

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.