[camel-kafka-connector] 02/04: Revert "Removed documentation for bean connector"

[ac...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

acosentino pushed a commit to branch silly-me
in repository https://gitbox.apache.org/repos/asf/camel-kafka-connector.git

commit 0cd002d4c0033209b1c4fdc3a7eafb651d60458b
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Thu Sep 24 06:56:50 2020 +0200

    Revert "Removed documentation for bean connector"
    
    This reverts commit bc82a7879ce7d1f9cc8ccfaf0ec4a0965c10faeb.
---
 .../camel-bean-kafka-sink-connector.adoc           | 61 ++++++++++++++++++++++
 1 file changed, 61 insertions(+)

diff --git a/docs/modules/ROOT/pages/connectors/camel-bean-kafka-sink-connector.adoc b/docs/modules/ROOT/pages/connectors/camel-bean-kafka-sink-connector.adoc
new file mode 100644
index 0000000..269ac8e
--- /dev/null
+++ b/docs/modules/ROOT/pages/connectors/camel-bean-kafka-sink-connector.adoc
@@ -0,0 +1,61 @@
+// kafka-connector options: START
+[[camel-bean-kafka-connector-sink]]
+= camel-bean-kafka-connector sink configuration
+
+When using camel-bean-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:
+
+[source,xml]
+----
+<dependency>
+  <groupId>org.apache.camel.kafkaconnector</groupId>
+  <artifactId>camel-bean-kafka-connector</artifactId>
+  <version>x.x.x</version>
+  <!-- use the same version as your Camel Kafka connector version -->
+</dependency>
+----
+
+To use this Sink connector in Kafka connect you'll need to set the following connector.class
+
+[source,java]
+----
+connector.class=org.apache.camel.kafkaconnector.bean.CamelBeanSinkConnector
+----
+
+
+The camel-bean sink connector supports 12 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Priority
+| *camel.sink.path.beanName* | Sets the name of the bean to invoke | null | HIGH
+| *camel.sink.endpoint.cache* | Use scope option instead. | null | LOW
+| *camel.sink.endpoint.method* | Sets the name of the method to invoke on the bean | null | MEDIUM
+| *camel.sink.endpoint.scope* | Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple tim [...]
+| *camel.sink.endpoint.lazyStartProducer* | 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 cre [...]
+| *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
+| *camel.sink.endpoint.parameters* | Used for configuring additional properties on the bean | null | MEDIUM
+| *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
+| *camel.component.bean.cache* | Use singleton option instead. | "true" | LOW
+| *camel.component.bean.lazyStartProducer* | 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 cr [...]
+| *camel.component.bean.scope* | Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple ti [...]
+| *camel.component.bean.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
+|===
+
+
+
+The camel-bean sink connector has no converters out of the box.
+
+
+
+
+
+The camel-bean sink connector has no transforms out of the box.
+
+
+
+
+
+The camel-bean sink connector has no aggregation strategies out of the box.
+// kafka-connector options: END