This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git
The following commit(s) were added to refs/heads/main by this push:
new 7d3c78f Add missing doc
7d3c78f is described below
commit 7d3c78f783226cc1b052938789b81b66c08fe490
Author: Claus Ibsen <[email protected]>
AuthorDate: Fri Aug 6 17:30:03 2021 +0200
Add missing doc
---
.../src/main/docs/disruptor-vm-starter.adoc | 48 ++++++++++++++++++++++
1 file changed, 48 insertions(+)
diff --git
a/components-starter/camel-disruptor-starter/src/main/docs/disruptor-vm-starter.adoc
b/components-starter/camel-disruptor-starter/src/main/docs/disruptor-vm-starter.adoc
new file mode 100644
index 0000000..df2cf00
--- /dev/null
+++
b/components-starter/camel-disruptor-starter/src/main/docs/disruptor-vm-starter.adoc
@@ -0,0 +1,48 @@
+// spring-boot-auto-configure options: START
+:page-partial:
+:doctitle: Camel Spring Boot Starter for disruptor
+
+== Spring Boot Auto-Configuration
+
+When using disruptor 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-disruptor-starter</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+----
+
+
+The component supports 20 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *camel.component.disruptor-vm.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.disruptor-vm.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.disruptor-vm.buffer-size* | To configure the ring buffer
size | 1024 | Integer
+| *camel.component.disruptor-vm.default-block-when-full* | To configure the
default value for block when full The default value is true. | true | Boolean
+| *camel.component.disruptor-vm.default-concurrent-consumers* | To configure
the default number of concurrent consumers | 1 | Integer
+| *camel.component.disruptor-vm.default-multiple-consumers* | To configure the
default value for multiple consumers | false | Boolean
+| *camel.component.disruptor-vm.default-producer-type* | To configure the
default value for DisruptorProducerType The default value is Multi. | |
DisruptorProducerType
+| *camel.component.disruptor-vm.default-wait-strategy* | To configure the
default value for DisruptorWaitStrategy The default value is Blocking. | |
DisruptorWaitStrategy
+| *camel.component.disruptor-vm.enabled* | Whether to enable auto
configuration of the disruptor-vm component. This is enabled by default. | |
Boolean
+| *camel.component.disruptor-vm.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 process [...]
+| *camel.component.disruptor.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.disruptor.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.disruptor.buffer-size* | To configure the ring buffer size
| 1024 | Integer
+| *camel.component.disruptor.default-block-when-full* | To configure the
default value for block when full The default value is true. | true | Boolean
+| *camel.component.disruptor.default-concurrent-consumers* | To configure the
default number of concurrent consumers | 1 | Integer
+| *camel.component.disruptor.default-multiple-consumers* | To configure the
default value for multiple consumers | false | Boolean
+| *camel.component.disruptor.default-producer-type* | To configure the default
value for DisruptorProducerType The default value is Multi. | |
DisruptorProducerType
+| *camel.component.disruptor.default-wait-strategy* | To configure the default
value for DisruptorWaitStrategy The default value is Blocking. | |
DisruptorWaitStrategy
+| *camel.component.disruptor.enabled* | Whether to enable auto configuration
of the disruptor component. This is enabled by default. | | Boolean
+| *camel.component.disruptor.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 [...]
+|===
+// spring-boot-auto-configure options: END
