# Configuration Reference for Solace Sink Connector for Confluent Platform To use this connector, specify the name of the connector class in the `connector.class` configuration property. ```properties connector.class=io.confluent.connect.jms.SolaceSinkConnector ``` Connector-specific configuration properties are described below. #### NOTE These are properties for the self-managed connector. If you are using Confluent Cloud, see [Solace Sink Connector for Confluent Cloud](/cloud/current/connectors/cc-solace-sink.html). ## Solace Connection `solace.host` : This property specifies the IP or hostname and port (optional) of the message broker to connect to. If a port is not specified, the default port number is 55555 when compression is not in use, or 55003 when compression is in use. To specify a prioritized list of hosts that the connector can attempt to connect to, list each host, in order of importance, separated by a comma. Additional details can be found in the [Solace Documentation](https://docs.solace.com/Solace-JMS-API/Data-Connection-Properti.htm#Host).
* Type: string * Importance: high `solace.username` : The username used when connecting to Solace.
* Type: string * Default: “” * Importance: high `solace.password` : The password used when connecting to Solace.
* Type: password * Default: [hidden] * Importance: medium `solace.vpn` : This property specifies the Message VPN to use when connecting to the message broker. This property applies to both the JNDI and data connections. The default value is blank, which means connect to the Message VPN `default`.
* Type: string * Default: “” * Importance: medium `solace.connect.retries` : This property specifies the maximum number of times to attempt a data connection if the first connect fails. If this value is -1 or greater than 1, and a host list is used, each connect retry traverses the host list according to the value set for the Connect Retries property. Valid values are -1 through 2147483647. 0 means do not perform any automatic connection retries (that is, try once and give up); –1 means retry forever.
* Type: int * Default: 0 * Valid Values: [-1,…,2147483647] * Importance: medium `solace.connect.retries.per.host` : When using a list of hosts for the `solace.host` property, this property defines how many times to retry a data connection to a single host before moving on to the next host in the list. Valid values are -1 through 2147483647. 0 means do not perform any automatic connection retries (that is, try once and give up); –1 means retry forever (that is, the API only tries to connect or reconnect to first host listed.)
* Type: int * Default: 0 * Valid Values: [-1,…,2147483647] * Importance: medium `solace.connect.timeout` : This property specifies the maximum amount of time (in milliseconds) permitted for a data connection attempt. Valid values are 0 through 2147483647. 0 means wait forever.
* Type: int * Default: 3000 * Valid Values: [0,…,2147483647] * Importance: medium `solace.reconnect.retries` : This property specifies the number of times to attempt to reconnect once the data connection to a message broker is lost. When a host list of message brokers is provided, and no connection is reestablished to any of the hosts, the API can reattempt connecting to the listed hosts again, starting with the first host listed. Each time the API works through the host list, without establishing a reconnection, is considered a reconnect retry.
For example, if a Reconnect Retries value of two is used, the API could possibly work through all of the listed hosts without reconnecting to them three times: one time through for the initial connect attempt, and then two times through for reconnect retries. After each unsuccessful attempt to reconnect to a host, the API waits for the amount of time set for Reconnect Retry Wait property before attempting another reconnection to a host. It should be noted that the number times to attempt to reconnect to one host before moving on to the next listed host is determined by the value set for the Connection Retries Per Host property. Valid values are 0 through 2147483647. -1 means retry forever.
* Type: int * Default: 3 * Valid Values: [-1,…,2147483647] * Importance: medium `solace.reconnect.retry.wait` : If a connect or reconnect attempt to a host is not successful, the API waits the amount of time (in milliseconds) set for this property, and then makes another connect or reconnect attempt. When using a list of hosts for the Broker URL property, the Connect Retries Per Host property sets how many connection or reconnection attempts can be made before moving on to the next host in the list. Valid values are 0 through 60,000. 0 means do not wait.
* Type: int * Default: 3000 * Valid Values: [0,…,60000] * Importance: medium `solace.compression.level` : This property is used to enable and specify the ZLIB compression level. Valid values for the compression level are -1 through 9. -1 means use the JNDI connection’s compression level. 0 means use no compression. 1 through 9 enables data compression (where 1 offers the least amount of compression and fastest data throughput, and 9 offers the most compression and slowest data throughput). By default, Solace expects SMF compressed data (compression levels 1-9) to be sent to port `55003`.
* Type: int * Default: -1 * Valid Values: [-1,…,9] * Importance: medium `solace.dynamic.durables` : This property specifies whether queues or topic endpoints (which are used to support durable subscription names), are to be created on the message broker when the corresponding `Session.createDurableSubscriber()` or `Session.createQueue()` is called.
* Type: boolean * Default: false * Importance: low `solace.client.description` : This property specifies the application description on the message broker for the data connection.
* Type: string * Default: Kafka Connect * Importance: low ## Solace Secure Connection `solace.ssl.keystore.path` : Keystore path of SSL-enabled VPN for Solace.
* Type: string * Default: “” * Importance: medium `solace.ssl.keystore.password` : Keystore path password for SSL-enabled VPN for Solace.
* Type: password * Default: [hidden] * Importance: medium `solace.ssl.truststore.path` : Truststore path of SSL-enabled VPN for Solace.
* Type: string * Default: “” * Importance: medium `solace.ssl.truststore.password` : Truststore path password for SSL-enabled VPN for Solace.
* Type: password * Default: [hidden] * Importance: medium `solace.ssl.validate.certificate` : Sets the settings to validate the SSL certificates.
* Type: boolean * Default: false * 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 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 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` `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 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 ## CSFLE and CSPE configurations `csfle.enabled` Accepts a boolean value. CSFLE is enabled for the connector if `csfle.enabled` is set to True. * Type: boolean * Default: False `auto.register.schemas` Specifies if the Serializer should attempt to register the Schema with Schema Registry. * Type: boolean * Default: true * Importance: medium `use.latest.version` Only applies when `auto.register.schemas` is set to false. If `auto.register.schemas` is set to false and `use.latest.version` is set to true, then instead of deriving a schema for the object passed to the client for serialization, Schema Registry uses the latest version of the schema in the subject for serialization. * Type: boolean * Default: true * Importance: medium ## 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:
```text 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 in license-related properties in the [Connect worker configuration](https://docs.confluent.io/kafka-connectors/self-managed/license.html#centralized-license-in-the-kconnect-long-worker) 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=`) 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. ```none 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](/platform/current/kafka/authorization.html#acl-wildcard-principals) 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: ```none kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \ --add --allow-principal User: \ --operation CREATE --operation DESCRIBE --cluster ``` 2. Set a DESCRIBE, READ, and WRITE ACL on the `_confluent-command` topic: ```none kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \ --add --allow-principal User: \ --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.