CAMEL-24961: Catalog body types for the core components and languages

catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/bean.json

@@ -29,6 +29,10 @@
     "autowiredEnabled": { "index": 2, "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 then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc." },
     "beanInfoCacheSize": { "index": 3, "kind": "property", "displayName": "Bean Info Cache Size", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Maximum cache size of internal cache for bean introspection. Setting a value of 0 or negative will disable the cache." }
   },
+  "bodyTypes": {
+    "producerIn": { "carriers": [ "any" ], "description": "The first parameter of the method gets the body, converted to its type: a String parameter gets a Map or a POJO as its toString(), so marshal it first" },
+    "producerOut": { "carriers": [ "unknown" ], "description": "What the method returns, also when it returns null. A void method leaves the body unchanged" }
+  },
   "properties": {
     "beanName": { "index": 0, "kind": "path", "displayName": "Bean Name", "group": "common", "label": "common", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Sets the name of the bean to invoke" },
     "method": { "index": 1, "kind": "parameter", "displayName": "Method", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the name of the method to invoke on the bean" },

catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/browse.json

@@ -30,6 +30,11 @@
     "autowiredEnabled": { "index": 2, "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 then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc." },
     "browseLimit": { "index": 3, "kind": "property", "displayName": "Browse Limit", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "Maximum number of messages to keep in memory available for browsing. Use 0 for unlimited." }
   },
+  "bodyTypes": {
+    "consumerOut": { "carriers": [ "unchanged" ], "description": "The body the producer sent: the route runs on the same exchange, in the thread of the producer" },
+    "producerIn": { "carriers": [ "any" ] },
+    "producerOut": { "carriers": [ "unchanged" ], "description": "Unchanged, unless a route consumes from the same browse endpoint: it runs on the same exchange, so the body is the one that route ends with" }
+  },
   "properties": {
     "name": { "index": 0, "kind": "path", "displayName": "Name", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "A name which can be any string to uniquely identify the endpoint" },
     "bridgeErrorHandler": { "index": 1, "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored." },

catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/class.json

@@ -29,6 +29,10 @@
     "autowiredEnabled": { "index": 2, "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 then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc." },
     "beanInfoCacheSize": { "index": 3, "kind": "property", "displayName": "Bean Info Cache Size", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Maximum cache size of internal cache for bean introspection. Setting a value of 0 or negative will disable the cache." }
   },
+  "bodyTypes": {
+    "producerIn": { "carriers": [ "any" ], "description": "The first parameter of the method gets the body, converted to its type: a String parameter gets a Map or a POJO as its toString(), so marshal it first" },
+    "producerOut": { "carriers": [ "unknown" ], "description": "What the method returns, also when it returns null. A void method leaves the body unchanged" }
+  },
   "properties": {
     "beanName": { "index": 0, "kind": "path", "displayName": "Bean Name", "group": "common", "label": "common", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Sets the name of the bean to invoke" },
     "method": { "index": 1, "kind": "parameter", "displayName": "Method", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the name of the method to invoke on the bean" },

catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/controlbus.json

@@ -27,6 +27,10 @@
     "lazyStartProducer": { "index": 0, "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 starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing." },
     "autowiredEnabled": { "index": 1, "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 then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc." }
   },
+  "bodyTypes": {
+    "producerIn": { "carriers": [ "any" ], "byOption": [ { "option": "command", "value": "language", "carriers": [ "text", "bytes", "stream", "file" ] } ], "description": "The route actions do not read the body. The language command evaluates the body as its expression, as text" },
+    "producerOut": { "carriers": [ "unchanged" ], "byOption": [ { "option": "action", "value": "status", "carriers": [ "text", "unchanged" ] }, { "option": "action", "value": "stats", "carriers": [ "text", "unchanged" ] }, { "option": "command", "value": "language", "carriers": [ "unknown" ] }, { "option": "async", "value": "true", "carriers": [ "unchanged" ] } ], "description": "The status of the route for action=status, such as Started, and its statistics as XML for action=stats; the result of the expression for the language command. The other actions leave the body unchanged, as does async=true or a task that fails, which is only logged" }
+  },
   "properties": {
     "command": { "index": 0, "kind": "path", "displayName": "Command", "group": "producer", "label": "", "required": true, "type": "enum", "javaType": "java.lang.String", "enum": [ "route", "language" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Command can be either route or language" },
     "language": { "index": 1, "kind": "path", "displayName": "Language", "group": "producer", "label": "", "required": false, "type": "enum", "javaType": "org.apache.camel.spi.Language", "enum": [ "bean", "constant", "datasonnet", "exchangeProperty", "file", "groovy", "header", "hl7terser", "java", "joor", "jq", "jsonpath", "mvel", "ognl", "python", "ref", "simple", "spel", "tokenize", "xpath", "xquery", "xtokenize" ], "deprecated": false, "autowired": false, "secret": false, "description": "Allows you to specify the name of a Language to use for evaluating the message body. If there is any result from the evaluation, then the result is put in the message body." },

catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/dataformat.json

@@ -27,6 +27,10 @@
     "lazyStartProducer": { "index": 0, "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 starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing." },
     "autowiredEnabled": { "index": 1, "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 then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc." }
   },
+  "bodyTypes": {
+    "producerIn": { "carriers": [ "any" ], "description": "The body the data format named in the path takes, as for the marshal and unmarshal EIPs" },
+    "producerOut": { "carriers": [ "unknown" ], "description": "The body the data format named in the path gives, as for the marshal and unmarshal EIPs" }
+  },
   "properties": {
     "name": { "index": 0, "kind": "path", "displayName": "Name", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Name of data format" },
     "operation": { "index": 1, "kind": "path", "displayName": "Operation", "group": "producer", "label": "", "required": true, "type": "enum", "javaType": "java.lang.String", "enum": [ "marshal", "unmarshal" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Operation to use either marshal or unmarshal" },

catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/dataset-test.json

@@ -29,6 +29,10 @@
     "autowiredEnabled": { "index": 2, "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 then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc." },
     "exchangeFormatter": { "index": 3, "kind": "property", "displayName": "Exchange Formatter", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExchangeFormatter", "deprecated": false, "autowired": true, "secret": false, "description": "To use a custom ExchangeFormatter to format the Exchange into a String suitable for logging." }
   },
+  "bodyTypes": {
+    "producerIn": { "carriers": [ "any" ], "description": "Each message is compared with the next body read at startup from the endpoint in the name. A mismatch fails the assertions of the endpoint, not the message" },
+    "producerOut": { "carriers": [ "unchanged" ] }
+  },
   "properties": {
     "name": { "index": 0, "kind": "path", "displayName": "Name", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Name of endpoint to lookup in the registry to use for polling messages used for testing" },
     "anyOrder": { "index": 1, "kind": "parameter", "displayName": "Any Order", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the expected messages should arrive in the same order or can be in any order." },

catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/dataset.json

@@ -33,6 +33,11 @@
   "headers": {
     "CamelDataSetIndex": { "index": 0, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "Long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The dataset index", "constantName": "org.apache.camel.component.dataset.DataSetConstants#DATASET_INDEX" }
   },
+  "bodyTypes": {
+    "consumerOut": { "carriers": [ "unknown" ], "description": "The body the DataSet bean creates for each message: the defaultBody of a SimpleDataSet (the text <hello>world!<\/hello> unless set), the bodies of a ListDataSet in turn, or the text of a FileDataSet" },
+    "producerIn": { "carriers": [ "any" ], "description": "Each message is compared with the body the DataSet creates for its index. A mismatch fails the assertions of the endpoint, not the message" },
+    "producerOut": { "carriers": [ "unchanged" ] }
+  },
   "properties": {
     "name": { "index": 0, "kind": "path", "displayName": "Name", "group": "common", "label": "", "required": true, "type": "object", "javaType": "org.apache.camel.component.dataset.DataSet", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Name of DataSet to lookup in the registry" },
     "dataSetIndex": { "index": 1, "kind": "parameter", "displayName": "Data Set Index", "group": "common", "label": "", "required": false, "type": "enum", "javaType": "java.lang.String", "enum": [ "strict", "lenient", "off" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "lenient", "description": "Controls the behaviour of the CamelDataSetIndex header. off (consumer) the header will not be set. strict (consumer) the header will be set. lenient (consumer) the header will be set. off (producer) the header value will not be verified, and will not be set if it is not present. strict (producer) the header value must be present and will be verified. lenient (producer) the header value will be verified if it is present, and will be set if it is not present." },