This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 0e5980bd1f2 CAMEL-20891: Improve the catalog documentation for
Processor's Ref attribute.
0e5980bd1f2 is described below
commit 0e5980bd1f28aba558681b6ec200b69d9210c390
Author: Claus Ibsen <[email protected]>
AuthorDate: Thu Jun 20 13:21:50 2024 +0200
CAMEL-20891: Improve the catalog documentation for Processor's Ref
attribute.
---
.../resources/org/apache/camel/catalog/models/process.json | 2 +-
.../resources/META-INF/org/apache/camel/model/process.json | 2 +-
.../main/java/org/apache/camel/model/ProcessDefinition.java | 10 +++++++++-
.../camel/dsl/yaml/deserializers/ModelDeserializers.java | 2 +-
.../src/generated/resources/schema/camelYamlDsl.json | 2 +-
5 files changed, 13 insertions(+), 5 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/process.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/process.json
index 6b296b1f352..0193b3fd5cf 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/process.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/process.json
@@ -15,6 +15,6 @@
"id": { "index": 0, "kind": "attribute", "displayName": "Id", "group":
"common", "required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the id of this node" },
"description": { "index": 1, "kind": "attribute", "displayName":
"Description", "group": "common", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Sets the description of this node" },
"disabled": { "index": 2, "kind": "attribute", "displayName": "Disabled",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Whether to disable this
EIP from the route during build time. Once an EIP has been disabled then it
cannot be enabled later at runtime." },
- "ref": { "index": 3, "kind": "attribute", "displayName": "Ref", "group":
"common", "required": true, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description":
"Reference to the Processor to lookup in the registry to use. Can also be used
for creating new beans by their class name by prefixing with #class, eg
#class:com.foo.MyClassType. And it is also possible to refer to singleton beans
by their type in the registry by [...]
+ "ref": { "index": 3, "kind": "attribute", "displayName": "Ref", "group":
"common", "required": true, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description":
"Reference to the Processor to lookup in the registry to use. A Processor is a
class of type org.apache.camel.Processor, which can are to be called by this
EIP. In this processor you have custom Java code, that can work with the
message, such as to do custom busin [...]
}
}
diff --git
a/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/process.json
b/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/process.json
index 6b296b1f352..0193b3fd5cf 100644
---
a/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/process.json
+++
b/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/process.json
@@ -15,6 +15,6 @@
"id": { "index": 0, "kind": "attribute", "displayName": "Id", "group":
"common", "required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the id of this node" },
"description": { "index": 1, "kind": "attribute", "displayName":
"Description", "group": "common", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Sets the description of this node" },
"disabled": { "index": 2, "kind": "attribute", "displayName": "Disabled",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Whether to disable this
EIP from the route during build time. Once an EIP has been disabled then it
cannot be enabled later at runtime." },
- "ref": { "index": 3, "kind": "attribute", "displayName": "Ref", "group":
"common", "required": true, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description":
"Reference to the Processor to lookup in the registry to use. Can also be used
for creating new beans by their class name by prefixing with #class, eg
#class:com.foo.MyClassType. And it is also possible to refer to singleton beans
by their type in the registry by [...]
+ "ref": { "index": 3, "kind": "attribute", "displayName": "Ref", "group":
"common", "required": true, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description":
"Reference to the Processor to lookup in the registry to use. A Processor is a
class of type org.apache.camel.Processor, which can are to be called by this
EIP. In this processor you have custom Java code, that can work with the
message, such as to do custom busin [...]
}
}
diff --git
a/core/camel-core-model/src/main/java/org/apache/camel/model/ProcessDefinition.java
b/core/camel-core-model/src/main/java/org/apache/camel/model/ProcessDefinition.java
index 88aba3104cd..4774bc7a34d 100644
---
a/core/camel-core-model/src/main/java/org/apache/camel/model/ProcessDefinition.java
+++
b/core/camel-core-model/src/main/java/org/apache/camel/model/ProcessDefinition.java
@@ -100,9 +100,17 @@ public class ProcessDefinition extends
NoOutputDefinition<ProcessDefinition> {
/**
* Reference to the Processor to lookup in the registry to use.
*
+ * A Processor is a class of type org.apache.camel.Processor, which
+ * can are to be called by this EIP. In this processor you have custom
Java code,
+ * that can work with the message, such as to do custom business logic,
+ * special message manipulations and so on.
+ *
+ * By default, the ref, will lookup the bean in the Camel registry.
+ *
+ * The ref can use prefix that controls how the processor is obtained.
+ * You can use #bean:myBean where myBean is the id of the Camel processor
(lookup).
* Can also be used for creating new beans by their class name by
prefixing with #class, eg
* #class:com.foo.MyClassType.
- *
* And it is also possible to refer to singleton beans by their type in
the registry by prefixing with #type:
* syntax, eg #type:com.foo.MyClassType
*/
diff --git
a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
index e3157f6b076..52fdd9f59cb 100644
---
a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
+++
b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
@@ -11917,7 +11917,7 @@ public final class ModelDeserializers extends
YamlDeserializerSupport {
@YamlProperty(name = "disabled", type = "boolean",
description = "Whether to disable this EIP from the route during build time.
Once an EIP has been disabled then it cannot be enabled later at runtime.",
displayName = "Disabled"),
@YamlProperty(name = "id", type = "string", description =
"Sets the id of this node", displayName = "Id"),
@YamlProperty(name = "inheritErrorHandler", type =
"boolean"),
- @YamlProperty(name = "ref", type = "string", required =
true, description = "Reference to the Processor to lookup in the registry to
use. Can also be used for creating new beans by their class name by prefixing
with #class, eg #class:com.foo.MyClassType. And it is also possible to refer to
singleton beans by their type in the registry by prefixing with #type: syntax,
eg #type:com.foo.MyClassType", displayName = "Ref")
+ @YamlProperty(name = "ref", type = "string", required =
true, description = "Reference to the Processor to lookup in the registry to
use. A Processor is a class of type org.apache.camel.Processor, which can are
to be called by this EIP. In this processor you have custom Java code, that can
work with the message, such as to do custom business logic, special message
manipulations and so on. By default, the ref, will lookup the bean in the Camel
registry. The ref can use [...]
}
)
public static class ProcessDefinitionDeserializer extends
YamlDeserializerBase<ProcessDefinition> {
diff --git
a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
index b5f23143d54..512a6bb3174 100644
---
a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
+++
b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
@@ -3999,7 +3999,7 @@
"ref" : {
"type" : "string",
"title" : "Ref",
- "description" : "Reference to the Processor to lookup in the
registry to use. Can also be used for creating new beans by their class name by
prefixing with #class, eg #class:com.foo.MyClassType. And it is also possible
to refer to singleton beans by their type in the registry by prefixing with
#type: syntax, eg #type:com.foo.MyClassType"
+ "description" : "Reference to the Processor to lookup in the
registry to use. A Processor is a class of type org.apache.camel.Processor,
which can are to be called by this EIP. In this processor you have custom Java
code, that can work with the message, such as to do custom business logic,
special message manipulations and so on. By default, the ref, will lookup the
bean in the Camel registry. The ref can use prefix that controls how the
processor is obtained. You can use #be [...]
}
},
"required" : [ "ref" ]
