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 36f46f51f7edb8d694676e9fc12e00c934f60d62 Author: Nicolas Filotto <[email protected]> AuthorDate: Fri Apr 1 15:27:25 2022 +0200 CAMEL-17792: Add doc about the message headers of camel-nsq --- .../src/generated/resources/org/apache/camel/component/nsq/nsq.json | 6 ++++++ components/camel-nsq/src/main/docs/nsq-component.adoc | 3 +++ .../src/main/java/org/apache/camel/component/nsq/NsqConstants.java | 6 ++++++ .../src/main/java/org/apache/camel/component/nsq/NsqEndpoint.java | 3 ++- 4 files changed, 17 insertions(+), 1 deletion(-) diff --git a/components/camel-nsq/src/generated/resources/org/apache/camel/component/nsq/nsq.json b/components/camel-nsq/src/generated/resources/org/apache/camel/component/nsq/nsq.json index f384c43..bdfeea8 100644 --- a/components/camel-nsq/src/generated/resources/org/apache/camel/component/nsq/nsq.json +++ b/components/camel-nsq/src/generated/resources/org/apache/camel/component/nsq/nsq.json @@ -28,6 +28,12 @@ "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 [...] "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": { + "CamelNsqMessageId": { "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "byte[]", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The message Id." }, + "CamelNsqMessageAttempts": { "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The message attempts." }, + "CamelNsqMessageTimestamp": { "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "java.util.Date", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The message timestamp." }, + "CamelNsqMessageTopic": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The message topic." } + }, "properties": { "topic": { "kind": "path", "displayName": "Topic", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.nsq.NsqConfiguration", "configurationField": "configuration", "description": "The NSQ topic" }, "servers": { "kind": "parameter", "displayName": "Servers", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.nsq.NsqConfiguration", "configurationField": "configuration", "description": "The hostnames of one or more nsqlookupd servers (consumer) or nsqd servers (producer)" }, diff --git a/components/camel-nsq/src/main/docs/nsq-component.adoc b/components/camel-nsq/src/main/docs/nsq-component.adoc index bb2c91d..17867ee 100644 --- a/components/camel-nsq/src/main/docs/nsq-component.adoc +++ b/components/camel-nsq/src/main/docs/nsq-component.adoc @@ -50,6 +50,9 @@ include::partial$component-endpoint-options.adoc[] // endpoint options: END +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END == Examples diff --git a/components/camel-nsq/src/main/java/org/apache/camel/component/nsq/NsqConstants.java b/components/camel-nsq/src/main/java/org/apache/camel/component/nsq/NsqConstants.java index ec35000..2887770 100644 --- a/components/camel-nsq/src/main/java/org/apache/camel/component/nsq/NsqConstants.java +++ b/components/camel-nsq/src/main/java/org/apache/camel/component/nsq/NsqConstants.java @@ -16,13 +16,19 @@ */ package org.apache.camel.component.nsq; +import org.apache.camel.spi.Metadata; + public interface NsqConstants { int NSQ_DEFAULT_PORT = 4150; int NSQ_DEFAULT_LOOKUP_PORT = 4160; int NSQ_DEFAULT_LOOKUP_PORT_HTTP = 4161; + @Metadata(label = "consumer", description = "The message Id.", javaType = "byte[]") String NSQ_MESSAGE_ID = "CamelNsqMessageId"; + @Metadata(label = "consumer", description = "The message attempts.", javaType = "int") String NSQ_MESSAGE_ATTEMPTS = "CamelNsqMessageAttempts"; + @Metadata(label = "consumer", description = "The message timestamp.", javaType = "java.util.Date") String NSQ_MESSAGE_TIMESTAMP = "CamelNsqMessageTimestamp"; + @Metadata(label = "producer", description = "The message topic.", javaType = "String") String NSQ_MESSAGE_TOPIC = "CamelNsqMessageTopic"; } diff --git a/components/camel-nsq/src/main/java/org/apache/camel/component/nsq/NsqEndpoint.java b/components/camel-nsq/src/main/java/org/apache/camel/component/nsq/NsqEndpoint.java index fd48383..4e8fd47 100644 --- a/components/camel-nsq/src/main/java/org/apache/camel/component/nsq/NsqEndpoint.java +++ b/components/camel-nsq/src/main/java/org/apache/camel/component/nsq/NsqEndpoint.java @@ -36,7 +36,8 @@ import org.apache.camel.util.ObjectHelper; /** * Send and receive messages from NSQ realtime distributed messaging platform. */ -@UriEndpoint(firstVersion = "2.23.0", scheme = "nsq", title = "NSQ", syntax = "nsq:topic", category = { Category.MESSAGING }) +@UriEndpoint(firstVersion = "2.23.0", scheme = "nsq", title = "NSQ", syntax = "nsq:topic", category = { Category.MESSAGING }, + headersClass = NsqConstants.class) public class NsqEndpoint extends DefaultEndpoint { @UriParam
