You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2023/10/21 09:39:43 UTC
[camel] 01/04: CAMEL-20024: camel-core-model - Add description for new bean DSL
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch model-apps
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 2c76db43c61794f4bfd879be63de99b194d3f8a7
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Sat Oct 21 10:12:56 2023 +0200
CAMEL-20024: camel-core-model - Add description for new bean DSL
---
.../org/apache/camel/catalog/models/beans.json | 18 ++++-----
.../org/apache/camel/catalog/models/camel.json | 18 ++++-----
.../org/apache/camel/catalog/models/property.json | 4 +-
.../org/apache/camel/model/app/beans.json | 18 ++++-----
.../org/apache/camel/model/app/camel.json | 18 ++++-----
.../resources/org/apache/camel/model/property.json | 4 +-
.../org/apache/camel/model/PropertyDefinition.java | 4 +-
.../camel/model/app/ApplicationDefinition.java | 2 +-
.../camel/model/app/BeanConstructorDefinition.java | 8 +++-
.../model/app/BeanConstructorsDefinition.java | 9 +++++
.../camel/model/app/BeanPropertiesDefinition.java | 9 +++++
.../camel/model/app/BeanPropertyDefinition.java | 15 ++++++++
.../apache/camel/model/app/BeansDefinition.java | 44 ++++++++++++++++------
.../camel/model/app/ComponentScanDefinition.java | 3 ++
.../camel/model/app/RegistryBeanDefinition.java | 39 ++++++++++++++++++-
15 files changed, 156 insertions(+), 57 deletions(-)
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/beans.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/beans.json
index 4c1976317d4..7724035e206 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/beans.json
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/beans.json
@@ -3,7 +3,7 @@
"kind": "model",
"name": "beans",
"title": "Beans",
- "description": "A grouping POJO (and related XML root element) that's historically associated with entire application (or its distinguished fragment). This class is not meant to be used with Camel Java DSL, but it's needed to generate XML Schema and MX parser methods.",
+ "description": "Container for beans, routes, and more.",
"deprecated": false,
"label": "configuration",
"javaType": "org.apache.camel.model.app.BeansDefinition",
@@ -12,13 +12,13 @@
"output": false
},
"properties": {
- "component-scan": { "index": 0, "kind": "element", "displayName": "Component-scan", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.ComponentScanDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Component scanning definition(s). But unlike package\/packageScan\/contextScan, we're not scanning only for org.apache.camel.builder.RouteBuilder." },
- "bean": { "index": 1, "kind": "element", "displayName": "Bean", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.RegistryBeanDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "restConfiguration": { "index": 2, "kind": "element", "displayName": "Rest Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "rest": { "index": 3, "kind": "element", "displayName": "Rest", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "routeConfiguration": { "index": 4, "kind": "element", "displayName": "Route Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "routeTemplate": { "index": 5, "kind": "element", "displayName": "Route Template", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteTemplateDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "templatedRoute": { "index": 6, "kind": "element", "displayName": "Templated Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.TemplatedRouteDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "route": { "index": 7, "kind": "element", "displayName": "Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteDefinition>", "deprecated": false, "autowired": false, "secret": false }
+ "component-scan": { "index": 0, "kind": "element", "displayName": "Component-scan", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.ComponentScanDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Component scanning that can auto-discover Camel route builders from the classpath." },
+ "bean": { "index": 1, "kind": "element", "displayName": "Bean", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.RegistryBeanDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "List of bean" },
+ "restConfiguration": { "index": 2, "kind": "element", "displayName": "Rest Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel Rest DSL Configuration" },
+ "rest": { "index": 3, "kind": "element", "displayName": "Rest", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel Rest DSL" },
+ "routeConfiguration": { "index": 4, "kind": "element", "displayName": "Route Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel route configurations" },
+ "routeTemplate": { "index": 5, "kind": "element", "displayName": "Route Template", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteTemplateDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel route templates" },
+ "templatedRoute": { "index": 6, "kind": "element", "displayName": "Templated Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.TemplatedRouteDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel routes to be created from template" },
+ "route": { "index": 7, "kind": "element", "displayName": "Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel routes" }
}
}
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/camel.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/camel.json
index 12af847b484..f70aa385088 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/camel.json
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/camel.json
@@ -3,7 +3,7 @@
"kind": "model",
"name": "camel",
"title": "Camel",
- "description": "If beans reminds Spring application too much, we can use camel.",
+ "description": "Root tag for Camel application, that can contain beans, routes, and more.",
"deprecated": false,
"label": "configuration",
"javaType": "org.apache.camel.model.app.ApplicationDefinition",
@@ -12,13 +12,13 @@
"output": false
},
"properties": {
- "component-scan": { "index": 0, "kind": "element", "displayName": "Component-scan", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.ComponentScanDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Component scanning definition(s). But unlike package\/packageScan\/contextScan, we're not scanning only for org.apache.camel.builder.RouteBuilder." },
- "bean": { "index": 1, "kind": "element", "displayName": "Bean", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.RegistryBeanDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "restConfiguration": { "index": 2, "kind": "element", "displayName": "Rest Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "rest": { "index": 3, "kind": "element", "displayName": "Rest", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "routeConfiguration": { "index": 4, "kind": "element", "displayName": "Route Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "routeTemplate": { "index": 5, "kind": "element", "displayName": "Route Template", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteTemplateDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "templatedRoute": { "index": 6, "kind": "element", "displayName": "Templated Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.TemplatedRouteDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "route": { "index": 7, "kind": "element", "displayName": "Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteDefinition>", "deprecated": false, "autowired": false, "secret": false }
+ "component-scan": { "index": 0, "kind": "element", "displayName": "Component-scan", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.ComponentScanDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Component scanning that can auto-discover Camel route builders from the classpath." },
+ "bean": { "index": 1, "kind": "element", "displayName": "Bean", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.RegistryBeanDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "List of bean" },
+ "restConfiguration": { "index": 2, "kind": "element", "displayName": "Rest Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel Rest DSL Configuration" },
+ "rest": { "index": 3, "kind": "element", "displayName": "Rest", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel Rest DSL" },
+ "routeConfiguration": { "index": 4, "kind": "element", "displayName": "Route Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel route configurations" },
+ "routeTemplate": { "index": 5, "kind": "element", "displayName": "Route Template", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteTemplateDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel route templates" },
+ "templatedRoute": { "index": 6, "kind": "element", "displayName": "Templated Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.TemplatedRouteDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel routes to be created from template" },
+ "route": { "index": 7, "kind": "element", "displayName": "Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel routes" }
}
}
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/property.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/property.json
index 641269cd3b6..9eafca8a960 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/property.json
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/property.json
@@ -12,7 +12,7 @@
"output": false
},
"properties": {
- "key": { "index": 0, "kind": "attribute", "displayName": "Key", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Property key" },
- "value": { "index": 1, "kind": "attribute", "displayName": "Value", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Property value" }
+ "key": { "index": 0, "kind": "attribute", "displayName": "Key", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The name of the property" },
+ "value": { "index": 1, "kind": "attribute", "displayName": "Value", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The property value." }
}
}
diff --git a/core/camel-core-model/src/generated/resources/org/apache/camel/model/app/beans.json b/core/camel-core-model/src/generated/resources/org/apache/camel/model/app/beans.json
index 4c1976317d4..7724035e206 100644
--- a/core/camel-core-model/src/generated/resources/org/apache/camel/model/app/beans.json
+++ b/core/camel-core-model/src/generated/resources/org/apache/camel/model/app/beans.json
@@ -3,7 +3,7 @@
"kind": "model",
"name": "beans",
"title": "Beans",
- "description": "A grouping POJO (and related XML root element) that's historically associated with entire application (or its distinguished fragment). This class is not meant to be used with Camel Java DSL, but it's needed to generate XML Schema and MX parser methods.",
+ "description": "Container for beans, routes, and more.",
"deprecated": false,
"label": "configuration",
"javaType": "org.apache.camel.model.app.BeansDefinition",
@@ -12,13 +12,13 @@
"output": false
},
"properties": {
- "component-scan": { "index": 0, "kind": "element", "displayName": "Component-scan", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.ComponentScanDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Component scanning definition(s). But unlike package\/packageScan\/contextScan, we're not scanning only for org.apache.camel.builder.RouteBuilder." },
- "bean": { "index": 1, "kind": "element", "displayName": "Bean", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.RegistryBeanDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "restConfiguration": { "index": 2, "kind": "element", "displayName": "Rest Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "rest": { "index": 3, "kind": "element", "displayName": "Rest", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "routeConfiguration": { "index": 4, "kind": "element", "displayName": "Route Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "routeTemplate": { "index": 5, "kind": "element", "displayName": "Route Template", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteTemplateDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "templatedRoute": { "index": 6, "kind": "element", "displayName": "Templated Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.TemplatedRouteDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "route": { "index": 7, "kind": "element", "displayName": "Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteDefinition>", "deprecated": false, "autowired": false, "secret": false }
+ "component-scan": { "index": 0, "kind": "element", "displayName": "Component-scan", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.ComponentScanDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Component scanning that can auto-discover Camel route builders from the classpath." },
+ "bean": { "index": 1, "kind": "element", "displayName": "Bean", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.RegistryBeanDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "List of bean" },
+ "restConfiguration": { "index": 2, "kind": "element", "displayName": "Rest Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel Rest DSL Configuration" },
+ "rest": { "index": 3, "kind": "element", "displayName": "Rest", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel Rest DSL" },
+ "routeConfiguration": { "index": 4, "kind": "element", "displayName": "Route Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel route configurations" },
+ "routeTemplate": { "index": 5, "kind": "element", "displayName": "Route Template", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteTemplateDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel route templates" },
+ "templatedRoute": { "index": 6, "kind": "element", "displayName": "Templated Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.TemplatedRouteDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel routes to be created from template" },
+ "route": { "index": 7, "kind": "element", "displayName": "Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel routes" }
}
}
diff --git a/core/camel-core-model/src/generated/resources/org/apache/camel/model/app/camel.json b/core/camel-core-model/src/generated/resources/org/apache/camel/model/app/camel.json
index 12af847b484..f70aa385088 100644
--- a/core/camel-core-model/src/generated/resources/org/apache/camel/model/app/camel.json
+++ b/core/camel-core-model/src/generated/resources/org/apache/camel/model/app/camel.json
@@ -3,7 +3,7 @@
"kind": "model",
"name": "camel",
"title": "Camel",
- "description": "If beans reminds Spring application too much, we can use camel.",
+ "description": "Root tag for Camel application, that can contain beans, routes, and more.",
"deprecated": false,
"label": "configuration",
"javaType": "org.apache.camel.model.app.ApplicationDefinition",
@@ -12,13 +12,13 @@
"output": false
},
"properties": {
- "component-scan": { "index": 0, "kind": "element", "displayName": "Component-scan", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.ComponentScanDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Component scanning definition(s). But unlike package\/packageScan\/contextScan, we're not scanning only for org.apache.camel.builder.RouteBuilder." },
- "bean": { "index": 1, "kind": "element", "displayName": "Bean", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.RegistryBeanDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "restConfiguration": { "index": 2, "kind": "element", "displayName": "Rest Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "rest": { "index": 3, "kind": "element", "displayName": "Rest", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "routeConfiguration": { "index": 4, "kind": "element", "displayName": "Route Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "routeTemplate": { "index": 5, "kind": "element", "displayName": "Route Template", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteTemplateDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "templatedRoute": { "index": 6, "kind": "element", "displayName": "Templated Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.TemplatedRouteDefinition>", "deprecated": false, "autowired": false, "secret": false },
- "route": { "index": 7, "kind": "element", "displayName": "Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteDefinition>", "deprecated": false, "autowired": false, "secret": false }
+ "component-scan": { "index": 0, "kind": "element", "displayName": "Component-scan", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.ComponentScanDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Component scanning that can auto-discover Camel route builders from the classpath." },
+ "bean": { "index": 1, "kind": "element", "displayName": "Bean", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.app.RegistryBeanDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "List of bean" },
+ "restConfiguration": { "index": 2, "kind": "element", "displayName": "Rest Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel Rest DSL Configuration" },
+ "rest": { "index": 3, "kind": "element", "displayName": "Rest", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel Rest DSL" },
+ "routeConfiguration": { "index": 4, "kind": "element", "displayName": "Route Configuration", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteConfigurationDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel route configurations" },
+ "routeTemplate": { "index": 5, "kind": "element", "displayName": "Route Template", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteTemplateDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel route templates" },
+ "templatedRoute": { "index": 6, "kind": "element", "displayName": "Templated Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.TemplatedRouteDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel routes to be created from template" },
+ "route": { "index": 7, "kind": "element", "displayName": "Route", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.RouteDefinition>", "deprecated": false, "autowired": false, "secret": false, "description": "Camel routes" }
}
}
diff --git a/core/camel-core-model/src/generated/resources/org/apache/camel/model/property.json b/core/camel-core-model/src/generated/resources/org/apache/camel/model/property.json
index 641269cd3b6..9eafca8a960 100644
--- a/core/camel-core-model/src/generated/resources/org/apache/camel/model/property.json
+++ b/core/camel-core-model/src/generated/resources/org/apache/camel/model/property.json
@@ -12,7 +12,7 @@
"output": false
},
"properties": {
- "key": { "index": 0, "kind": "attribute", "displayName": "Key", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Property key" },
- "value": { "index": 1, "kind": "attribute", "displayName": "Value", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Property value" }
+ "key": { "index": 0, "kind": "attribute", "displayName": "Key", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The name of the property" },
+ "value": { "index": 1, "kind": "attribute", "displayName": "Value", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The property value." }
}
}
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/PropertyDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/PropertyDefinition.java
index 97c835bbd39..3869693cf7c 100644
--- a/core/camel-core-model/src/main/java/org/apache/camel/model/PropertyDefinition.java
+++ b/core/camel-core-model/src/main/java/org/apache/camel/model/PropertyDefinition.java
@@ -47,7 +47,7 @@ public class PropertyDefinition {
}
/**
- * Property key
+ * The name of the property
*/
public void setKey(String key) {
this.key = key;
@@ -58,7 +58,7 @@ public class PropertyDefinition {
}
/**
- * Property value
+ * The property value.
*/
public void setValue(String value) {
this.value = value;
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/app/ApplicationDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/app/ApplicationDefinition.java
index 4b065387893..4d10af891e5 100644
--- a/core/camel-core-model/src/main/java/org/apache/camel/model/app/ApplicationDefinition.java
+++ b/core/camel-core-model/src/main/java/org/apache/camel/model/app/ApplicationDefinition.java
@@ -21,7 +21,7 @@ import jakarta.xml.bind.annotation.XmlRootElement;
import org.apache.camel.spi.Metadata;
/**
- * If "beans" reminds Spring application too much, we can use "camel".
+ * Root tag for Camel application, that can contain beans, routes, and more.
*/
@Metadata(label = "configuration")
@XmlRootElement(name = "camel")
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanConstructorDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanConstructorDefinition.java
index 72ce4c9f1ab..f1c2cfe77bf 100644
--- a/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanConstructorDefinition.java
+++ b/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanConstructorDefinition.java
@@ -21,6 +21,12 @@ import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlAttribute;
import jakarta.xml.bind.annotation.XmlType;
+import org.apache.camel.spi.Metadata;
+
+/**
+ * Bean constructor argument
+ */
+@Metadata(label = "configuration")
@XmlType
@XmlAccessorType(XmlAccessType.FIELD)
public class BeanConstructorDefinition {
@@ -35,7 +41,7 @@ public class BeanConstructorDefinition {
}
/**
- * Constructor index
+ * Constructor argument index. The first argument must use index 0.
*/
public void setIndex(Integer index) {
this.index = index;
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanConstructorsDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanConstructorsDefinition.java
index 11daaacd9cf..550cb745a94 100644
--- a/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanConstructorsDefinition.java
+++ b/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanConstructorsDefinition.java
@@ -23,6 +23,12 @@ import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlType;
+import org.apache.camel.spi.Metadata;
+
+/**
+ * Bean constructor arguments
+ */
+@Metadata(label = "configuration")
@XmlType
@XmlAccessorType(XmlAccessType.FIELD)
public class BeanConstructorsDefinition {
@@ -34,6 +40,9 @@ public class BeanConstructorsDefinition {
return constructors;
}
+ /**
+ * Constructor arguments
+ */
public void setConstructors(List<BeanConstructorDefinition> constructors) {
this.constructors = constructors;
}
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanPropertiesDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanPropertiesDefinition.java
index 73cec258070..7bf00ba9244 100644
--- a/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanPropertiesDefinition.java
+++ b/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanPropertiesDefinition.java
@@ -23,6 +23,12 @@ import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlType;
+import org.apache.camel.spi.Metadata;
+
+/**
+ * Bean properties
+ */
+@Metadata(label = "configuration")
@XmlType
@XmlAccessorType(XmlAccessType.FIELD)
public class BeanPropertiesDefinition {
@@ -34,6 +40,9 @@ public class BeanPropertiesDefinition {
return properties;
}
+ /**
+ * Bean properties
+ */
public void setProperties(List<BeanPropertyDefinition> properties) {
this.properties = properties;
}
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanPropertyDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanPropertyDefinition.java
index 39f28f2abdc..d48184e5508 100644
--- a/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanPropertyDefinition.java
+++ b/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeanPropertyDefinition.java
@@ -22,6 +22,12 @@ import jakarta.xml.bind.annotation.XmlAttribute;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlType;
+import org.apache.camel.spi.Metadata;
+
+/**
+ * Bean property
+ */
+@Metadata(label = "configuration")
@XmlType
@XmlAccessorType(XmlAccessType.FIELD)
public class BeanPropertyDefinition {
@@ -37,6 +43,9 @@ public class BeanPropertyDefinition {
return key;
}
+ /**
+ * The name of the property
+ */
public void setKey(String key) {
this.key = key;
}
@@ -45,6 +54,9 @@ public class BeanPropertyDefinition {
return value;
}
+ /**
+ * The property value
+ */
public void setValue(String value) {
this.value = value;
}
@@ -53,6 +65,9 @@ public class BeanPropertyDefinition {
return properties;
}
+ /**
+ * Optional nested properties.
+ */
public void setProperties(BeanPropertiesDefinition properties) {
this.properties = properties;
}
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeansDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeansDefinition.java
index a8230ccff11..383505352fd 100644
--- a/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeansDefinition.java
+++ b/core/camel-core-model/src/main/java/org/apache/camel/model/app/BeansDefinition.java
@@ -38,13 +38,7 @@ import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.annotations.ExternalSchemaElement;
/**
- * <p>
- * A grouping POJO (and related XML root element) that's historically associated with "entire application" (or its
- * distinguished fragment).
- * </p>
- * <p>
- * This class is not meant to be used with Camel Java DSL, but it's needed to generate XML Schema and MX parser methods.
- * </p>
+ * Container for beans, routes, and more.
*/
@Metadata(label = "configuration")
@XmlRootElement(name = "beans")
@@ -63,10 +57,8 @@ import org.apache.camel.spi.annotations.ExternalSchemaElement;
@XmlAccessorType(XmlAccessType.FIELD)
public class BeansDefinition {
- /**
- * Component scanning definition(s). But unlike package/packageScan/contextScan, we're not scanning only for
- * org.apache.camel.builder.RouteBuilder.
- */
+ // This class is not meant to be used with Camel Java DSL, but it's needed to generate XML Schema and MX parser methods
+
@XmlElement(name = "component-scan")
private List<ComponentScanDefinition> componentScanning = new ArrayList<>();
@@ -113,6 +105,9 @@ public class BeansDefinition {
return componentScanning;
}
+ /**
+ * Component scanning that can auto-discover Camel route builders from the classpath.
+ */
public void setComponentScanning(List<ComponentScanDefinition> componentScanning) {
this.componentScanning = componentScanning;
}
@@ -121,6 +116,9 @@ public class BeansDefinition {
return beans;
}
+ /**
+ * List of bean
+ */
public void setBeans(List<RegistryBeanDefinition> beans) {
this.beans = beans;
}
@@ -129,6 +127,9 @@ public class BeansDefinition {
return springBeans;
}
+ /**
+ * Spring XML beans
+ */
public void setSpringBeans(List<Element> springBeans) {
this.springBeans = springBeans;
}
@@ -137,6 +138,9 @@ public class BeansDefinition {
return blueprintBeans;
}
+ /**
+ * Blueprint XML beans
+ */
public void setBlueprintBeans(List<Element> blueprintBeans) {
this.blueprintBeans = blueprintBeans;
}
@@ -145,6 +149,9 @@ public class BeansDefinition {
return restConfigurations;
}
+ /**
+ * Camel Rest DSL Configuration
+ */
public void setRestConfigurations(List<RestConfigurationDefinition> restConfigs) {
this.restConfigurations = restConfigs;
}
@@ -153,6 +160,9 @@ public class BeansDefinition {
return rests;
}
+ /**
+ * Camel Rest DSL
+ */
public void setRests(List<RestDefinition> rests) {
this.rests = rests;
}
@@ -161,6 +171,9 @@ public class BeansDefinition {
return routeConfigurations;
}
+ /**
+ * Camel route configurations
+ */
public void setRouteConfigurations(List<RouteConfigurationDefinition> routeConfigurations) {
this.routeConfigurations = routeConfigurations;
}
@@ -169,6 +182,9 @@ public class BeansDefinition {
return routeTemplates;
}
+ /**
+ * Camel route templates
+ */
public void setRouteTemplates(List<RouteTemplateDefinition> routeTemplates) {
this.routeTemplates = routeTemplates;
}
@@ -177,6 +193,9 @@ public class BeansDefinition {
return templatedRoutes;
}
+ /**
+ * Camel routes to be created from template
+ */
public void setTemplatedRoutes(List<TemplatedRouteDefinition> templatedRoutes) {
this.templatedRoutes = templatedRoutes;
}
@@ -185,6 +204,9 @@ public class BeansDefinition {
return routes;
}
+ /**
+ * Camel routes
+ */
public void setRoutes(List<RouteDefinition> routes) {
this.routes = routes;
}
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/app/ComponentScanDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/app/ComponentScanDefinition.java
index fca0594f3f4..0c683d48947 100644
--- a/core/camel-core-model/src/main/java/org/apache/camel/model/app/ComponentScanDefinition.java
+++ b/core/camel-core-model/src/main/java/org/apache/camel/model/app/ComponentScanDefinition.java
@@ -47,6 +47,9 @@ public class ComponentScanDefinition {
return basePackage;
}
+ /**
+ * Base package to use for scanning Spring beans.
+ */
public void setBasePackage(String basePackage) {
this.basePackage = basePackage;
}
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/app/RegistryBeanDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/app/RegistryBeanDefinition.java
index 943d89b0ae3..6c1b8da40f4 100644
--- a/core/camel-core-model/src/main/java/org/apache/camel/model/app/RegistryBeanDefinition.java
+++ b/core/camel-core-model/src/main/java/org/apache/camel/model/app/RegistryBeanDefinition.java
@@ -31,8 +31,7 @@ import org.apache.camel.spi.Resource;
import org.apache.camel.spi.ResourceAware;
/**
- * A Pojo representing simplified "bean" element to declare registry beans using any DSL. This is not the same as "bean
- * processor".
+ * Define custom beans that can be used in your Camel routes and in general.
*/
@Metadata(label = "configuration")
@XmlType
@@ -71,6 +70,9 @@ public class RegistryBeanDefinition implements ResourceAware {
return name;
}
+ /**
+ * The name of the bean (bean id)
+ */
public void setName(String name) {
this.name = name;
}
@@ -79,6 +81,9 @@ public class RegistryBeanDefinition implements ResourceAware {
return type;
}
+ /**
+ * The class name (fully qualified) of the bean
+ */
public void setType(String type) {
this.type = type;
}
@@ -87,6 +92,10 @@ public class RegistryBeanDefinition implements ResourceAware {
return initMethod;
}
+ /**
+ * The name of the custom initialization method to invoke after setting bean properties. The method must have no
+ * arguments, but may throw any exception.
+ */
public void setInitMethod(String initMethod) {
this.initMethod = initMethod;
}
@@ -95,6 +104,10 @@ public class RegistryBeanDefinition implements ResourceAware {
return destroyMethod;
}
+ /**
+ * The name of the custom destroy method to invoke on bean shutdown, such as when Camel is shutting down. The method
+ * must have no arguments, but may throw any exception.
+ */
public void setDestroyMethod(String destroyMethod) {
this.destroyMethod = destroyMethod;
}
@@ -103,6 +116,9 @@ public class RegistryBeanDefinition implements ResourceAware {
return factoryMethod;
}
+ /**
+ * Name of method to invoke when creating the bean via a factory bean.
+ */
public void setFactoryMethod(String factoryMethod) {
this.factoryMethod = factoryMethod;
}
@@ -111,6 +127,9 @@ public class RegistryBeanDefinition implements ResourceAware {
return factoryBean;
}
+ /**
+ * Name of factory bean (bean id) to use for creating the bean.
+ */
public void setFactoryBean(String factoryBean) {
this.factoryBean = factoryBean;
}
@@ -119,6 +138,10 @@ public class RegistryBeanDefinition implements ResourceAware {
return constructors;
}
+ /**
+ * Optional constructor arguments for creating the bean. Arguments correspond to specific index of the constructor
+ * argument list, starting from zero.
+ */
public void setConstructors(Map<Integer, Object> constructors) {
this.constructors = constructors;
}
@@ -127,6 +150,9 @@ public class RegistryBeanDefinition implements ResourceAware {
return properties;
}
+ /**
+ * Optional properties to set on the created bean.
+ */
public void setProperties(Map<String, Object> properties) {
this.properties = properties;
}
@@ -135,10 +161,19 @@ public class RegistryBeanDefinition implements ResourceAware {
return scriptLanguage;
}
+ /**
+ * The script language to use when using inlined script for creating the bean, such as groovy, java, javascript etc.
+ */
public void setScriptLanguage(String scriptLanguage) {
this.scriptLanguage = scriptLanguage;
}
+ /**
+ * The script to execute that creates the bean when using scripting languages.
+ *
+ * If the script use the prefix <tt>resource:</tt> such as <tt>resource:classpath:com/foo/myscript.groovy</tt>,
+ * <tt>resource:file:/var/myscript.groovy</tt>, then its loaded from the external resource.
+ */
public void setScript(String script) {
this.script = script;
}