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 2024/01/23 15:29:56 UTC
(camel) 06/19: CAMEL-19749: EIPs should make it easy to use together with variables.
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch var
in repository https://gitbox.apache.org/repos/asf/camel.git
commit a3598762425a7e5f82ee8c7d6a29c5c45e041504
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Sat Jan 20 10:31:12 2024 +0100
CAMEL-19749: EIPs should make it easy to use together with variables.
---
.../resources/org/apache/camel/model/to.json | 6 ++-
.../apache/camel/model/ProcessorDefinition.java | 16 +++++++
.../java/org/apache/camel/model/ToDefinition.java | 36 +++++++++++++++
.../org/apache/camel/processor/SendProcessor.java | 18 ++++++++
.../java/org/apache/camel/reifier/SendReifier.java | 12 ++---
.../org/apache/camel/processor/ToVariableTest.java | 51 ++++++++++++++++++++++
.../java/org/apache/camel/xml/in/ModelParser.java | 10 +++--
.../java/org/apache/camel/xml/out/ModelWriter.java | 2 +
.../org/apache/camel/yaml/out/ModelWriter.java | 2 +
.../dsl/yaml/deserializers/ModelDeserializers.java | 14 +++++-
.../generated/resources/schema/camelYamlDsl.json | 6 +++
11 files changed, 161 insertions(+), 12 deletions(-)
diff --git a/core/camel-core-model/src/generated/resources/org/apache/camel/model/to.json b/core/camel-core-model/src/generated/resources/org/apache/camel/model/to.json
index 053e6c95045..8f8698291c4 100644
--- a/core/camel-core-model/src/generated/resources/org/apache/camel/model/to.json
+++ b/core/camel-core-model/src/generated/resources/org/apache/camel/model/to.json
@@ -15,7 +15,9 @@
"id": { "index": 0, "kind": "attribute", "displayName": "Id", "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": "element", "displayName": "Description", "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", "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." },
- "uri": { "index": 3, "kind": "attribute", "displayName": "Uri", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the uri of the endpoint to send to." },
- "pattern": { "index": 4, "kind": "attribute", "displayName": "Pattern", "label": "advanced", "required": false, "type": "enum", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the optional ExchangePattern used to invoke this endpoint" }
+ "variableSend": { "index": 3, "kind": "attribute", "displayName": "Variable Send", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "To use a variable as the source for the message body to send. This makes it handy to use variables for user data and to easily control what data to use for sending and receiving. Important: When using send variable then the message body is taken from this variab [...]
+ "variableReceive": { "index": 4, "kind": "attribute", "displayName": "Variable Receive", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "To use a variable to store the received message body (only body, not headers). This is handy for easy access to the received message body via variables. Important: When using receive variable then the received body is stored only in this variable and not o [...]
+ "uri": { "index": 5, "kind": "attribute", "displayName": "Uri", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the uri of the endpoint to send to." },
+ "pattern": { "index": 6, "kind": "attribute", "displayName": "Pattern", "label": "advanced", "required": false, "type": "enum", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the optional ExchangePattern used to invoke this endpoint" }
}
}
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/ProcessorDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/ProcessorDefinition.java
index 27e520df1ac..b4bf7f5605f 100644
--- a/core/camel-core-model/src/main/java/org/apache/camel/model/ProcessorDefinition.java
+++ b/core/camel-core-model/src/main/java/org/apache/camel/model/ProcessorDefinition.java
@@ -255,6 +255,22 @@ public abstract class ProcessorDefinition<Type extends ProcessorDefinition<Type>
return asType();
}
+ /**
+ * Sends the exchange to the given endpoint
+ *
+ * @param uri the endpoint to send to
+ * @param variableSend to use a variable as the source for the message body to send.
+ * @param variableReceive to use a variable to store the received message body (only body, not headers).
+ * @return the builder
+ */
+ public Type toV(@AsEndpointUri String uri, String variableSend, String variableReceive) {
+ ToDefinition to = new ToDefinition(uri);
+ to.setVariableSend(variableSend);
+ to.setVariableReceive(variableReceive);
+ addOutput(to);
+ return asType();
+ }
+
/**
* Sends the exchange to the given dynamic endpoint
*
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/ToDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/ToDefinition.java
index eb889cd24b8..4b4864e59c8 100644
--- a/core/camel-core-model/src/main/java/org/apache/camel/model/ToDefinition.java
+++ b/core/camel-core-model/src/main/java/org/apache/camel/model/ToDefinition.java
@@ -23,6 +23,7 @@ import jakarta.xml.bind.annotation.XmlRootElement;
import org.apache.camel.Endpoint;
import org.apache.camel.ExchangePattern;
+import org.apache.camel.Message;
import org.apache.camel.builder.EndpointProducerBuilder;
import org.apache.camel.spi.Metadata;
@@ -34,6 +35,10 @@ import org.apache.camel.spi.Metadata;
@XmlAccessorType(XmlAccessType.FIELD)
public class ToDefinition extends SendDefinition<ToDefinition> {
+ @XmlAttribute
+ private String variableSend;
+ @XmlAttribute
+ private String variableReceive;
@XmlAttribute
@Metadata(label = "advanced", javaType = "org.apache.camel.ExchangePattern", enums = "InOnly,InOut")
private String pattern;
@@ -93,4 +98,35 @@ public class ToDefinition extends SendDefinition<ToDefinition> {
this.pattern = pattern;
}
+ public String getVariableSend() {
+ return variableSend;
+ }
+
+ /**
+ * To use a variable as the source for the message body to send.
+ * This makes it handy to use variables for user data and to easily control what data to use for sending and receiving.
+ *
+ * Important: When using send variable then the message body
+ * is taken from this variable instead of the current {@link Message}, however
+ * the headers from the {@link Message} will still be used as well. In other words,
+ * the variable is used instead of the message body, but everything else is as usual.
+ */
+ public void setVariableSend(String variableSend) {
+ this.variableSend = variableSend;
+ }
+
+ public String getVariableReceive() {
+ return variableReceive;
+ }
+
+ /**
+ * To use a variable to store the received message body (only body, not headers).
+ * This is handy for easy access to the received message body via variables.
+ *
+ * Important: When using receive variable then the received body is stored
+ * only in this variable and <b>not</b> on the current {@link org.apache.camel.Message}.
+ */
+ public void setVariableReceive(String variableReceive) {
+ this.variableReceive = variableReceive;
+ }
}
diff --git a/core/camel-core-processor/src/main/java/org/apache/camel/processor/SendProcessor.java b/core/camel-core-processor/src/main/java/org/apache/camel/processor/SendProcessor.java
index 516da700ce2..326f103a4cc 100644
--- a/core/camel-core-processor/src/main/java/org/apache/camel/processor/SendProcessor.java
+++ b/core/camel-core-processor/src/main/java/org/apache/camel/processor/SendProcessor.java
@@ -56,6 +56,8 @@ public class SendProcessor extends AsyncProcessorSupport implements Traceable, E
protected ProducerCache producerCache;
protected AsyncProducer producer;
protected final Endpoint destination;
+ protected String variableSend;
+ protected String variableReceive;
protected ExchangePattern destinationExchangePattern;
protected String id;
protected String routeId;
@@ -201,6 +203,22 @@ public class SendProcessor extends AsyncProcessorSupport implements Traceable, E
}
}
+ public String getVariableSend() {
+ return variableSend;
+ }
+
+ public void setVariableSend(String variableSend) {
+ this.variableSend = variableSend;
+ }
+
+ public String getVariableReceive() {
+ return variableReceive;
+ }
+
+ public void setVariableReceive(String variableReceive) {
+ this.variableReceive = variableReceive;
+ }
+
public Endpoint getDestination() {
return destination;
}
diff --git a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/SendReifier.java b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/SendReifier.java
index 3f6f4b1f504..4eaa13a4f17 100644
--- a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/SendReifier.java
+++ b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/SendReifier.java
@@ -22,20 +22,22 @@ import org.apache.camel.LineNumberAware;
import org.apache.camel.Processor;
import org.apache.camel.Route;
import org.apache.camel.model.ProcessorDefinition;
-import org.apache.camel.model.SendDefinition;
+import org.apache.camel.model.ToDefinition;
import org.apache.camel.processor.SendProcessor;
import org.apache.camel.support.CamelContextHelper;
-public class SendReifier extends ProcessorReifier<SendDefinition<?>> {
+public class SendReifier extends ProcessorReifier<ToDefinition> {
public SendReifier(Route route, ProcessorDefinition<?> definition) {
- super(route, (SendDefinition) definition);
+ super(route, (ToDefinition) definition);
}
@Override
public Processor createProcessor() throws Exception {
- Endpoint endpoint = resolveEndpoint();
- return new SendProcessor(endpoint, parse(ExchangePattern.class, definition.getPattern()));
+ SendProcessor answer = new SendProcessor(resolveEndpoint(), parse(ExchangePattern.class, definition.getPattern()));
+ answer.setVariableSend(definition.getVariableSend());
+ answer.setVariableReceive(definition.getVariableReceive());
+ return answer;
}
public Endpoint resolveEndpoint() {
diff --git a/core/camel-core/src/test/java/org/apache/camel/processor/ToVariableTest.java b/core/camel-core/src/test/java/org/apache/camel/processor/ToVariableTest.java
new file mode 100644
index 00000000000..561ca0a06b0
--- /dev/null
+++ b/core/camel-core/src/test/java/org/apache/camel/processor/ToVariableTest.java
@@ -0,0 +1,51 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.camel.processor;
+
+import org.apache.camel.ContextTestSupport;
+import org.apache.camel.builder.RouteBuilder;
+import org.junit.jupiter.api.Test;
+
+public class ToVariableTest extends ContextTestSupport {
+
+ @Test
+ public void testOriginalBody() throws Exception {
+ getMockEndpoint("mock:after").expectedBodiesReceived("World");
+ getMockEndpoint("mock:result").expectedBodiesReceived("World");
+
+ template.sendBody("direct:start", "World");
+
+ assertMockEndpointsSatisfied();
+ }
+
+ @Override
+ protected RouteBuilder createRouteBuilder() throws Exception {
+ return new RouteBuilder() {
+ @Override
+ public void configure() throws Exception {
+ from("direct:start")
+ .toV("direct:foo", null, "bye")
+ .to("mock:after")
+ .setBody(simple("${variable:bye}"))
+ .to("mock:result");
+
+ from("direct:foo")
+ .transform().simple("Bye ${body}");
+ }
+ };
+ }
+}
diff --git a/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java b/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java
index f542022a12f..a2b661193ca 100644
--- a/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java
+++ b/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java
@@ -1528,11 +1528,13 @@ public class ModelParser extends BaseParser {
}
protected ToDefinition doParseToDefinition() throws IOException, XmlPullParserException {
return doParse(new ToDefinition(), (def, key, val) -> {
- if ("pattern".equals(key)) {
- def.setPattern(val);
- return true;
+ switch (key) {
+ case "pattern": def.setPattern(val); break;
+ case "variableReceive": def.setVariableReceive(val); break;
+ case "variableSend": def.setVariableSend(val); break;
+ default: return sendDefinitionAttributeHandler().accept(def, key, val);
}
- return sendDefinitionAttributeHandler().accept(def, key, val);
+ return true;
}, optionalIdentifiedDefinitionElementHandler(), noValueHandler());
}
protected <T extends SendDefinition> AttributeHandler<T> sendDefinitionAttributeHandler() {
diff --git a/core/camel-xml-io/src/generated/java/org/apache/camel/xml/out/ModelWriter.java b/core/camel-xml-io/src/generated/java/org/apache/camel/xml/out/ModelWriter.java
index fd48d046a6c..7e16687fce7 100644
--- a/core/camel-xml-io/src/generated/java/org/apache/camel/xml/out/ModelWriter.java
+++ b/core/camel-xml-io/src/generated/java/org/apache/camel/xml/out/ModelWriter.java
@@ -2428,6 +2428,8 @@ public class ModelWriter extends BaseWriter {
throws IOException {
startElement(name);
doWriteSendDefinitionAttributes(def);
+ doWriteAttribute("variableReceive", def.getVariableReceive());
+ doWriteAttribute("variableSend", def.getVariableSend());
doWriteAttribute("pattern", def.getPattern());
endElement(name);
}
diff --git a/core/camel-yaml-io/src/generated/java/org/apache/camel/yaml/out/ModelWriter.java b/core/camel-yaml-io/src/generated/java/org/apache/camel/yaml/out/ModelWriter.java
index 0f2cf3ae648..da3fa16773b 100644
--- a/core/camel-yaml-io/src/generated/java/org/apache/camel/yaml/out/ModelWriter.java
+++ b/core/camel-yaml-io/src/generated/java/org/apache/camel/yaml/out/ModelWriter.java
@@ -2428,6 +2428,8 @@ public class ModelWriter extends BaseWriter {
throws IOException {
startElement(name);
doWriteSendDefinitionAttributes(def);
+ doWriteAttribute("variableReceive", def.getVariableReceive());
+ doWriteAttribute("variableSend", def.getVariableSend());
doWriteAttribute("pattern", def.getPattern());
endElement(name);
}
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 a5b552a0785..aea4c113504 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
@@ -18050,7 +18050,9 @@ public final class ModelDeserializers extends YamlDeserializerSupport {
@YamlProperty(name = "inheritErrorHandler", type = "boolean"),
@YamlProperty(name = "parameters", type = "object"),
@YamlProperty(name = "pattern", type = "enum:InOnly,InOut", description = "Sets the optional ExchangePattern used to invoke this endpoint", displayName = "Pattern"),
- @YamlProperty(name = "uri", type = "string", required = true, description = "Sets the uri of the endpoint to send to.", displayName = "Uri")
+ @YamlProperty(name = "uri", type = "string", required = true, description = "Sets the uri of the endpoint to send to.", displayName = "Uri"),
+ @YamlProperty(name = "variableReceive", type = "string"),
+ @YamlProperty(name = "variableSend", type = "string")
}
)
public static class ToDefinitionDeserializer extends YamlDeserializerEndpointAwareBase<ToDefinition> {
@@ -18099,6 +18101,16 @@ public final class ModelDeserializers extends YamlDeserializerSupport {
target.setUri(val);
break;
}
+ case "variableReceive": {
+ String val = asText(node);
+ target.setVariableReceive(val);
+ break;
+ }
+ case "variableSend": {
+ String val = asText(node);
+ target.setVariableSend(val);
+ break;
+ }
case "id": {
String val = asText(node);
target.setId(val);
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 6964a70e2b1..87797184ab2 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
@@ -6849,6 +6849,12 @@
"type" : "string",
"title" : "Uri",
"description" : "Sets the uri of the endpoint to send to."
+ },
+ "variableReceive" : {
+ "type" : "string"
+ },
+ "variableSend" : {
+ "type" : "string"
}
}
} ],