This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new 6e96280 CAMEL-14492: Separete etcd into 3 different endpoints as they
are different. This also causes problems with generated configurer classes.
6e96280 is described below
commit 6e9628066a22e30165d038aecda9e391123dd783
Author: Claus Ibsen <[email protected]>
AuthorDate: Wed Feb 12 11:35:06 2020 +0100
CAMEL-14492: Separete etcd into 3 different endpoints as they are
different. This also causes problems with generated configurer classes.
---
docs/components/modules/ROOT/nav.adoc | 4 +-
.../modules/ROOT/pages/etcd-keys-component.adoc | 81 +++++++++++++++++++++
...cd-component.adoc => etcd-stats-component.adoc} | 19 +++--
.../modules/ROOT/pages/etcd-watch-component.adoc | 84 ++++++++++++++++++++++
docs/components/modules/ROOT/pages/index.adoc | 8 ++-
docs/user-manual/modules/ROOT/pages/index.adoc | 1 -
6 files changed, 183 insertions(+), 14 deletions(-)
diff --git a/docs/components/modules/ROOT/nav.adoc
b/docs/components/modules/ROOT/nav.adoc
index df6bddc..d03b018 100644
--- a/docs/components/modules/ROOT/nav.adoc
+++ b/docs/components/modules/ROOT/nav.adoc
@@ -116,7 +116,9 @@
* xref:elasticsearch-rest-component.adoc[Elastichsearch Rest Component]
* xref:elsql-component.adoc[ElSQL Component]
* xref:elytron-component.adoc[Elytron Component]
-* xref:etcd-component.adoc[Etcd Component]
+* xref:etcd-keys-component.adoc[Etcd Keys Component]
+* xref:etcd-stats-component.adoc[Etcd Stats Component]
+* xref:etcd-watch-component.adoc[Etcd Watch Component]
* xref:eventadmin-component.adoc[OSGi EventAdmin Component]
* xref:exec-component.adoc[Exec Component]
* xref:facebook-component.adoc[Facebook Component]
diff --git a/docs/components/modules/ROOT/pages/etcd-keys-component.adoc
b/docs/components/modules/ROOT/pages/etcd-keys-component.adoc
new file mode 100644
index 0000000..9bc654b
--- /dev/null
+++ b/docs/components/modules/ROOT/pages/etcd-keys-component.adoc
@@ -0,0 +1,81 @@
+[[etcd-keys-component]]
+= Etcd Keys Component
+:page-source: components/camel-etcd/src/main/docs/etcd-keys-component.adoc
+
+*Since Camel 2.18*
+
+// HEADER START
+*Only producer is supported*
+// HEADER END
+
+*Since Camel 2.18*
+
+
+The camel Etcd component allows you to work with Etcd, a distributed reliable
key-value store.
+
+== URI Format
+
+[source,java]
+----------------------------
+etcd-keys:path[?options]
+----------------------------
+
+== URI Options
+
+// component options: START
+The Etcd Keys component supports 8 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *lazyStartProducer* (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 [...]
+| *password* (producer) | The password to use for basic authentication. | |
String
+| *sslContextParameters* (producer) | To configure security using
SSLContextParameters. | | SSLContextParameters
+| *uris* (producer) | To set the URIs the client connects. | | String
+| *userName* (producer) | The user name to use for basic authentication. | |
String
+| *basicPropertyBinding* (advanced) | Whether the component should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
+| *configuration* (advanced) | Sets the common configuration shared among
endpoints | | EtcdConfiguration
+| *useGlobalSslContextParameters* (security) | Enable usage of global SSL
context parameters. | false | boolean
+|===
+// component options: END
+
+// endpoint options: START
+The Etcd Keys endpoint is configured using URI syntax:
+
+----
+etcd-keys:path
+----
+
+with the following path and query parameters:
+
+=== Path Parameters (1 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *path* | The path the endpoint refers to | | String
+|===
+
+
+=== Query Parameters (11 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *lazyStartProducer* (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 [...]
+| *recursive* (producer) | To apply an action recursively. | false | boolean
+| *servicePath* (producer) | The path to look for for service discovery |
/services/ | String
+| *timeout* (producer) | To set the maximum time an action could take to
complete. | | Long
+| *timeToLive* (producer) | To set the lifespan of a key in milliseconds. | |
Integer
+| *uris* (producer) | To set the URIs the client connects. |
http://localhost:2379,http://localhost:4001 | String
+| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
+| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
+| *password* (security) | The password to use for basic authentication. | |
String
+| *sslContextParameters* (security) | To configure security using
SSLContextParameters. | | SSLContextParameters
+| *userName* (security) | The user name to use for basic authentication. | |
String
+|===
+// endpoint options: END
\ No newline at end of file
diff --git a/docs/components/modules/ROOT/pages/etcd-component.adoc
b/docs/components/modules/ROOT/pages/etcd-stats-component.adoc
similarity index 95%
rename from docs/components/modules/ROOT/pages/etcd-component.adoc
rename to docs/components/modules/ROOT/pages/etcd-stats-component.adoc
index c14f5aa..3b4b59b 100644
--- a/docs/components/modules/ROOT/pages/etcd-component.adoc
+++ b/docs/components/modules/ROOT/pages/etcd-stats-component.adoc
@@ -1,6 +1,6 @@
-[[etcd-component]]
-= Etcd Component
-:page-source: components/camel-etcd/src/main/docs/etcd-component.adoc
+[[etcd-stats-component]]
+= Etcd Stats Component
+:page-source: components/camel-etcd/src/main/docs/etcd-stats-component.adoc
*Since Camel 2.18*
@@ -17,13 +17,13 @@ The camel Etcd component allows you to work with Etcd, a
distributed reliable ke
[source,java]
----------------------------
-etcd:namespace/path[?options]
+etcd-stats:path[?options]
----------------------------
== URI Options
// component options: START
-The Etcd component supports 9 options, which are listed below.
+The Etcd Stats component supports 9 options, which are listed below.
@@ -43,21 +43,20 @@ The Etcd component supports 9 options, which are listed
below.
// component options: END
// endpoint options: START
-The Etcd endpoint is configured using URI syntax:
+The Etcd Stats endpoint is configured using URI syntax:
----
-etcd:namespace/path
+etcd-stats:path
----
with the following path and query parameters:
-=== Path Parameters (2 parameters):
+=== Path Parameters (1 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *namespace* | *Required* The API namespace to use. The value can be one of:
keys, stats, watch | | EtcdNamespace
| *path* | The path the endpoint refers to | | String
|===
@@ -101,4 +100,4 @@ with the following path and query parameters:
| *sslContextParameters* (security) | To configure security using
SSLContextParameters. | | SSLContextParameters
| *userName* (security) | The user name to use for basic authentication. | |
String
|===
-// endpoint options: END
+// endpoint options: END
\ No newline at end of file
diff --git a/docs/components/modules/ROOT/pages/etcd-watch-component.adoc
b/docs/components/modules/ROOT/pages/etcd-watch-component.adoc
new file mode 100644
index 0000000..7b3f3cb
--- /dev/null
+++ b/docs/components/modules/ROOT/pages/etcd-watch-component.adoc
@@ -0,0 +1,84 @@
+[[etcd-watch-component]]
+= Etcd Watch Component
+:page-source: components/camel-etcd/src/main/docs/etcd-watch-component.adoc
+
+*Since Camel 2.18*
+
+// HEADER START
+*Only consumer is supported*
+// HEADER END
+
+*Since Camel 2.18*
+
+
+The camel Etcd component allows you to work with Etcd, a distributed reliable
key-value store.
+
+== URI Format
+
+[source,java]
+----------------------------
+etcd-watch:path[?options]
+----------------------------
+
+== URI Options
+
+// component options: START
+The Etcd Watch component supports 8 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *bridgeErrorHandler* (consumer) | 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
+| *password* (consumer) | The password to use for basic authentication. | |
String
+| *sslContextParameters* (consumer) | To configure security using
SSLContextParameters. | | SSLContextParameters
+| *uris* (consumer) | To set the URIs the client connects. | | String
+| *userName* (consumer) | The user name to use for basic authentication. | |
String
+| *basicPropertyBinding* (advanced) | Whether the component should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
+| *configuration* (advanced) | Sets the common configuration shared among
endpoints | | EtcdConfiguration
+| *useGlobalSslContextParameters* (security) | Enable usage of global SSL
context parameters. | false | boolean
+|===
+// component options: END
+
+// endpoint options: START
+The Etcd Watch endpoint is configured using URI syntax:
+
+----
+etcd-watch:path
+----
+
+with the following path and query parameters:
+
+=== Path Parameters (1 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *path* | The path the endpoint refers to | | String
+|===
+
+
+=== Query Parameters (14 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *bridgeErrorHandler* (consumer) | 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
+| *recursive* (consumer) | To apply an action recursively. | false | boolean
+| *sendEmptyExchangeOnTimeout* (consumer) | To send an empty message in case
of timeout watching for a key. | false | boolean
+| *servicePath* (consumer) | The path to look for for service discovery |
/services/ | String
+| *timeout* (consumer) | To set the maximum time an action could take to
complete. | | Long
+| *uris* (consumer) | To set the URIs the client connects. |
http://localhost:2379,http://localhost:4001 | String
+| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | |
ExchangePattern
+| *fromIndex* (consumer) | The index to watch from | 0 | Long
+| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
+| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
+| *password* (security) | The password to use for basic authentication. | |
String
+| *sslContextParameters* (security) | To configure security using
SSLContextParameters. | | SSLContextParameters
+| *userName* (security) | The user name to use for basic authentication. | |
String
+|===
+// endpoint options: END
\ No newline at end of file
diff --git a/docs/components/modules/ROOT/pages/index.adoc
b/docs/components/modules/ROOT/pages/index.adoc
index fa81a27..f634518 100644
--- a/docs/components/modules/ROOT/pages/index.adoc
+++ b/docs/components/modules/ROOT/pages/index.adoc
@@ -6,7 +6,7 @@ The following Apache Camel artifacts are provided:
== Components
// components: START
-Number of Components: 322 in 259 JAR artifacts (1 deprecated)
+Number of Components: 324 in 259 JAR artifacts (1 deprecated)
[width="100%",cols="4,1,5",options="header"]
|===
@@ -206,7 +206,11 @@ Number of Components: 322 in 259 JAR artifacts (1
deprecated)
| xref:elytron-component.adoc[Elytron] (camel-elytron) | 3.1 | The elytron
component is allows you to work with the Elytron Security Framework
-| xref:etcd-component.adoc[Etcd] (camel-etcd) | 2.18 | The camel etcd
component allows you to work with Etcd, a distributed reliable key-value store.
+| xref:etcd-keys-component.adoc[Etcd Keys] (camel-etcd) | 2.18 | Camel Etcd
support
+
+| xref:etcd-stats-component.adoc[Etcd Stats] (camel-etcd) | 2.18 | The camel
etcd component allows you to work with Etcd, a distributed reliable key-value
store.
+
+| xref:etcd-watch-component.adoc[Etcd Watch] (camel-etcd) | 2.18 | The camel
etcd component allows you to work with Etcd, a distributed reliable key-value
store.
| xref:exec-component.adoc[Exec] (camel-exec) | 2.3 | The exec component can
be used to execute OS system commands.
diff --git a/docs/user-manual/modules/ROOT/pages/index.adoc
b/docs/user-manual/modules/ROOT/pages/index.adoc
index afbe5ae..da683fa 100644
--- a/docs/user-manual/modules/ROOT/pages/index.adoc
+++ b/docs/user-manual/modules/ROOT/pages/index.adoc
@@ -217,7 +217,6 @@ camel routes without them knowing
** xref:components::ehcache-component.adoc[Ehcache]
** xref:components::elasticsearch-rest-component.adoc[Elastichsearch Rest]
** xref:components::elsql-component.adoc[ElSQL]
-** xref:components::etcd-component.adoc[etcd]
** xref:components::exec-component.adoc[Exec]
** xref:components::facebook-component.adoc[Facebook]
** xref:components::fhir-component.adoc[FHIR]
