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 f356ffe1ab1e4f59502390e927e7722cb7496c13 Author: Nicolas Filotto <[email protected]> AuthorDate: Thu Mar 17 12:20:00 2022 +0100 CAMEL-17792: Add doc about the message headers of camel-cassandraql --- .../generated/resources/org/apache/camel/component/cassandra/cql.json | 3 +++ components/camel-cassandraql/src/main/docs/cql-component.adoc | 4 ++++ .../java/org/apache/camel/component/cassandra/CassandraConstants.java | 3 +++ .../java/org/apache/camel/component/cassandra/CassandraEndpoint.java | 2 +- 4 files changed, 11 insertions(+), 1 deletion(-) diff --git a/components/camel-cassandraql/src/generated/resources/org/apache/camel/component/cassandra/cql.json b/components/camel-cassandraql/src/generated/resources/org/apache/camel/component/cassandra/cql.json index 500795f..e63fd79 100644 --- a/components/camel-cassandraql/src/generated/resources/org/apache/camel/component/cassandra/cql.json +++ b/components/camel-cassandraql/src/generated/resources/org/apache/camel/component/cassandra/cql.json @@ -26,6 +26,9 @@ "lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 star [...] "autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 t [...] }, + "headers": { + "CamelCqlQuery": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The CQL query to execute." } + }, "properties": { "beanRef": { "kind": "path", "displayName": "Bean Ref", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "beanRef is defined using bean:id" }, "hosts": { "kind": "path", "displayName": "Hosts", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Hostname(s) Cassandra server(s). Multiple hosts can be separated by comma." }, diff --git a/components/camel-cassandraql/src/main/docs/cql-component.adoc b/components/camel-cassandraql/src/main/docs/cql-component.adoc index a3f7e16..f5e342f 100644 --- a/components/camel-cassandraql/src/main/docs/cql-component.adoc +++ b/components/camel-cassandraql/src/main/docs/cql-component.adoc @@ -40,6 +40,10 @@ include::partial$component-endpoint-options.adoc[] // endpoint options: END +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END + == Endpoint Connection Syntax The endpoint can initiate the Cassandra connection or use an existing diff --git a/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraConstants.java b/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraConstants.java index e86ed10..6dc1552 100644 --- a/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraConstants.java +++ b/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraConstants.java @@ -16,6 +16,8 @@ */ package org.apache.camel.component.cassandra; +import org.apache.camel.spi.Metadata; + /** * Cassandra QL Endpoint constants */ @@ -24,6 +26,7 @@ public final class CassandraConstants { /** * In Message header: CQL Query */ + @Metadata(label = "producer", description = "The CQL query to execute.", javaType = "String") public static final String CQL_QUERY = "CamelCqlQuery"; private CassandraConstants() { diff --git a/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraEndpoint.java b/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraEndpoint.java index 7e25c2a..1bd2ca5 100644 --- a/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraEndpoint.java +++ b/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraEndpoint.java @@ -45,7 +45,7 @@ import org.apache.camel.utils.cassandra.CassandraSessionHolder; * DataStax. */ @UriEndpoint(firstVersion = "2.15.0", scheme = "cql", title = "Cassandra CQL", syntax = "cql:beanRef:hosts:port/keyspace", - category = { Category.DATABASE, Category.NOSQL }) + category = { Category.DATABASE, Category.NOSQL }, headersClass = CassandraConstants.class) public class CassandraEndpoint extends ScheduledPollEndpoint { private volatile CassandraSessionHolder sessionHolder;
