.. _activemq_sink_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.jms.ActiveMqSinkConnector 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 used when connecting to ActiveMQ. * Type: string * Default: "" * Importance: medium ``activemq.password`` The password used when connecting to ActiveMQ. * Type: password * Default: [hidden] * Importance: medium 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 |ak| 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 |ak| 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, |ak| 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 JMS message values. * Type: string * Default: string * Valid Values: one of [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`` 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 .. _activemq_sink_connector_license_config: |cp| license ^^^^^^^^^^^^^ ``confluent.topic.bootstrap.servers`` A list of host/port pairs to use for establishing the initial connection to the Kafka cluster to verify 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 |ak| topic used for |cp| configuration, including licensing information. * Type: string * Default: _confluent-command * Importance: low ``confluent.topic.replication.factor`` The |ak| topic replication factor used for the |cp| 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 ---------------------------- .. include:: ../../includes/security-info.rst .. include:: ../../includes/platform-license.rst .. include:: ../../includes/security-configs.rst .. _activemq_sink_license-topic-configuration: .. include:: ../../includes/platform-license-detail.rst .. include:: ../../includes/overriding-default-config-properties.rst