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 4fa17c5e4152dffae94d6d1a3b4e30ec92a45814
Author: Nicolas Filotto <nfilo...@talend.com>
AuthorDate: Thu Mar 17 14:37:28 2022 +0100
CAMEL-17792: Add doc about the message headers of camel-cometd
---
.../generated/resources/org/apache/camel/component/cometd/cometd.json | 4 ++++
.../resources/org/apache/camel/component/cometd/cometds.json | 4 ++++
components/camel-cometd/src/main/docs/cometd-component.adoc | 4 +++-
.../main/java/org/apache/camel/component/cometd/CometdBinding.java | 3 +++
.../main/java/org/apache/camel/component/cometd/CometdEndpoint.java | 2 +-
5 files changed, 15 insertions(+), 2 deletions(-)
diff --git
a/components/camel-cometd/src/generated/resources/org/apache/camel/component/cometd/cometd.json
b/components/camel-cometd/src/generated/resources/org/apache/camel/component/cometd/cometd.json
index 558abaf..5b24a81 100644
---
a/components/camel-cometd/src/generated/resources/org/apache/camel/component/cometd/cometd.json
+++
b/components/camel-cometd/src/generated/resources/org/apache/camel/component/cometd/cometd.json
@@ -34,6 +34,10 @@
"sslPassword": { "kind": "property", "displayName": "Ssl Password",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "description": "The password when using SSL." },
"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." }
},
+ "headers": {
+ "CometdClientId": { "kind": "header", "displayName": "", "group":
"common", "label": "", "required": false, "javaType": "String", "deprecated":
false, "deprecationNote": "", "autowired": false, "secret": false,
"description": "The clientId of the session" },
+ "subscription": { "kind": "header", "displayName": "", "group": "common",
"label": "", "required": false, "javaType": "String", "deprecated": false,
"deprecationNote": "", "autowired": false, "secret": false, "description": "The
subscription" }
+ },
"properties": {
"host": { "kind": "path", "displayName": "Host", "group": "common",
"label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Hostname" },
"port": { "kind": "path", "displayName": "Port", "group": "common",
"label": "", "required": true, "type": "integer", "javaType": "int",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "Host port number" },
diff --git
a/components/camel-cometd/src/generated/resources/org/apache/camel/component/cometd/cometds.json
b/components/camel-cometd/src/generated/resources/org/apache/camel/component/cometd/cometds.json
index 0176a91..3e48eb6 100644
---
a/components/camel-cometd/src/generated/resources/org/apache/camel/component/cometd/cometds.json
+++
b/components/camel-cometd/src/generated/resources/org/apache/camel/component/cometd/cometds.json
@@ -34,6 +34,10 @@
"sslPassword": { "kind": "property", "displayName": "Ssl Password",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "description": "The password when using SSL." },
"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." }
},
+ "headers": {
+ "CometdClientId": { "kind": "header", "displayName": "", "group":
"common", "label": "", "required": false, "javaType": "String", "deprecated":
false, "deprecationNote": "", "autowired": false, "secret": false,
"description": "The clientId of the session" },
+ "subscription": { "kind": "header", "displayName": "", "group": "common",
"label": "", "required": false, "javaType": "String", "deprecated": false,
"deprecationNote": "", "autowired": false, "secret": false, "description": "The
subscription" }
+ },
"properties": {
"host": { "kind": "path", "displayName": "Host", "group": "common",
"label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Hostname" },
"port": { "kind": "path", "displayName": "Port", "group": "common",
"label": "", "required": true, "type": "integer", "javaType": "int",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "Host port number" },
diff --git a/components/camel-cometd/src/main/docs/cometd-component.adoc
b/components/camel-cometd/src/main/docs/cometd-component.adoc
index 6a60f5d..1806ee0 100644
--- a/components/camel-cometd/src/main/docs/cometd-component.adoc
+++ b/components/camel-cometd/src/main/docs/cometd-component.adoc
@@ -65,7 +65,9 @@ include::partial$component-endpoint-options.adoc[]
// endpoint options: END
-
+// component headers: START
+include::partial$component-endpoint-headers.adoc[]
+// component headers: END
== Sample
diff --git
a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdBinding.java
b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdBinding.java
index ffa804d..52d648b 100644
---
a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdBinding.java
+++
b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdBinding.java
@@ -24,6 +24,7 @@ import java.util.Set;
import org.apache.camel.CamelContext;
import org.apache.camel.Exchange;
import org.apache.camel.Message;
+import org.apache.camel.spi.Metadata;
import org.apache.camel.support.DefaultMessage;
import org.cometd.bayeux.server.ServerChannel;
import org.cometd.bayeux.server.ServerMessage;
@@ -38,7 +39,9 @@ import org.slf4j.LoggerFactory;
public class CometdBinding {
public static final String HEADERS_FIELD = "CamelHeaders";
+ @Metadata(description = "The clientId of the session", javaType = "String")
public static final String COMETD_CLIENT_ID_HEADER_NAME = "CometdClientId";
+ @Metadata(description = "The subscription", javaType = "String")
public static final String COMETD_SUBSCRIPTION_HEADER_NAME =
"subscription";
public static final String COMETD_SESSION_ATTR_HEADER_NAME =
"CometdSessionAttr";
diff --git
a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java
b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java
index 17c65b9..573339c 100644
---
a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java
+++
b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java
@@ -38,7 +38,7 @@ import org.apache.camel.util.ObjectHelper;
* the browser using an AJAX based mechanism.
*/
@UriEndpoint(firstVersion = "2.0.0", scheme = "cometd,cometds", title =
"CometD", syntax = "cometd:host:port/channelName",
- category = { Category.WEBSOCKET })
+ category = { Category.WEBSOCKET }, headersClass =
CometdBinding.class)
public class CometdEndpoint extends DefaultEndpoint {
private CometdComponent component;
