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 9a89e3071b13807a19c0850791b0be493c6806aa Author: Nicolas Filotto <[email protected]> AuthorDate: Wed Mar 30 15:38:34 2022 +0200 CAMEL-17792: Add doc about the message headers of camel-jgroups-raft --- .../camel/component/jgroups/raft/jgroups-raft.json | 15 +++++++++ .../src/main/docs/jgroups-raft-component.adoc | 36 ++-------------------- .../jgroups/raft/JGroupsRaftConstants.java | 18 +++++++++++ .../jgroups/raft/JGroupsRaftEndpoint.java | 2 +- 4 files changed, 37 insertions(+), 34 deletions(-) diff --git a/components/camel-jgroups-raft/src/generated/resources/org/apache/camel/component/jgroups/raft/jgroups-raft.json b/components/camel-jgroups-raft/src/generated/resources/org/apache/camel/component/jgroups/raft/jgroups-raft.json index 44ffb68..3e0cac2 100644 --- a/components/camel-jgroups-raft/src/generated/resources/org/apache/camel/component/jgroups/raft/jgroups-raft.json +++ b/components/camel-jgroups-raft/src/generated/resources/org/apache/camel/component/jgroups/raft/jgroups-raft.json @@ -30,6 +30,21 @@ "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": { + "JGROUPSRAFT_LOG_SIZE": { "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The Raft log size in number of entries." }, + "JGROUPSRAFT_COMMIT_INDEX": { "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The commit index." }, + "JGROUPSRAFT_CURRENT_TERM": { "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The current raft term." }, + "JGROUPSRAFT_IS_LEADER": { "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Whether the node is the Raft Leader or not." }, + "JGROUPSRAFT_LAST_APPLIED": { "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The index of the last log entry that was appended to the log." }, + "JGROUPSRAFT_LEADER_ADDRESS": { "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "org.jgroups.Address", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The Address ot Raft Leader or not." }, + "JGROUPSRAFT_LOG_SIZE_BYTE": { "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The Raft log size in bytes." }, + "JGROUPSRAFT_RAFT_ID": { "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The Raft id of the node." }, + "JGROUPSRAFT_EVENT_TYPE": { "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "org.apache.camel.component.jgroups.raft.JGroupsRaftEventType", "enum": [ "LEADER", "FOLLOWER", "CANDIDATE", "APPLY", "READ_CONTENT_FROM", "WRITE_CONTENT_TO" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The event type" }, + "JGROUPSRAFT_SET_OFFSET": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Integer", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Offset to use in the byte[] buffer to be set()." }, + "JGROUPSRAFT_SET_LENGTH": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Integer", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Length to use in the byte[] buffer to be set()." }, + "JGROUPSRAFT_SET_TIMEOUT": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Timeout to be used in set() operation." }, + "JGROUPSRAFT_SET_TIMEUNIT": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Timeunit to be used in set() operation." } + }, "properties": { "clusterName": { "kind": "path", "displayName": "Cluster Name", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The name of the JGroupsraft cluster the component should connect 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-jgroups-raft/src/main/docs/jgroups-raft-component.adoc b/components/camel-jgroups-raft/src/main/docs/jgroups-raft-component.adoc index 191e9d4..1e6c60a 100644 --- a/components/camel-jgroups-raft/src/main/docs/jgroups-raft-component.adoc +++ b/components/camel-jgroups-raft/src/main/docs/jgroups-raft-component.adoc @@ -53,40 +53,10 @@ include::partial$component-endpoint-options.adoc[] // endpoint options: END +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END -== Headers - -[width="100%",cols="10%,10%,70%",options="header",] -|======================================================================= -|Header |Constant |Since version |Description - -|`JGROUPSRAFT_COMMIT_INDEX` |`JGroupsRaftEndpoint.HEADER_JGROUPSRAFT_COMMIT_INDEX` | *Consumer* : The commit index (int). - -|`JGROUPSRAFT_CURRENT_TERM` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_CURRENT_TERM` | *Consumer* : The current raft term (int). - -|`JGROUPSRAFT_IS_LEADER` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_IS_LEADER` | *Consumer*: Whether the node is the Raft Leader or not (boolean). - -|`JGROUPSRAFT_LAST_APPLIED` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_LAST_APPLIED` | *Consumer*: The index of the last log entry that was appended to the log (int). - -|`JGROUPSRAFT_LEADER_ADDRESS` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_LEADER_ADDRESS` | *Consumer*: The Address ot Raft Leader or not (org.jgroups.Address). - -|`JGROUPSRAFT_LOG_SIZE` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_LOG_SIZE` | *Consumer*: The Raft log size in number of entries (int). - -|`JGROUPSRAFT_LOG_SIZE_BYTE` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_LOG_SIZE_BYTE` | *Consumer*: The Raft log size in bytes (int). - -|`JGROUPSRAFT_RAFT_ID` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_RAFT_ID` | *Consumer*: The Raft id of the node (String). - -|`JGROUPSRAFT_EVENT_TYPE` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_EVENT_TYPE` | *Consumer*: The event type, one of org.apache.camel.component.jgroups.raft.JGroupsRaftEventType ENUM. - -|`JGROUPSRAFT_SET_OFFSET` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_SET_OFFSET` | *Producer*: Offset to use in the byte[] buffer to be set(). - -|`JGROUPSRAFT_SET_LENGTH` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_SET_LENGTH` | *Producer*: Length to use in the byte[] buffer to be set(). - -|`JGROUPSRAFT_SET_TIMEOUT` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_SET_TIMEOUT` | *Producer*: Timeout to be used in set() operation. - -|`JGROUPSRAFT_SET_TIMEUNIT` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_SET_TIMEUNIT` | *Producer*: Timeunit to be used in set() operation. -|======================================================================= - == Usage Using `jgroups-raft` component with `enableRoleChangeEvents=true` on the consumer side of the route will capture diff --git a/components/camel-jgroups-raft/src/main/java/org/apache/camel/component/jgroups/raft/JGroupsRaftConstants.java b/components/camel-jgroups-raft/src/main/java/org/apache/camel/component/jgroups/raft/JGroupsRaftConstants.java index b051a29..2e85c91 100644 --- a/components/camel-jgroups-raft/src/main/java/org/apache/camel/component/jgroups/raft/JGroupsRaftConstants.java +++ b/components/camel-jgroups-raft/src/main/java/org/apache/camel/component/jgroups/raft/JGroupsRaftConstants.java @@ -16,20 +16,38 @@ */ package org.apache.camel.component.jgroups.raft; +import org.apache.camel.spi.Metadata; + public final class JGroupsRaftConstants { + @Metadata(label = "consumer", description = "The Raft log size in number of entries.", javaType = "int") public static final String HEADER_JGROUPSRAFT_LOG_SIZE = "JGROUPSRAFT_LOG_SIZE"; public static final String DEFAULT_JGROUPSRAFT_CONFIG = "raft.xml"; + @Metadata(label = "consumer", description = "The commit index.", javaType = "int") public static final String HEADER_JGROUPSRAFT_COMMIT_INDEX = "JGROUPSRAFT_COMMIT_INDEX"; + @Metadata(label = "consumer", description = "The current raft term.", javaType = "int") public static final String HEADER_JGROUPSRAFT_CURRENT_TERM = "JGROUPSRAFT_CURRENT_TERM"; + @Metadata(label = "consumer", description = "Whether the node is the Raft Leader or not.", javaType = "boolean") public static final String HEADER_JGROUPSRAFT_IS_LEADER = "JGROUPSRAFT_IS_LEADER"; + @Metadata(label = "consumer", description = "The index of the last log entry that was appended to the log.", + javaType = "int") public static final String HEADER_JGROUPSRAFT_LAST_APPLIED = "JGROUPSRAFT_LAST_APPLIED"; + @Metadata(label = "consumer", description = "The Address ot Raft Leader or not.", javaType = "org.jgroups.Address") public static final String HEADER_JGROUPSRAFT_LEADER_ADDRESS = "JGROUPSRAFT_LEADER_ADDRESS"; + @Metadata(label = "consumer", description = "The Raft log size in bytes.", javaType = "int") public static final String HEADER_JGROUPSRAFT_LOG_SIZE_BYTE = "JGROUPSRAFT_LOG_SIZE_BYTE"; + @Metadata(label = "consumer", description = "The Raft id of the node.", javaType = "String") public static final String HEADER_JGROUPSRAFT_RAFT_ID = "JGROUPSRAFT_RAFT_ID"; + @Metadata(label = "consumer", description = "The event type", + javaType = "org.apache.camel.component.jgroups.raft.JGroupsRaftEventType") public static final String HEADER_JGROUPSRAFT_EVENT_TYPE = "JGROUPSRAFT_EVENT_TYPE"; + @Metadata(label = "producer", description = "Offset to use in the byte[] buffer to be set().", javaType = "Integer") public static final String HEADER_JGROUPSRAFT_SET_OFFSET = "JGROUPSRAFT_SET_OFFSET"; + @Metadata(label = "producer", description = "Length to use in the byte[] buffer to be set().", javaType = "Integer") public static final String HEADER_JGROUPSRAFT_SET_LENGTH = "JGROUPSRAFT_SET_LENGTH"; + @Metadata(label = "producer", description = "Timeout to be used in set() operation.", javaType = "Long") public static final String HEADER_JGROUPSRAFT_SET_TIMEOUT = "JGROUPSRAFT_SET_TIMEOUT"; + @Metadata(label = "producer", description = "Timeunit to be used in set() operation.", + javaType = "java.util.concurrent.TimeUnit") public static final String HEADER_JGROUPSRAFT_SET_TIMEUNIT = "JGROUPSRAFT_SET_TIMEUNIT"; private JGroupsRaftConstants() { diff --git a/components/camel-jgroups-raft/src/main/java/org/apache/camel/component/jgroups/raft/JGroupsRaftEndpoint.java b/components/camel-jgroups-raft/src/main/java/org/apache/camel/component/jgroups/raft/JGroupsRaftEndpoint.java index 075f97e..8dba775 100644 --- a/components/camel-jgroups-raft/src/main/java/org/apache/camel/component/jgroups/raft/JGroupsRaftEndpoint.java +++ b/components/camel-jgroups-raft/src/main/java/org/apache/camel/component/jgroups/raft/JGroupsRaftEndpoint.java @@ -40,7 +40,7 @@ import org.slf4j.LoggerFactory; * Exchange messages with JGroups-raft clusters. */ @UriEndpoint(firstVersion = "2.24.0", scheme = "jgroups-raft", title = "JGroups raft", syntax = "jgroup-raft:clusterName", - category = { Category.CLUSTERING, Category.MESSAGING }) + category = { Category.CLUSTERING, Category.MESSAGING }, headersClass = JGroupsRaftConstants.class) public class JGroupsRaftEndpoint extends DefaultEndpoint { private static final Logger LOG = LoggerFactory.getLogger(JGroupsRaftEndpoint.class);
