Consul
Integrate with Consul service discovery and configuration store.
What’s inside
-
Consul component, URI syntax:
consul:apiEndpoint
Please refer to the above links for usage and configuration details.
Maven coordinates
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-consul-starter</artifactId>
</dependency>Spring Boot Auto-Configuration
The starter supports 27 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
camel.component.consul.acl-token | Sets the ACL token to be used with Consul | String | |
camel.component.consul.action | The default action. Can be overridden by CamelConsulAction | String | |
camel.component.consul.autowired-enabled | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | Boolean |
camel.component.consul.block-seconds | The second to wait for a watch event, default 10 seconds | 10 | Integer |
camel.component.consul.bridge-error-handler | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | Boolean |
camel.component.consul.configuration | Consul configuration. The option is a org.apache.camel.component.consul.ConsulConfiguration type. | ConsulConfiguration | |
camel.component.consul.connect-timeout | Connect timeout | Duration | |
camel.component.consul.consistency-mode | The consistencyMode used for queries, default ConsistencyMode.DEFAULT | default | ConsistencyMode |
camel.component.consul.consul-client | The consul client to use. The option is a org.kiwiproject.consul.Consul type. | Consul | |
camel.component.consul.datacenter | The data center | String | |
camel.component.consul.enabled | Whether to enable auto configuration of the consul component. This is enabled by default. | Boolean | |
camel.component.consul.first-index | The first index for watch for, default 0. The option is a java.math.BigInteger type. | BigInteger | |
camel.component.consul.key | The default key. Can be overridden by CamelConsulKey | String | |
camel.component.consul.lazy-start-producer | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | Boolean |
camel.component.consul.near-node | The near node to use for queries. | String | |
camel.component.consul.node-meta | The comma separated node meta-data to use for queries. | String | |
camel.component.consul.password | Sets the password to be used for basic authentication | String | |
camel.component.consul.ping-instance | Configure if the AgentClient should attempt a ping before returning the Consul instance | true | Boolean |
camel.component.consul.read-timeout | Read timeout | Duration | |
camel.component.consul.recursive | Recursively watch, default false | false | Boolean |
camel.component.consul.ssl-context-parameters | SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance. The option is a org.apache.camel.support.jsse.SSLContextParameters type. | SSLContextParameters | |
camel.component.consul.tags | Set tags. You can separate multiple tags by comma. | String | |
camel.component.consul.url | The Consul agent URL | String | |
camel.component.consul.use-global-ssl-context-parameters | Enable usage of global SSL context parameters. | false | Boolean |
camel.component.consul.user-name | Sets the username to be used for basic authentication | String | |
camel.component.consul.value-as-string | Default to transform values retrieved from Consul i.e. on KV endpoint to string. | false | Boolean |
camel.component.consul.write-timeout | Write timeout | Duration |