This is an automated email from the ASF dual-hosted git repository. nfilotto pushed a commit to branch CAMEL-17792/doc-message-headers in repository https://gitbox.apache.org/repos/asf/camel.git
commit d9308c5c63f3c1bc3934160495bd0d44c56dd8e2 Author: Nicolas Filotto <[email protected]> AuthorDate: Mon Mar 21 12:15:45 2022 +0100 CAMEL-17792: Add doc about the message headers of camel-etcd --- .../org/apache/camel/component/etcd/etcd-keys.json | 8 ++++++++ .../apache/camel/component/etcd/etcd-stats.json | 4 ++++ .../apache/camel/component/etcd/etcd-watch.json | 5 +++++ .../src/main/docs/etcd-keys-component.adoc | 3 +++ .../src/main/docs/etcd-stats-component.adoc | 3 +++ .../src/main/docs/etcd-watch-component.adoc | 4 +++- .../apache/camel/component/etcd/EtcdConstants.java | 22 ++++++++++++++++++++++ .../camel/component/etcd/EtcdKeysEndpoint.java | 7 +++++-- .../camel/component/etcd/EtcdStatsEndpoint.java | 6 ++++-- .../camel/component/etcd/EtcdWatchEndpoint.java | 6 ++++-- 10 files changed, 61 insertions(+), 7 deletions(-) diff --git a/components/camel-etcd/src/generated/resources/org/apache/camel/component/etcd/etcd-keys.json b/components/camel-etcd/src/generated/resources/org/apache/camel/component/etcd/etcd-keys.json index 90b36b6..3d45062 100644 --- a/components/camel-etcd/src/generated/resources/org/apache/camel/component/etcd/etcd-keys.json +++ b/components/camel-etcd/src/generated/resources/org/apache/camel/component/etcd/etcd-keys.json @@ -35,6 +35,14 @@ "useGlobalSslContextParameters": { "kind": "property", "displayName": "Use Global Ssl Context Parameters", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable usage of global SSL context parameters." }, "userName": { "kind": "property", "displayName": "User Name", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.etcd.EtcdConfiguration", "configurationField": "configuration", "description": "The user name to use for basic authentication." } }, + "headers": { + "CamelEtcdAction": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The action to perform.\nSupported values:\n\n* set\n* get\n* delete" }, + "CamelEtcdNamespace": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The namespace" }, + "CamelEtcdPath": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The target path" }, + "CamelEtcdTimeout": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Long or Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The timeout of the request in milliseconds" }, + "CamelEtcdRecursive": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "To apply an action recursively." }, + "CamelEtcdTtl": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Integer", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "To set the lifespan of a key in milliseconds." } + }, "properties": { "path": { "kind": "path", "displayName": "Path", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The path the endpoint refers to" }, "recursive": { "kind": "parameter", "displayName": "Recursive", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.etcd.EtcdConfiguration", "configurationField": "configuration", "description": "To apply an action recursively." }, diff --git a/components/camel-etcd/src/generated/resources/org/apache/camel/component/etcd/etcd-stats.json b/components/camel-etcd/src/generated/resources/org/apache/camel/component/etcd/etcd-stats.json index 9eda615..4ab6310 100644 --- a/components/camel-etcd/src/generated/resources/org/apache/camel/component/etcd/etcd-stats.json +++ b/components/camel-etcd/src/generated/resources/org/apache/camel/component/etcd/etcd-stats.json @@ -38,6 +38,10 @@ "useGlobalSslContextParameters": { "kind": "property", "displayName": "Use Global Ssl Context Parameters", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable usage of global SSL context parameters." }, "userName": { "kind": "property", "displayName": "User Name", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.etcd.EtcdConfiguration", "configurationField": "configuration", "description": "The user name to use for basic authentication." } }, + "headers": { + "CamelEtcdNamespace": { "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The namespace" }, + "CamelEtcdPath": { "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The target path" } + }, "properties": { "path": { "kind": "path", "displayName": "Path", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The path the endpoint refers to" }, "recursive": { "kind": "parameter", "displayName": "Recursive", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.etcd.EtcdConfiguration", "configurationField": "configuration", "description": "To apply an action recursively." }, diff --git a/components/camel-etcd/src/generated/resources/org/apache/camel/component/etcd/etcd-watch.json b/components/camel-etcd/src/generated/resources/org/apache/camel/component/etcd/etcd-watch.json index 6d8468b..b75885e 100644 --- a/components/camel-etcd/src/generated/resources/org/apache/camel/component/etcd/etcd-watch.json +++ b/components/camel-etcd/src/generated/resources/org/apache/camel/component/etcd/etcd-watch.json @@ -36,6 +36,11 @@ "useGlobalSslContextParameters": { "kind": "property", "displayName": "Use Global Ssl Context Parameters", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable usage of global SSL context parameters." }, "userName": { "kind": "property", "displayName": "User Name", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.etcd.EtcdConfiguration", "configurationField": "configuration", "description": "The user name to use for basic authentication." } }, + "headers": { + "CamelEtcdNamespace": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The namespace" }, + "CamelEtcdPath": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The target path" }, + "CamelEtcdTimeout": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Long or Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The timeout of the request in milliseconds" } + }, "properties": { "path": { "kind": "path", "displayName": "Path", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The path the endpoint refers to" }, "bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 m [...] diff --git a/components/camel-etcd/src/main/docs/etcd-keys-component.adoc b/components/camel-etcd/src/main/docs/etcd-keys-component.adoc index 4a446eb..e94dfd3 100644 --- a/components/camel-etcd/src/main/docs/etcd-keys-component.adoc +++ b/components/camel-etcd/src/main/docs/etcd-keys-component.adoc @@ -35,5 +35,8 @@ include::partial$component-endpoint-options.adoc[] // endpoint options: END +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END include::spring-boot:partial$starter.adoc[] diff --git a/components/camel-etcd/src/main/docs/etcd-stats-component.adoc b/components/camel-etcd/src/main/docs/etcd-stats-component.adoc index c790b15..e6bed0d 100644 --- a/components/camel-etcd/src/main/docs/etcd-stats-component.adoc +++ b/components/camel-etcd/src/main/docs/etcd-stats-component.adoc @@ -35,5 +35,8 @@ include::partial$component-endpoint-options.adoc[] // endpoint options: END +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END include::spring-boot:partial$starter.adoc[] diff --git a/components/camel-etcd/src/main/docs/etcd-watch-component.adoc b/components/camel-etcd/src/main/docs/etcd-watch-component.adoc index de48c02..9183ab7 100644 --- a/components/camel-etcd/src/main/docs/etcd-watch-component.adoc +++ b/components/camel-etcd/src/main/docs/etcd-watch-component.adoc @@ -36,6 +36,8 @@ include::partial$component-endpoint-options.adoc[] // endpoint options: START // endpoint options: END - +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END include::spring-boot:partial$starter.adoc[] diff --git a/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdConstants.java b/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdConstants.java index 863d2b2..c0264718 100644 --- a/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdConstants.java +++ b/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdConstants.java @@ -16,15 +16,37 @@ */ package org.apache.camel.component.etcd; +import org.apache.camel.spi.Metadata; + public interface EtcdConstants { + // The schemes + String SCHEME_KEYS = "etcd-keys"; + String SCHEME_STATS = "etcd-stats"; + String SCHEME_WATCH = "etcd-watch"; + String ETCD_DEFAULT_URIS = "http://localhost:2379,http://localhost:4001";; + @Metadata(label = "producer", description = "The action to perform.\n" + + "Supported values:\n" + + "\n" + + "* set\n" + + "* get\n" + + "* delete\n", + javaType = "String", applicableFor = SCHEME_KEYS) String ETCD_ACTION = "CamelEtcdAction"; + @Metadata(description = "The namespace", javaType = "String") String ETCD_NAMESPACE = "CamelEtcdNamespace"; + @Metadata(description = "The target path", javaType = "String") String ETCD_PATH = "CamelEtcdPath"; + @Metadata(label = "producer", description = "The timeout of the request in milliseconds", javaType = "Long or Boolean", + applicableFor = { SCHEME_KEYS, SCHEME_WATCH }) String ETCD_TIMEOUT = "CamelEtcdTimeout"; + @Metadata(label = "producer", description = "To apply an action recursively.", javaType = "Boolean", + applicableFor = SCHEME_KEYS) String ETCD_RECURSIVE = "CamelEtcdRecursive"; + @Metadata(label = "producer", description = "To set the lifespan of a key in milliseconds.", javaType = "Integer", + applicableFor = SCHEME_KEYS) String ETCD_TTL = "CamelEtcdTtl"; String ETCD_KEYS_ACTION_SET = "set"; diff --git a/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdKeysEndpoint.java b/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdKeysEndpoint.java index cab50d5..ee66d96 100644 --- a/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdKeysEndpoint.java +++ b/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdKeysEndpoint.java @@ -22,11 +22,14 @@ import org.apache.camel.Processor; import org.apache.camel.Producer; import org.apache.camel.spi.UriEndpoint; +import static org.apache.camel.component.etcd.EtcdConstants.SCHEME_KEYS; + /** * Get, set or delete keys in etcd key-value store. */ -@UriEndpoint(firstVersion = "2.18.0", scheme = "etcd-keys", title = "Etcd Keys", producerOnly = true, - syntax = "etcd-keys:path", category = { Category.CLUSTERING, Category.DATABASE }) +@UriEndpoint(firstVersion = "2.18.0", scheme = SCHEME_KEYS, title = "Etcd Keys", producerOnly = true, + syntax = "etcd-keys:path", category = { Category.CLUSTERING, Category.DATABASE }, + headersClass = EtcdConstants.class) public class EtcdKeysEndpoint extends AbstractEtcdEndpoint { public EtcdKeysEndpoint( diff --git a/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdStatsEndpoint.java b/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdStatsEndpoint.java index 4771d46..8dbfcf4 100644 --- a/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdStatsEndpoint.java +++ b/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdStatsEndpoint.java @@ -22,11 +22,13 @@ import org.apache.camel.Processor; import org.apache.camel.Producer; import org.apache.camel.spi.UriEndpoint; +import static org.apache.camel.component.etcd.EtcdConstants.SCHEME_STATS; + /** * Access etcd cluster statistcs. */ -@UriEndpoint(firstVersion = "2.18.0", scheme = "etcd-stats", title = "Etcd Stats", - syntax = "etcd-stats:path", label = "clustering,database") +@UriEndpoint(firstVersion = "2.18.0", scheme = SCHEME_STATS, title = "Etcd Stats", + syntax = "etcd-stats:path", label = "clustering,database", headersClass = EtcdConstants.class) public class EtcdStatsEndpoint extends AbstractEtcdPollingEndpoint { public EtcdStatsEndpoint( diff --git a/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdWatchEndpoint.java b/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdWatchEndpoint.java index 9b27647..2f0fb3d 100644 --- a/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdWatchEndpoint.java +++ b/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/EtcdWatchEndpoint.java @@ -21,11 +21,13 @@ import org.apache.camel.Processor; import org.apache.camel.Producer; import org.apache.camel.spi.UriEndpoint; +import static org.apache.camel.component.etcd.EtcdConstants.SCHEME_WATCH; + /** * Watch specific etcd keys or directories for changes. */ -@UriEndpoint(firstVersion = "2.18.0", scheme = "etcd-watch", title = "Etcd Watch", consumerOnly = true, - syntax = "etcd-watch:path", label = "clustering,database") +@UriEndpoint(firstVersion = "2.18.0", scheme = SCHEME_WATCH, title = "Etcd Watch", consumerOnly = true, + syntax = "etcd-watch:path", label = "clustering,database", headersClass = EtcdConstants.class) public class EtcdWatchEndpoint extends AbstractEtcdEndpoint { public EtcdWatchEndpoint(
