Connector Configuration

Providing Configuration

For information about about how the connector detects configuration properties, see Spring Boot: Externalized Configuration.

Converting Canonical Spring Property Names to Environment Variables

For information about converting the Spring property names to environment variables, see the Spring documentation.

Spring Profiles

If multiple configuration files exist within the same configuration directory for use in different environments (development, production, etc.), use Spring profiles.

Using Spring profiles allow you to define different application property files under the same directory using the filename format, application-{profile}.yml.

For example:

application.yml: The properties in non-specific files that always apply. Its properties are overridden by the properties defined in profile-specific files.
application-dev.yml: Defines properties specific to the development environment.
application-prod.yml: Defines properties specific to the production environment.

Individual profiles can then be enabled by setting the spring.profiles.active property. See Spring Boot: Profile-Specific Files for more information and an example.

Configuring Locations to Find Spring Property Files

By default, the connector detects any Spring property files as described in the Spring Boot’s default locations.

If you want to add additional locations, add --spring.config.additional-location=file:<custom-config-dir>.
If you want to exclusively use the locations that you’ve defined and ignore Spring Boot’s default locations, add --spring.config.location=optional:classpath:/,optional:classpath:/config/,file:<custom-config-dir>.

For example of the command to add additional locations, see Quick Start: Running the Connector Using the Command Line.

For more information about configuring locations to find Sprint property files, see Spring Boot documentation.

If you want configuration files for multiple, different connectors within the same config directory for use in different environments (such as, development, production, etc.), we recommend that you use Spring Boot Profiles instead of child directories. For example:

Set up your configuration like this:
- config/application-prod.yml
- config/application-dev.yml
Do not do this:
- config/prod/application.yml
- config/dev/application.yml

Child directories are intended to be used for merging configuration from multiple sources of confiugration properties. For more information and an example of when you might want to use multiple child directories to compose your application’s configuration, see the Spring Boot documentation.

Obtaining Build Information

Build information that includes the version, build date, time, and description is enabled by default using the Spring Boot Actuator Info Endpoint. By default, a connector only shares information related to its build.

The following example shows the structure of the output data:

{
"build": {
"version": "<connector version>",
"artifact": "<connector artifact>",
"name": "<connector name>",
"time": "<connector build time>",
"group": "<connector group>",
"description": "<connector description>",
"support": "<support information>"
}
}

If you want to exclude build data from the output of the info endpoint, set management.info.build.enabled to false.

Alternatively, if you want to disable the info endpoint entirely, you can remove info from the list of endpoints specified in management.endpoints.web.exposure.include.

Spring Configuration Options

This connector packages many libraries for you to customize functionality. Here are some references to get started:

Azure Service Bus Binder Configuration Options

The following properties are available at the Azure Service Bus binder level. These properties are to be prefixed with spring.cloud.stream.servicebus.bindings.<inputname>.producer. for output bindings and spring.cloud.stream.servicebus.bindings.<outputname>.consumer. for input bindings.

Azure Service Bus Producer Configuration Options

The following configuration options are available for the Azure Service Bus producers.

Config Option	Type	Valid Values	Default Values	Description
`entity-type`	`String`	`topic`	`topic`	The type of Azure Service Bus entity to produce messages to. Currently, only topics are supported.

Azure Service Bus Consumer Configuration Options

The following configuration options are available for the Azure Service Bus consumers.

Config Option	Type	Valid Values	Default Values	Description
`entity-type`	`String`	`topic`	`topic`	The type of Azure Service Bus entity to consume messages from. Currently, only topics are supported.
`auto-complete`	`boolean`	`[true/false]`	`false`	As default (`false`), the message is acknowledged only after being successfully produced to the PubSub+ event broker. When set to true, messages are automatically completed after retrieval.

Solace recommends keeping auto-complete to false as the default. If set to true, messages are acknowledged upon retrieval (when removed from the Azure Endpoint). This could lead to message loss if the connector malfunctions.

Advanced Configuration

In addition to the basic configuration options, the Azure Service Bus binder allows for more advanced configurations to fine-tune your application’s interaction with Azure Service Bus. For more information, see Spring Cloud Stream Binder for Azure Service Bus Configuration.

Connector Configuration Options

The following table lists the configuration options. The following options in Config Option are prefixed with solace.connector.:

Config Option	Type	Valid Values	Default Value	Description
`management.leader- election.fail-over.max-attempts`	`int`	`> 0`	`3`	The maximum number of attempts to perform a fail-over.
`management.leader- election.fail-over.back-off-initial-interval`	`long`	`> 0`	`1000`	The initial interval (milliseconds) to back-off when retrying a fail-over.
`management.leader- election.fail-over.back-off-max-interval`	`long`	`> 0`	`10000`	The maximum interval (milliseconds) to back-off when retrying a fail-over.
`management.leader-election.fail-over.back- off-multiplier`	`double`	`>= 1.0`	`2.0`	The multiplier to apply to the back-off interval between each retry of a fail-over.
`management.leader- election.mode`	`enum`	`(standalone\|active_active\| active_standby)`	`standalone`	The connector’s leader election mode. standalone: A single instance of a connector without any leader election capabilities. active_active: A participant in a cluster of connector instances where all instances are active. active_standby: A participant in a cluster of connector instances where only one instance is active (i.e. the leader), and the others are standby.
`management.queue`	`string`	`any`	`null`	The management queue name.
`management.session.*`		See Spring Boot Auto-Configuration for the Solace Java API		Defines the management session. This has the same interface as that used by `solace.java.*`. See Spring Boot Auto-Configuration for the Solace Java API for more information.
`security.enabled`	`boolean`	`(true\|false)`	`true`	If `true`, security is enabled. Otherwise, anyone has access to the connector’s endpoints.
`security.users[<index>].name`	`string`	any	null	The name of the user.
`security.users[<index>].password`	`string`	any	null	The password for the user.
`security.users[<index>].roles`	`list<string>`	admin	empty list (i.e. read- only)	The list of roles that the specified user has. It has read-only access if no roles are returned.

Workflow Configuration Options

These configuration options are defined under the following prefixes:

solace.connector.workflows.<workflow-id>.: If the options support per-workflow configuration and the default prefixes.
solace.connector.default.workflow.: If the options support default workflow configuration.

Config Option	Applicable Scopes	Type	Valid Values	Default Value	Description
`enabled`	Per-Workflow	`boolean`	`(true\|false)`	`false`	If `true`, the workflow is enabled.
`transform-headers.expressions`	Per-Workflow Default	`Map<string,string>`	Key: A header name. Value: A SpEL string that accepts `headers` as parameters.	`empty map`	A mapping of header names to header value SpEL expressions. The SpEL context contains the headers parameter that can be used to read the input message’s headers.
`acknowledgment.publish-async`	Per- Workflow Default	`boolean`	`(true\|false)`	`false`	If `true`, publisher acknowledgment processing is done asynchronously. The workflow’s consumer and producer bindings must support this mode, otherwise the publisher acknowledgments are processed synchronously regardless of this setting.
`acknowledgment.back- pressure-threshold`	Per-Workflow Default	`int`	`>= 1`	`255`	The maximum number of outstanding messages with unresolved acknowledgments. Message consumption is paused when the threshold is reached to allow for producer acknowledgments to catch up.
`acknowledgment.publish-timeout`	Per-Workflow Default	`int`	`>= -1`	`600000`	The maximum amount of time (in milliseconds) to wait for asynchronous publisher acknowledgments before considering a message as failed. A value of `-1` means to wait indefinitely for publisher acknowledgments.

Provide feedback