.. _ibmmq-source-connector-config:

Configuration Properties
------------------------

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

.. codewithvars:: properties

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

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 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 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.message.selector``
  The `message selector <http://docs.oracle.com/javaee/6/api/javax/jms/Session.html#createConsumer(javax.jms.Destination, java.lang.String, boolean)>`_ 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 <http://docs.oracle.com/javaee/6/api/javax/jms/Session.html#AUTO_ACKNOWLEDGE>`_, `client <http://docs.oracle.com/javaee/6/api/javax/jms/Session.html#CLIENT_ACKNOWLEDGE>`_, and `dups_ok <http://docs.oracle.com/javaee/6/api/javax/jms/Session.html#DUPS_OK_ACKNOWLEDGE>`_.

  * 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) <http://docs.oracle.com/javaee/6/api/javax/jms/Connection.html#createSession(boolean, int)>`_ for more details.

  * Type: boolean
  * Default: true
  * Importance: low

|ak|
^^^^

``kafka.topic``
  The name of the |ak| topic where the connector writes all records that were read from the JMS broker.

  * Type: string
  * Importance: high
  
.. _ibmmq-source-connector-license-config:

|cp| license
^^^^^^^^^^^^

``confluent.topic.bootstrap.servers``
  A list of host/port pairs to use for establishing the initial connection to the |ak| 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 |ak| 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 |ak| 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
----------------------------

.. include:: ../includes/security-info.rst

.. include:: ../includes/platform-license.rst

.. include:: ../includes/security-configs.rst

.. _ibmmq-source-license-topic-configuration:

.. include:: ../includes/platform-license-detail.rst

.. include:: ../includes/overriding-default-config-properties.rst