| // spring-boot-auto-configure options: START |
| :page-partial: |
| :doctitle: Camel Spring Boot Starter for zookeeper |
| |
| == Spring Boot Auto-Configuration |
| |
| When using zookeeper with Spring Boot make sure to use the following Maven dependency to have support for auto configuration: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.springboot</groupId> |
| <artifactId>camel-zookeeper-starter</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel core version --> |
| </dependency> |
| ---- |
| |
| |
| The component supports 57 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Type |
| | *camel.cloud.zookeeper.attributes* | Custom service attributes. | | Map |
| | *camel.cloud.zookeeper.auth-info-list* | List of AuthInfo objects with scheme and auth. | | List |
| | *camel.cloud.zookeeper.base-path* | The base path to store in ZooKeeper. | | String |
| | *camel.cloud.zookeeper.connection-timeout* | Connection timeout. | 15000 | Long |
| | *camel.cloud.zookeeper.connection-timeout-unit* | Connection timeout TimeUnit. Default is TimeUnit.MILLISECONDS. | | TimeUnit |
| | *camel.cloud.zookeeper.curator-framework* | Zookeeper CuratorFramework-style client. | | CuratorFramework |
| | *camel.cloud.zookeeper.deregister-services-on-stop* | Should we remove all the registered services know by this registry on stop ? Default is true. | true | Boolean |
| | *camel.cloud.zookeeper.enabled* | Sets if the zookeeper service registry should be enabled or not, default is false. | false | Boolean |
| | *camel.cloud.zookeeper.id* | Service Registry ID | | String |
| | *camel.cloud.zookeeper.max-close-wait* | Time to wait during close to join background threads. | 1000 | Long |
| | *camel.cloud.zookeeper.max-close-wait-unit* | MaxCloseWait TimeUnit. Default is TimeUnit.MILLISECONDS. | | TimeUnit |
| | *camel.cloud.zookeeper.namespace* | ZooKeeper namespace. If a namespace is set here, all paths will get pre-pended with the namespace. | | String |
| | *camel.cloud.zookeeper.nodes* | The Zookeeper server hosts (multiple servers can be separated by comma). | | List |
| | *camel.cloud.zookeeper.order* | Service lookup order/priority. | | Integer |
| | *camel.cloud.zookeeper.override-service-host* | Should we override the service host if given ? Default is true. | true | Boolean |
| | *camel.cloud.zookeeper.reconnect-base-sleep-time* | Initial amount of time to wait between retries. | 0 | Long |
| | *camel.cloud.zookeeper.reconnect-base-sleep-time-unit* | ReconnectBaseSleepTime TimeUnit. Default is TimeUnit.MILLISECONDS. | | TimeUnit |
| | *camel.cloud.zookeeper.reconnect-max-retries* | Max number of times to retry. | 3 | Integer |
| | *camel.cloud.zookeeper.reconnect-max-sleep-time* | Max time to sleep on each retry. Default is Integer.MAX_VALUE. | | Long |
| | *camel.cloud.zookeeper.reconnect-max-sleep-time-unit* | ReconnectMaxSleepTimeUnit TimeUnit. Default is TimeUnit.MILLISECONDS. | | TimeUnit |
| | *camel.cloud.zookeeper.retry-policy* | Retry policy to use. | | RetryPolicy |
| | *camel.cloud.zookeeper.service-host* | Service host. | | String |
| | *camel.cloud.zookeeper.session-timeout* | Session timeout. | 60000 | Long |
| | *camel.cloud.zookeeper.session-timeout-unit* | Session timeout TimeUnit. Default is TimeUnit.MILLISECONDS. | | TimeUnit |
| | *camel.cluster.zookeeper.attributes* | Custom service attributes. | | Map |
| | *camel.cluster.zookeeper.auth-info-list* | List of AuthInfo objects with scheme and auth. | | List |
| | *camel.cluster.zookeeper.base-path* | The base path to store in ZooKeeper. | | String |
| | *camel.cluster.zookeeper.connection-timeout* | Connection timeout. | 15000 | Long |
| | *camel.cluster.zookeeper.connection-timeout-unit* | Connection timeout TimeUnit. Default is TimeUnit.MILLISECONDS. | | TimeUnit |
| | *camel.cluster.zookeeper.curator-framework* | Zookeeper CuratorFramework-style client. | | CuratorFramework |
| | *camel.cluster.zookeeper.enabled* | Sets if the zookeeper cluster service should be enabled or not, default is false. | false | Boolean |
| | *camel.cluster.zookeeper.id* | Cluster Service ID | | String |
| | *camel.cluster.zookeeper.max-close-wait* | Time to wait during close to join background threads. | 1000 | Long |
| | *camel.cluster.zookeeper.max-close-wait-unit* | MaxCloseWait TimeUnit. Default is TimeUnit.MILLISECONDS. | | TimeUnit |
| | *camel.cluster.zookeeper.namespace* | ZooKeeper namespace. If a namespace is set here, all paths will get pre-pended with the namespace. | | String |
| | *camel.cluster.zookeeper.nodes* | The Zookeeper server hosts (multiple servers can be separated by comma). | | List |
| | *camel.cluster.zookeeper.order* | Service lookup order/priority. | | Integer |
| | *camel.cluster.zookeeper.reconnect-base-sleep-time* | Initial amount of time to wait between retries. | 0 | Long |
| | *camel.cluster.zookeeper.reconnect-base-sleep-time-unit* | ReconnectBaseSleepTime TimeUnit. Default is TimeUnit.MILLISECONDS. | | TimeUnit |
| | *camel.cluster.zookeeper.reconnect-max-retries* | Max number of times to retry. | 3 | Integer |
| | *camel.cluster.zookeeper.reconnect-max-sleep-time* | Max time to sleep on each retry. Default is Integer.MAX_VALUE. | | Long |
| | *camel.cluster.zookeeper.reconnect-max-sleep-time-unit* | ReconnectMaxSleepTimeUnit TimeUnit. Default is TimeUnit.MILLISECONDS. | | TimeUnit |
| | *camel.cluster.zookeeper.retry-policy* | Retry policy to use. | | RetryPolicy |
| | *camel.cluster.zookeeper.session-timeout* | Session timeout. | 60000 | Long |
| | *camel.cluster.zookeeper.session-timeout-unit* | Session timeout TimeUnit. Default is TimeUnit.MILLISECONDS. | | TimeUnit |
| | *camel.component.zookeeper.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.zookeeper.backoff* | The time interval to backoff for after an error before retrying. | 5000 | Long |
| | *camel.component.zookeeper.bridge-error-handler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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.zookeeper.configuration* | To use a shared ZooKeeperConfiguration. The option is a org.apache.camel.component.zookeeper.ZooKeeperConfiguration type. | | ZooKeeperConfiguration |
| | *camel.component.zookeeper.create* | Should the endpoint create the node if it does not currently exist. | false | Boolean |
| | *camel.component.zookeeper.create-mode* | The create mode that should be used for the newly created node | EPHEMERAL | String |
| | *camel.component.zookeeper.enabled* | Whether to enable auto configuration of the zookeeper component. This is enabled by default. | | Boolean |
| | *camel.component.zookeeper.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.zookeeper.list-children* | Whether the children of the node should be listed | false | Boolean |
| | *camel.component.zookeeper.repeat* | Should changes to the znode be 'watched' and repeatedly processed. | false | Boolean |
| | *camel.component.zookeeper.send-empty-message-on-delete* | Upon the delete of a znode, should an empty message be send to the consumer | true | Boolean |
| | *camel.component.zookeeper.timeout* | The time interval to wait on connection before timing out. | 5000 | Integer |
| |=== |
| // spring-boot-auto-configure options: END |
