This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch camel-4.18.x
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/camel-4.18.x by this push:
new ff40766b6544 CAMEL-23094: camel-core - Saga EIP fix model for
completion and compensation (#21628)
ff40766b6544 is described below
commit ff40766b654468701d9cb6af8b7a0b2c8279ecdc
Author: Claus Ibsen <[email protected]>
AuthorDate: Fri Feb 27 14:17:54 2026 +0100
CAMEL-23094: camel-core - Saga EIP fix model for completion and
compensation (#21628)
---
.../org/apache/camel/catalog/models/saga.json | 4 +-
.../apache/camel/catalog/schemas/camel-spring.xsd | 83 ++-
.../apache/camel/catalog/schemas/camel-xml-io.xsd | 83 ++-
.../org/apache/camel/spring/processor/saga.xml | 4 +-
.../org/apache/camel/spring/processor/sagaRef.xml | 4 +-
.../src/main/docs/modules/eips/pages/saga-eip.adoc | 597 ++++++++++++++++++---
.../META-INF/org/apache/camel/model/saga.json | 4 +-
.../camel/model/SagaActionUriDefinition.java | 51 --
.../org/apache/camel/model/SagaDefinition.java | 67 ++-
.../java/org/apache/camel/reifier/SagaReifier.java | 46 +-
.../test/resources/org/apache/camel/model/saga.xml | 18 +-
.../java/org/apache/camel/xml/in/ModelParser.java | 7 +-
.../java/org/apache/camel/xml/out/ModelWriter.java | 9 +-
core/camel-xml-io/src/test/resources/saga.xml | 4 +-
.../org/apache/camel/yaml/out/ModelWriter.java | 9 +-
.../org/apache/camel/yaml/out/ModelWriterTest.java | 2 +
.../camel-yaml-dsl-deserializers/pom.xml | 4 -
.../dsl/yaml/deserializers/ModelDeserializers.java | 81 +--
.../deserializers/ModelDeserializersResolver.java | 1 -
.../generated/resources/schema/camelYamlDsl.json | 37 +-
.../org/apache/camel/dsl/yaml/SagaTest.groovy | 41 +-
21 files changed, 720 insertions(+), 436 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/saga.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/saga.json
index 1334df81a513..15543e203db7 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/saga.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/saga.json
@@ -20,8 +20,8 @@
"propagation": { "index": 5, "kind": "attribute", "displayName":
"Propagation", "group": "advanced", "label": "advanced", "required": false,
"type": "enum", "javaType": "org.apache.camel.model.SagaPropagation", "enum": [
"REQUIRED", "REQUIRES_NEW", "MANDATORY", "SUPPORTS", "NOT_SUPPORTED", "NEVER"
], "deprecated": false, "autowired": false, "secret": false, "defaultValue":
"REQUIRED", "description": "Set the Saga propagation mode (REQUIRED,
REQUIRES_NEW, MANDATORY, SUPPORTS, NOT_SUPP [...]
"completionMode": { "index": 6, "kind": "attribute", "displayName":
"Completion Mode", "group": "advanced", "label": "advanced", "required": false,
"type": "enum", "javaType": "org.apache.camel.model.SagaCompletionMode",
"enum": [ "AUTO", "MANUAL" ], "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "AUTO", "description": "Determine how the saga
should be considered complete. When set to AUTO, the saga is completed when the
exchange that initiates the saga is [...]
"timeout": { "index": 7, "kind": "attribute", "displayName": "Timeout",
"group": "common", "required": false, "type": "duration", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Set the maximum amount of time for the Saga. After the timeout
is expired, the saga will be compensated automatically (unless a different
decision has been taken in the meantime)." },
- "compensation": { "index": 8, "kind": "element", "displayName":
"Compensation", "group": "common", "required": false, "type": "object",
"javaType": "org.apache.camel.model.SagaActionUriDefinition", "deprecated":
false, "autowired": false, "secret": false, "description": "The compensation
endpoint URI that must be called to compensate all changes done in the route.
The route corresponding to the compensation URI must perform compensation and
complete without error. If errors occur dur [...]
- "completion": { "index": 9, "kind": "element", "displayName":
"Completion", "group": "common", "required": false, "type": "object",
"javaType": "org.apache.camel.model.SagaActionUriDefinition", "deprecated":
false, "autowired": false, "secret": false, "description": "The completion
endpoint URI that will be called when the Saga is completed successfully. The
route corresponding to the completion URI must perform completion tasks and
terminate without error. If errors occur during com [...]
+ "compensation": { "index": 8, "kind": "attribute", "displayName":
"Compensation", "group": "common", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The compensation endpoint URI that must be
called to compensate all changes done in the route. The route corresponding to
the compensation URI must perform compensation and complete without error. If
errors occur during compensation, the saga s [...]
+ "completion": { "index": 9, "kind": "attribute", "displayName":
"Completion", "group": "common", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The completion endpoint URI that will be
called when the Saga is completed successfully. The route corresponding to the
completion URI must perform completion tasks and terminate without error. If
errors occur during completion, the saga service ma [...]
"option": { "index": 10, "kind": "element", "displayName": "Option",
"group": "advanced", "label": "advanced", "required": false, "type": "array",
"javaType":
"java.util.List<org.apache.camel.model.PropertyExpressionDefinition>",
"deprecated": false, "autowired": false, "secret": false, "description":
"Allows to save properties of the current exchange in order to re-use them in a
compensation\/completion callback route. Options are usually helpful e.g. to
store and retrieve identifie [...]
"outputs": { "index": 11, "kind": "element", "displayName": "Outputs",
"group": "common", "required": true, "type": "array", "javaType":
"java.util.List", "oneOf": [ "aggregate", "bean", "choice", "circuitBreaker",
"claimCheck", "convertBodyTo", "convertHeaderTo", "convertVariableTo", "delay",
"doCatch", "doFinally", "doTry", "dynamicRouter", "enrich", "filter",
"idempotentConsumer", "intercept", "interceptFrom", "interceptSendToEndpoint",
"kamelet", "loadBalance", "log", "loop", "ma [...]
}
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
index 673fe0f77b45..9485e38864a7 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
@@ -13378,29 +13378,6 @@ However if there are a high degree of dynamic
endpoints that have been used befo
to reuse both producers and endpoints and therefore the cache size can be set
accordingly or rely on the default size
(1000). If there is a mix of unique and used before dynamic endpoints, then
setting a reasonable cache size can help
reduce memory usage to avoid storing too many non frequent used producers.
-]]>
- </xs:documentation>
- </xs:annotation>
- </xs:attribute>
- </xs:extension>
- </xs:complexContent>
- </xs:complexType>
- <xs:complexType name="sagaActionUriDefinition">
- <xs:complexContent>
- <xs:extension base="tns:sendDefinition">
- <xs:sequence/>
- </xs:extension>
- </xs:complexContent>
- </xs:complexType>
- <xs:complexType abstract="true" name="sendDefinition">
- <xs:complexContent>
- <xs:extension base="tns:noOutputDefinition">
- <xs:sequence/>
- <xs:attribute name="uri" type="xs:string">
- <xs:annotation>
- <xs:documentation xml:lang="en">
-<![CDATA[
-Sets the uri of the endpoint to send to.
]]>
</xs:documentation>
</xs:annotation>
@@ -13412,28 +13389,6 @@ Sets the uri of the endpoint to send to.
<xs:complexContent>
<xs:extension base="tns:output">
<xs:sequence>
- <xs:element minOccurs="0" name="compensation"
type="tns:sagaActionUriDefinition">
- <xs:annotation>
- <xs:documentation xml:lang="en">
-<![CDATA[
-The compensation endpoint URI that must be called to compensate all changes
done in the route. The route corresponding
-to the compensation URI must perform compensation and complete without error.
If errors occur during compensation, the
-saga service may call again the compensation URI to retry.
-]]>
- </xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element minOccurs="0" name="completion"
type="tns:sagaActionUriDefinition">
- <xs:annotation>
- <xs:documentation xml:lang="en">
-<![CDATA[
-The completion endpoint URI that will be called when the Saga is completed
successfully. The route corresponding to the
-completion URI must perform completion tasks and terminate without error. If
errors occur during completion, the saga
-service may call again the completion URI to retry.
-]]>
- </xs:documentation>
- </xs:annotation>
- </xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" name="option"
type="tns:propertyExpressionDefinition">
<xs:annotation>
<xs:documentation xml:lang="en">
@@ -13555,6 +13510,28 @@ user must complete or compensate the saga using the
saga:complete or saga:compen
<![CDATA[
Set the maximum amount of time for the Saga. After the timeout is expired, the
saga will be compensated automatically
(unless a different decision has been taken in the meantime).
+]]>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ <xs:attribute name="compensation" type="xs:string">
+ <xs:annotation>
+ <xs:documentation xml:lang="en">
+<![CDATA[
+The compensation endpoint URI that must be called to compensate all changes
done in the route. The route corresponding
+to the compensation URI must perform compensation and complete without error.
If errors occur during compensation, the
+saga service may call again the compensation URI to retry.
+]]>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ <xs:attribute name="completion" type="xs:string">
+ <xs:annotation>
+ <xs:documentation xml:lang="en">
+<![CDATA[
+The completion endpoint URI that will be called when the Saga is completed
successfully. The route corresponding to the
+completion URI must perform completion tasks and terminate without error. If
errors occur during completion, the saga
+service may call again the completion URI to retry.
]]>
</xs:documentation>
</xs:annotation>
@@ -13622,6 +13599,22 @@ Sets the sample message count which only a single
Exchange will pass through aft
</xs:extension>
</xs:complexContent>
</xs:complexType>
+ <xs:complexType abstract="true" name="sendDefinition">
+ <xs:complexContent>
+ <xs:extension base="tns:noOutputDefinition">
+ <xs:sequence/>
+ <xs:attribute name="uri" type="xs:string">
+ <xs:annotation>
+ <xs:documentation xml:lang="en">
+<![CDATA[
+Sets the uri of the endpoint to send to.
+]]>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ </xs:extension>
+ </xs:complexContent>
+ </xs:complexType>
<xs:complexType name="setBodyDefinition">
<xs:complexContent>
<xs:extension base="tns:processorDefinition">
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-xml-io.xsd
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-xml-io.xsd
index f64cccd199bb..ad621efaf3f3 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-xml-io.xsd
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-xml-io.xsd
@@ -12072,29 +12072,6 @@ However if there are a high degree of dynamic
endpoints that have been used befo
to reuse both producers and endpoints and therefore the cache size can be set
accordingly or rely on the default size
(1000). If there is a mix of unique and used before dynamic endpoints, then
setting a reasonable cache size can help
reduce memory usage to avoid storing too many non frequent used producers.
-]]>
- </xs:documentation>
- </xs:annotation>
- </xs:attribute>
- </xs:extension>
- </xs:complexContent>
- </xs:complexType>
- <xs:complexType name="sagaActionUriDefinition">
- <xs:complexContent>
- <xs:extension base="tns:sendDefinition">
- <xs:sequence/>
- </xs:extension>
- </xs:complexContent>
- </xs:complexType>
- <xs:complexType abstract="true" name="sendDefinition">
- <xs:complexContent>
- <xs:extension base="tns:noOutputDefinition">
- <xs:sequence/>
- <xs:attribute name="uri" type="xs:string">
- <xs:annotation>
- <xs:documentation xml:lang="en">
-<![CDATA[
-Sets the uri of the endpoint to send to.
]]>
</xs:documentation>
</xs:annotation>
@@ -12106,28 +12083,6 @@ Sets the uri of the endpoint to send to.
<xs:complexContent>
<xs:extension base="tns:output">
<xs:sequence>
- <xs:element minOccurs="0" name="compensation"
type="tns:sagaActionUriDefinition">
- <xs:annotation>
- <xs:documentation xml:lang="en">
-<![CDATA[
-The compensation endpoint URI that must be called to compensate all changes
done in the route. The route corresponding
-to the compensation URI must perform compensation and complete without error.
If errors occur during compensation, the
-saga service may call again the compensation URI to retry.
-]]>
- </xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element minOccurs="0" name="completion"
type="tns:sagaActionUriDefinition">
- <xs:annotation>
- <xs:documentation xml:lang="en">
-<![CDATA[
-The completion endpoint URI that will be called when the Saga is completed
successfully. The route corresponding to the
-completion URI must perform completion tasks and terminate without error. If
errors occur during completion, the saga
-service may call again the completion URI to retry.
-]]>
- </xs:documentation>
- </xs:annotation>
- </xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" name="option"
type="tns:propertyExpressionDefinition">
<xs:annotation>
<xs:documentation xml:lang="en">
@@ -12249,6 +12204,28 @@ user must complete or compensate the saga using the
saga:complete or saga:compen
<![CDATA[
Set the maximum amount of time for the Saga. After the timeout is expired, the
saga will be compensated automatically
(unless a different decision has been taken in the meantime).
+]]>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ <xs:attribute name="compensation" type="xs:string">
+ <xs:annotation>
+ <xs:documentation xml:lang="en">
+<![CDATA[
+The compensation endpoint URI that must be called to compensate all changes
done in the route. The route corresponding
+to the compensation URI must perform compensation and complete without error.
If errors occur during compensation, the
+saga service may call again the compensation URI to retry.
+]]>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ <xs:attribute name="completion" type="xs:string">
+ <xs:annotation>
+ <xs:documentation xml:lang="en">
+<![CDATA[
+The completion endpoint URI that will be called when the Saga is completed
successfully. The route corresponding to the
+completion URI must perform completion tasks and terminate without error. If
errors occur during completion, the saga
+service may call again the completion URI to retry.
]]>
</xs:documentation>
</xs:annotation>
@@ -12316,6 +12293,22 @@ Sets the sample message count which only a single
Exchange will pass through aft
</xs:extension>
</xs:complexContent>
</xs:complexType>
+ <xs:complexType abstract="true" name="sendDefinition">
+ <xs:complexContent>
+ <xs:extension base="tns:noOutputDefinition">
+ <xs:sequence/>
+ <xs:attribute name="uri" type="xs:string">
+ <xs:annotation>
+ <xs:documentation xml:lang="en">
+<![CDATA[
+Sets the uri of the endpoint to send to.
+]]>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ </xs:extension>
+ </xs:complexContent>
+ </xs:complexType>
<xs:complexType name="setBodyDefinition">
<xs:complexContent>
<xs:extension base="tns:processorDefinition">
diff --git
a/components/camel-spring-parent/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/saga.xml
b/components/camel-spring-parent/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/saga.xml
index 25127c0c44f5..0e8c7724e310 100644
---
a/components/camel-spring-parent/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/saga.xml
+++
b/components/camel-spring-parent/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/saga.xml
@@ -31,9 +31,7 @@
<jmxAgent id="jmx" disabled="true"/>
<route>
<from uri="direct:start"/>
- <saga>
- <compensation uri="mock:compensation" />
- <completion uri="mock:completion" />
+ <saga compensation="mock:compensation" completion="mock:completion">
<option key="myOptionKey">
<constant>myOptionValue</constant>
</option>
diff --git
a/components/camel-spring-parent/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/sagaRef.xml
b/components/camel-spring-parent/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/sagaRef.xml
index c9f08253f123..2e12eddd504c 100644
---
a/components/camel-spring-parent/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/sagaRef.xml
+++
b/components/camel-spring-parent/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/sagaRef.xml
@@ -32,9 +32,7 @@
<jmxAgent id="jmx" disabled="true"/>
<route>
<from uri="direct:start"/>
- <saga sagaService="mySagaService">
- <compensation uri="mock:compensation"/>
- <completion uri="mock:completion"/>
+ <saga sagaService="mySagaService" compensation="mock:compensation"
completion="mock:completion">
<option key="myOptionKey">
<constant>myOptionValue</constant>
</option>
diff --git
a/core/camel-core-engine/src/main/docs/modules/eips/pages/saga-eip.adoc
b/core/camel-core-engine/src/main/docs/modules/eips/pages/saga-eip.adoc
index 026d166d10ba..27eb8668d216 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/saga-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/saga-eip.adoc
@@ -27,7 +27,7 @@ The Saga EIP implementation based on the MicroProfile sandbox
spec is indeed cal
It also supports coordination of external *heterogeneous services*,
written with any language/technology and also running outside a JVM.
-NOTE: see camel-lra.
+NOTE: See also xref:components:others:lra.adoc[Camel LRA]
Sagas don't use locks on data.
Instead, they define the concept of "Compensating Action"
@@ -181,6 +181,11 @@ one to create the order and one to take the credit.
*Both actions must be executed, or none of them*:
an order placed without enough credits can be considered an inconsistent
outcome (and a payment without an order).
+[tabs]
+====
+
+Java::
++
[source,java]
----
from("direct:buy")
@@ -189,6 +194,36 @@ from("direct:buy")
.to("direct:reserveCredit");
----
+XML::
++
+[source,xml]
+----
+<route>
+ <from uri="direct:buy"/>
+ <saga>
+ <to uri="direct:newOrder"/>
+ <to uri="direct:reserveCredit"/>
+ </saga>
+</route>
+----
+
+YAML::
++
+[source,yaml]
+----
+- route:
+ from:
+ uri: direct:buy
+ steps:
+ - saga:
+ steps:
+ - to:
+ uri: direct:newOrder
+ - to:
+ uri: direct:reserveCredit
+----
+====
+
*That's it*. The buy action will not change for the rest of the examples.
We'll just see different options that can be used to model the "New Order" and
"Reserve Credit" actions in the following.
[NOTE]
@@ -199,6 +234,11 @@ We could have used *http* or other kinds of endpoint with
the LRA Saga service.
Both services called by the `direct:buy` route can *participate in the Saga*
and declare their compensating actions.
+[tabs]
+====
+
+Java::
++
[source,java]
----
from("direct:newOrder")
@@ -206,10 +246,50 @@ from("direct:newOrder")
.propagation(SagaPropagation.MANDATORY)
.compensation("direct:cancelOrder")
.transform().header(Exchange.SAGA_LONG_RUNNING_ACTION)
- .bean(orderManagerService, "newOrder")
+ .bean("orderManagerService", "newOrder")
.log("Order ${body} created");
----
+XML::
++
+[source,xml]
+----
+<route>
+ <from uri="direct:newOrder"/>
+ <saga propagation="MANDATORY" compensation="direct:cancelOrder">
+ <transform>
+ <header>Long-Running-Action</header>
+ </transform>
+ <bean ref="orderManagerService" method="newOrder"/>
+ <log message="Order ${body} created"/>
+ </saga>
+</route>
+----
+
+YAML::
++
+[source,yaml]
+----
+- route:
+ from:
+ uri: direct:newOrder
+ steps:
+ - saga:
+ propagation: MANDATORY
+ compensation: direct:cancelOrder
+ steps:
+ - transform:
+ expression:
+ header:
+ expression: Long-Running-Action
+ - bean:
+ ref: orderManagerService
+ method: newOrder
+ - log:
+ message: "Order ${body} created"
+----
+====
+
Here the propagation mode is set to `MANDATORY` meaning that any exchange
flowing in this route must be already part of a saga.
And it is the case in this example, since the saga is created in the
`direct:buy` route.
@@ -222,14 +302,53 @@ but it is not a requirement (options can be used as an
alternative solution).
The compensating action of `direct:newOrder` is `direct:cancelOrder`, and it's
shown below:
+[tabs]
+====
+
+Java::
++
[source,java]
----
from("direct:cancelOrder")
.transform().header(Exchange.SAGA_LONG_RUNNING_ACTION)
- .bean(orderManagerService, "cancelOrder")
+ .bean("orderManagerService", "cancelOrder")
.log("Order ${body} cancelled");
----
+XML::
++
+[source,xml]
+----
+<route>
+ <from uri="direct:cancelOrder"/>
+ <transform>
+ <header>Long-Running-Action</header>
+ </transform>
+ <bean ref="orderManagerService" method="cancelOrder"/>
+ <log message="Order ${body} cancelled"/>
+</route>
+----
+
+YAML::
++
+[source,yaml]
+----
+- route:
+ from:
+ uri: direct:cancelOrder
+ steps:
+ - transform:
+ expression:
+ header:
+ expression: Long-Running-Action
+ - bean:
+ ref: orderManagerService
+ method: cancelOrder
+ - log:
+ message: "Order ${body} cancelled"
+----
+====
+
It is called automatically by the Saga EIP implementation when the order
should be canceled.
It should not terminate with error.
@@ -256,24 +375,90 @@ this approach may work in many contexts, but it's
*heuristic*.
The credit service may be implemented almost in the same way as the order
service.
+[tabs]
+====
+
+Java::
++
[source,java]
----
// action
from("direct:reserveCredit")
.saga()
- .propagation(SagaPropagation.MANDATORY)
- .compensation("direct:refundCredit")
- .transform().header(Exchange.SAGA_LONG_RUNNING_ACTION)
- .bean(creditService, "reserveCredit")
- .log("Credit ${header.amount} reserved in action ${body}");
+ .propagation(SagaPropagation.MANDATORY)
+ .compensation("direct:refundCredit")
+ .transform().header(Exchange.SAGA_LONG_RUNNING_ACTION)
+ .bean("creditService", "reserveCredit")
+ .log("Credit ${header.amount} reserved in action ${body}");
// compensation
from("direct:refundCredit")
.transform().header(Exchange.SAGA_LONG_RUNNING_ACTION)
- .bean(creditService, "refundCredit")
+ .bean("creditService", "refundCredit")
.log("Credit for action ${body} refunded");
----
+XML::
++
+[source,xml]
+----
+<route>
+ <from uri="direct:reserveCredit"/>
+ <saga propagation="MANDATORY" compensation="direct:refundCredit"/>
+ <transform>
+ <header>Long-Running-Action</header>
+ </transform>
+ <bean ref="creditService" method="reserveCredit"/>
+ <log message="Credit ${header.amount} reserved in action ${body}"/>
+</route>
+
+<route>
+ <from uri="direct:refundCredit"/>
+ <transform>
+ <header>Long-Running-Action</header>
+ </transform>
+ <bean ref="creditService" method="refundCredit"/>
+ <log message="Credit for action ${body} refunded"/>
+</route>
+----
+
+YAML::
++
+[source,yaml]
+----
+- route:
+ from:
+ uri: direct:reserveCredit
+ steps:
+ - saga:
+ propagation: MANDATORY
+ compensation: direct:refundCredit
+ - transform:
+ expression:
+ header:
+ expression: Long-Running-Action
+ - bean:
+ ref: creditService
+ method: reserveCredit
+ - log:
+ message: "Credit ${header.amount} reserved in action ${body}"
+- route:
+ from:
+ uri: direct:refundCredit
+ steps:
+ - transform:
+ expression:
+ header:
+ expression: Long-Running-Action
+ - bean:
+ ref: creditService
+ method: refundCredit
+ - log:
+ message: "Credit for action ${body} refunded"
+----
+====
+
+
Here the compensating action for a credit reservation is a refund.
This completes the example. It can be run with both implementations of the
Saga EIP, as it does not involve remote endpoints.
@@ -291,34 +476,109 @@ We will not want to start to prepare the order if the
payment is not done (unlik
This can be done easily with a modified version of the `direct:newOrder`
endpoint:
+[tabs]
+====
+
+Java::
++
+The compensation route is the same as in the previous example above
++
[source,java]
----
from("direct:newOrder")
.saga()
- .propagation(SagaPropagation.MANDATORY)
- .compensation("direct:cancelOrder")
- .completion("direct:completeOrder") // completion endpoint
- .transform().header(Exchange.SAGA_LONG_RUNNING_ACTION)
- .bean(orderManagerService, "newOrder")
- .log("Order ${body} created");
+ .propagation(SagaPropagation.MANDATORY)
+ .compensation("direct:cancelOrder")
+ .completion("direct:completeOrder") // completion endpoint
+ .transform().header(Exchange.SAGA_LONG_RUNNING_ACTION)
+ .bean("orderManagerService", "newOrder")
+ .log("Order ${body} created");
// direct:cancelOrder is the same as in the previous example
// called on successful completion
from("direct:completeOrder")
.transform().header(Exchange.SAGA_LONG_RUNNING_ACTION)
- .bean(orderManagerService, "findExternalId")
+ .bean("orderManagerService", "findExternalId")
.to("jms:prepareOrder")
.log("Order ${body} sent for preparation");
----
+XML::
++
+The compensation route is the same as in the previous example above
++
+[source,xml]
+----
+<route>
+ <from uri="direct:newOrder"/>
+ <saga propagation="MANDATORY" completion="direct:completeOrder"
compensation="direct:cancelOrder"/>
+ <transform>
+ <header>Long-Running-Action</header>
+ </transform>
+ <bean ref="orderManagerService" method="newOrder"/>
+ <log message="Order ${body} created"/>
+</route>
+
+<route>
+ <from uri="direct:completeOrder"/>
+ <transform>
+ <header>Long-Running-Action</header>
+ </transform>
+ <bean ref="orderManagerService" method="findExternalId"/>
+ <to uri="jms:prepareOrder"/>
+ <log message="Order ${body} sent for preparation"/>
+</route>
+----
+
+YAML::
++
+The compensation route is the same as in the previous example above
++
+[source,yaml]
+----
+- route:
+ from:
+ uri: direct:newOrder
+ steps:
+ - saga:
+ propagation: MANDATORY
+ compensation: direct:cancelOrder
+ completion: direct:completeOrder
+ - transform:
+ expression:
+ header:
+ expression: Long-Running-Action
+ - bean:
+ ref: orderManagerService
+ method: newOrder
+ - log:
+ message: "Order ${body} created"
+- route:
+ from:
+ uri: direct:completeOrder
+ steps:
+ - transform:
+ expression:
+ header:
+ expression: Long-Running-Action
+ - bean:
+ ref: orderManagerService
+ method: findExternalId
+ - to:
+ uri: jms:prepareOrder
+ - log:
+ message: "Order ${body} sent for preparation"
+----
+====
+
When the Saga is completed, the order is sent to a JMS queue for preparation.
Like compensating actions, also completion actions may be called multiple
times by the Saga coordinator.
Especially in case of errors, like network errors.
In this example, the service listening to the `prepareOrder` JMS queue should
be prepared to hold possible duplicates.
-NOTE: Check the Idempotent Consumer EIP for examples on how to handle
duplicates.
+TIP: Check the xref:idempotentConsumer-eip.adoc[Idempotent Consumer EIP] for
examples on how to handle duplicates.
=== Using Custom Identifiers and Options
@@ -328,34 +588,121 @@ This is not always a desired approach, as it may pollute
the business logic and
An alternative approach is to use Saga options to "register" custom
identifiers.
For example, the credit service may be refactored as follows:
+[tabs]
+====
+
+Java::
++
+Notice the listing below is not using the `Exchange.SAGA_LONG_RUNNING_ACTION`
header at all.
++
[source,java]
----
// action
from("direct:reserveCredit")
- .bean(idService, "generateCustomId") // generate a custom ID and set it in
the body
- .to("direct:creditReservation")
+ .bean("idService", "generateCustomId") // generate a custom ID and set it in
the body
+ .to("direct:creditReservation");
// delegate action
from("direct:creditReservation")
.saga()
- .propagation(SagaPropagation.SUPPORTS)
- .option("CreditId", body()) // mark the current body as needed in the
compensating action
- .compensation("direct:creditRefund")
- .bean(creditService, "reserveCredit")
- .log("Credit ${header.amount} reserved. Custom Id used is ${body}");
+ .propagation(SagaPropagation.SUPPORTS)
+ .option("CreditId", body()) // mark the current body as needed in the
compensating action
+ .compensation("direct:creditRefund")
+ .bean("creditService", "reserveCredit")
+ .log("Credit ${header.amount} reserved. Custom Id used is ${body}");
// called only if the saga is canceled
from("direct:creditRefund")
.transform(header("CreditId")) // retrieve the CreditId option from headers
- .bean(creditService, "refundCredit")
+ .bean("creditService", "refundCredit")
.log("Credit for Custom Id ${body} refunded");
----
-*Note how the previous listing is not using the
`Exchange.SAGA_LONG_RUNNING_ACTION` header at all.*
+XML::
++
+Notice the listing below is not using the `Long-Running-Action` header at all.
++
+[source,xml]
+----
+<route>
+ <from uri="direct:reserveCredit"/>
+ <bean ref="idService" method="generateCustomId"/>
+ <to uri="direct:creditReservation"/>
+</route>
+
+<route>
+ <from uri="direct:creditReservation"/>
+ <saga propagation="SUPPORTS" compensation="direct:creditRefund">
+ <option key="CreditId">
+ <simple>${body}</simple>
+ </option>
+ </saga>
+ <bean ref="creditService" method="reserveCredit"/>
+ <log message="Credit ${header.amount} reserved. Custom Id used is
${body}"/>
+</route>
+
+<route>
+ <from uri="direct:creditRefund"/>
+ <transform>
+ <header>CreditId</header>
+ </transform>
+ <bean ref="creditService" method="refundCredit"/>
+ <log message="Credit for Custom Id ${body} refunded"/>
+</route>
+----
+
+YAML::
++
+Notice the listing below is not using the `Long-Running-Action` header at all.
++
+[source,yaml]
+----
+- route:
+ from:
+ uri: direct:reserveCredit
+ steps:
+ - bean:
+ ref: idService
+ method: generateCustomId
+ - to:
+ uri: direct:creditReservation
+- route:
+ from:
+ uri: direct:creditReservation
+ steps:
+ - saga:
+ propagation: SUPPORTS
+ option:
+ key: CreditId
+ expression:
+ simple:
+ expression: "${body}"
+ compensation: direct:creditRefund
+ - bean:
+ ref: creditService
+ method: reserveCredit
+ - log:
+ message: "Credit ${header.amount} reserved. Custom Id used is
${body}"
+- route:
+ from:
+ uri: direct:creditRefund
+ steps:
+ - transform:
+ expression:
+ header:
+ expression: CreditId
+ - bean:
+ ref: creditService
+ method: refundCredit
+ - log:
+ message: "Credit for Custom Id ${body} refunded"
+----
+====
+
Since the `direct:creditReservation` endpoint can be now called also from
outside a Saga, the propagation mode can be set to `SUPPORTS`.
-NOTE: Multiple options* can be declared in a Saga route.
+TIP: Multiple `option`(s) can be declared in a Saga route.
=== Setting Timeouts
@@ -371,17 +718,51 @@ When the timeout expires, the Saga EIP will decide to
*cancel the Saga* (and com
Timeouts can be set on Saga participants as follows:
+[tabs]
+====
+
+Java::
++
[source,java]
----
from("direct:newOrder")
.saga()
- .timeout(1, TimeUnit.MINUTES) // newOrder requires that the saga is
completed within 1 minute
- .propagation(SagaPropagation.MANDATORY)
- .compensation("direct:cancelOrder")
- .completion("direct:completeOrder")
+ .timeout(1, TimeUnit.MINUTES) // newOrder requires that the saga is
completed within 1 minute
+ .propagation(SagaPropagation.MANDATORY)
+ .compensation("direct:cancelOrder")
+ .completion("direct:completeOrder")
// ...
- .log("Order ${body} created");
+ .log("Order ${body} created");
+----
+
+XML::
++
+[source,xml]
+----
+<route>
+ <from uri="direct:newOrder"/>
+ <saga propagation="MANDATORY" timeout="1m"
completion="direct:completeOrder" compensation="direct:cancelOrder"/>
+ <log message="Order ${body} created"/>
+</route>
+----
+
+YAML::
++
+[source,yaml]
+----
+- route:
+ from:
+ uri: direct:newOrder
+ steps:
+ - saga:
+ propagation: MANDATORY
+ timeout: 1m
+ compensation: direct:cancelOrder
+ completion: direct:completeOrder
+ - log:
+ message: "Order ${body} created"
----
+====
All participants, e.g., credit service, order service, can set their own
timeout.
When a participant joins an existing transaction, the timeout of the already
active saga can be influenced.
@@ -391,16 +772,50 @@ When this moment is earlier than the moment calculated
for the saga at that time
this new moment becomes the timeout moment for the saga.
So when multiple participants define a timeout period, the earliest one will
trigger the cancellation of the saga.
-A timeout can also be specified at saga level as follows:
+A timeout can also be specified at Saga level as follows:
+
+[tabs]
+====
+Java::
++
[source,java]
----
from("direct:buy")
- .saga()
- .timeout(5, TimeUnit.MINUTES) // timeout at saga level
- .to("direct:newOrder")
- .to("direct:reserveCredit");
+ .saga().timeout(5, TimeUnit.MINUTES) // timeout at saga level
+ .to("direct:newOrder")
+ .to("direct:reserveCredit");
+----
+
+XML::
++
+[source,xml]
+----
+<route>
+ <from uri="direct:buy"/>
+ <saga timeout="5m"/>
+ <to uri="direct:newOrder"/>
+ <to uri="direct:reserveCredit"/>
+</route>
+----
+
+YAML::
++
+[source,yaml]
----
+- route:
+ from:
+ uri: direct:buy
+ steps:
+ - saga:
+ timeout: "5m"
+ - to:
+ uri: direct:newOrder
+ - to:
+ uri: direct:reserveCredit
+----
+====
+
=== Choosing Propagation
@@ -428,31 +843,92 @@ That is because the saga is not completed when the
exchange that creates it is d
This is often the case for Sagas that have long execution times (hours, days).
In these cases, the `MANUAL` completion mode should be used.
+[tabs]
+====
+
+Java::
++
[source,java]
----
from("direct:mysaga")
.saga()
- .completionMode(SagaCompletionMode.MANUAL)
- .completion("direct:finalize")
- .timeout(2, TimeUnit.HOURS)
- .to("seda:newOrder")
- .to("seda:reserveCredit");
+ .completionMode(SagaCompletionMode.MANUAL)
+ .completion("direct:finalize")
+ .timeout(2, TimeUnit.HOURS)
+ .to("seda:newOrder")
+ .to("seda:reserveCredit");
// Put here asynchronous processing for seda:newOrder and seda:reserveCredit
// They will send asynchronous callbacks to seda:operationCompleted
from("seda:operationCompleted") // an asynchronous callback
.saga()
- .propagation(SagaPropagation.MANDATORY)
- .bean(controlService, "actionExecuted")
- .choice()
- .when(body().isEqualTo("ok"))
- .to("saga:complete") // complete the current saga manually (saga
component)
- .end()
+ .propagation(SagaPropagation.MANDATORY)
+ .bean("controlService", "actionExecuted")
+ .filter(simple("${body} == 'ok'"))
+ .to("saga:complete") // complete the current saga manually (saga
component)
+ .end();
// You can put here the direct:finalize endpoint to execute final actions
----
+XML::
++
+[source,xml]
+----
+<route>
+ <from uri="direct:mysaga"/>
+ <saga completionMode="MANUAL" timeout="2h0m0s"
completion="direct:finalize"/>
+ <to uri="seda:newOrder"/>
+ <to uri="seda:reserveCredit"/>
+</route>
+
+<route>
+ <from uri="seda:operationCompleted"/>
+ <saga propagation="MANDATORY"/>
+ <bean ref="controlService" method="actionExecuted"/>
+ <filter>
+ <simple>${body} == 'ok'</simple>
+ <to uri="saga:complete"/>
+ </filter>
+</route>
+----
+
+YAML::
++
+[source,yaml]
+----
+- route:
+ from:
+ uri: direct:mysaga
+ steps:
+ - saga:
+ completionMode: MANUAL
+ timeout: 2h
+ completion: direct:finalize
+ - to:
+ uri: seda:newOrder
+ - to:
+ uri: seda:reserveCredit
+- route:
+ from:
+ uri: seda:operationCompleted
+ steps:
+ - saga:
+ propagation: MANDATORY
+ - bean:
+ ref: controlService
+ method: actionExecuted
+ - filter:
+ expression:
+ simple:
+ expression: "${body} == 'ok'"
+ steps:
+ - to:
+ uri: saga:complete
+----
+====
+
Setting the completion mode to `MANUAL` means that the saga is not completed
when the exchange is processed in the route `direct:mysaga` but
it will last longer (max duration is set to 2 hours).
@@ -466,28 +942,3 @@ But Sagas add a lot of value,
since they guarantee that even in the presence of unexpected issues (servers
crashing, messages are lost, etc.)
there will always be a consistent outcome: order placed and credit reserved,
or none of them changed.
In particular, if the Saga is not completed within 2 hours, the compensation
mechanism will take care of fixing the status.
-
-== Using Saga with XML DSL
-
-Saga features are also available for users that want to use the XML DSL.
-
-The following snippet shows an example:
-
-[source,xml]
-----
-<route>
- <from uri="direct:start"/>
- <saga>
- <compensation uri="direct:compensation" />
- <completion uri="direct:completion" />
- <option optionName="myOptionKey">
- <constant>myOptionValue</constant>
- </option>
- <option optionName="myOptionKey2">
- <constant>myOptionValue2</constant>
- </option>
- </saga>
- <to uri="direct:action1" />
- <to uri="direct:action2" />
-</route>
-----
diff --git
a/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/saga.json
b/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/saga.json
index 1334df81a513..15543e203db7 100644
---
a/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/saga.json
+++
b/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/saga.json
@@ -20,8 +20,8 @@
"propagation": { "index": 5, "kind": "attribute", "displayName":
"Propagation", "group": "advanced", "label": "advanced", "required": false,
"type": "enum", "javaType": "org.apache.camel.model.SagaPropagation", "enum": [
"REQUIRED", "REQUIRES_NEW", "MANDATORY", "SUPPORTS", "NOT_SUPPORTED", "NEVER"
], "deprecated": false, "autowired": false, "secret": false, "defaultValue":
"REQUIRED", "description": "Set the Saga propagation mode (REQUIRED,
REQUIRES_NEW, MANDATORY, SUPPORTS, NOT_SUPP [...]
"completionMode": { "index": 6, "kind": "attribute", "displayName":
"Completion Mode", "group": "advanced", "label": "advanced", "required": false,
"type": "enum", "javaType": "org.apache.camel.model.SagaCompletionMode",
"enum": [ "AUTO", "MANUAL" ], "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "AUTO", "description": "Determine how the saga
should be considered complete. When set to AUTO, the saga is completed when the
exchange that initiates the saga is [...]
"timeout": { "index": 7, "kind": "attribute", "displayName": "Timeout",
"group": "common", "required": false, "type": "duration", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Set the maximum amount of time for the Saga. After the timeout
is expired, the saga will be compensated automatically (unless a different
decision has been taken in the meantime)." },
- "compensation": { "index": 8, "kind": "element", "displayName":
"Compensation", "group": "common", "required": false, "type": "object",
"javaType": "org.apache.camel.model.SagaActionUriDefinition", "deprecated":
false, "autowired": false, "secret": false, "description": "The compensation
endpoint URI that must be called to compensate all changes done in the route.
The route corresponding to the compensation URI must perform compensation and
complete without error. If errors occur dur [...]
- "completion": { "index": 9, "kind": "element", "displayName":
"Completion", "group": "common", "required": false, "type": "object",
"javaType": "org.apache.camel.model.SagaActionUriDefinition", "deprecated":
false, "autowired": false, "secret": false, "description": "The completion
endpoint URI that will be called when the Saga is completed successfully. The
route corresponding to the completion URI must perform completion tasks and
terminate without error. If errors occur during com [...]
+ "compensation": { "index": 8, "kind": "attribute", "displayName":
"Compensation", "group": "common", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The compensation endpoint URI that must be
called to compensate all changes done in the route. The route corresponding to
the compensation URI must perform compensation and complete without error. If
errors occur during compensation, the saga s [...]
+ "completion": { "index": 9, "kind": "attribute", "displayName":
"Completion", "group": "common", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The completion endpoint URI that will be
called when the Saga is completed successfully. The route corresponding to the
completion URI must perform completion tasks and terminate without error. If
errors occur during completion, the saga service ma [...]
"option": { "index": 10, "kind": "element", "displayName": "Option",
"group": "advanced", "label": "advanced", "required": false, "type": "array",
"javaType":
"java.util.List<org.apache.camel.model.PropertyExpressionDefinition>",
"deprecated": false, "autowired": false, "secret": false, "description":
"Allows to save properties of the current exchange in order to re-use them in a
compensation\/completion callback route. Options are usually helpful e.g. to
store and retrieve identifie [...]
"outputs": { "index": 11, "kind": "element", "displayName": "Outputs",
"group": "common", "required": true, "type": "array", "javaType":
"java.util.List", "oneOf": [ "aggregate", "bean", "choice", "circuitBreaker",
"claimCheck", "convertBodyTo", "convertHeaderTo", "convertVariableTo", "delay",
"doCatch", "doFinally", "doTry", "dynamicRouter", "enrich", "filter",
"idempotentConsumer", "intercept", "interceptFrom", "interceptSendToEndpoint",
"kamelet", "loadBalance", "log", "loop", "ma [...]
}
diff --git
a/core/camel-core-model/src/main/java/org/apache/camel/model/SagaActionUriDefinition.java
b/core/camel-core-model/src/main/java/org/apache/camel/model/SagaActionUriDefinition.java
deleted file mode 100644
index cdcadbd87893..000000000000
---
a/core/camel-core-model/src/main/java/org/apache/camel/model/SagaActionUriDefinition.java
+++ /dev/null
@@ -1,51 +0,0 @@
-/*
- * 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.model;
-
-import jakarta.xml.bind.annotation.XmlAccessType;
-import jakarta.xml.bind.annotation.XmlAccessorType;
-
-import org.apache.camel.spi.Metadata;
-
-/**
- * Allows to declare saga actions to complete or compensate a saga
- */
-@Metadata(label = "configuration")
-@XmlAccessorType(XmlAccessType.FIELD)
-public class SagaActionUriDefinition extends
SendDefinition<SagaActionUriDefinition> {
-
- public SagaActionUriDefinition() {
- }
-
- public SagaActionUriDefinition(SagaActionUriDefinition source) {
- super(source);
- }
-
- public SagaActionUriDefinition(String uri) {
- super(uri);
- }
-
- @Override
- public SagaActionUriDefinition copyDefinition() {
- return new SagaActionUriDefinition(this);
- }
-
- @Override
- public String getShortName() {
- return "SagaAction";
- }
-}
diff --git
a/core/camel-core-model/src/main/java/org/apache/camel/model/SagaDefinition.java
b/core/camel-core-model/src/main/java/org/apache/camel/model/SagaDefinition.java
index 248a29893ac3..92be490ff371 100644
---
a/core/camel-core-model/src/main/java/org/apache/camel/model/SagaDefinition.java
+++
b/core/camel-core-model/src/main/java/org/apache/camel/model/SagaDefinition.java
@@ -30,7 +30,9 @@ import jakarta.xml.bind.annotation.XmlRootElement;
import jakarta.xml.bind.annotation.XmlTransient;
import org.apache.camel.Expression;
+import org.apache.camel.builder.EndpointProducerBuilder;
import org.apache.camel.saga.CamelSagaService;
+import org.apache.camel.spi.AsEndpointUri;
import org.apache.camel.spi.Metadata;
import org.apache.camel.util.ObjectHelper;
import org.apache.camel.util.TimeUtils;
@@ -43,6 +45,11 @@ import org.apache.camel.util.TimeUtils;
@XmlAccessorType(XmlAccessType.FIELD)
public class SagaDefinition extends OutputDefinition<SagaDefinition> {
+ @XmlTransient
+ private EndpointProducerBuilder compensationEndpointProducerBuilder;
+ @XmlTransient
+ private EndpointProducerBuilder completionEndpointProducerBuilder;
+
@XmlTransient
private CamelSagaService sagaServiceBean;
@XmlAttribute
@@ -59,10 +66,12 @@ public class SagaDefinition extends
OutputDefinition<SagaDefinition> {
@XmlAttribute
@Metadata(javaType = "java.time.Duration")
private String timeout;
- @XmlElement
- private SagaActionUriDefinition compensation;
- @XmlElement
- private SagaActionUriDefinition completion;
+ @XmlAttribute
+ @Metadata
+ private String compensation;
+ @XmlAttribute
+ @Metadata
+ private String completion;
@XmlElement(name = "option")
@Metadata(label = "advanced")
private List<PropertyExpressionDefinition> options;
@@ -77,8 +86,10 @@ public class SagaDefinition extends
OutputDefinition<SagaDefinition> {
this.propagation = source.propagation;
this.completionMode = source.completionMode;
this.timeout = source.timeout;
- this.compensation = source.compensation != null ?
source.compensation.copyDefinition() : null;
- this.completion = source.completion != null ?
source.completion.copyDefinition() : null;
+ this.compensation = source.compensation;
+ this.completion = source.completion;
+ this.compensationEndpointProducerBuilder =
source.compensationEndpointProducerBuilder;
+ this.completionEndpointProducerBuilder =
source.completionEndpointProducerBuilder;
this.options =
ProcessorDefinitionHelper.deepCopyDefinitions(source.options);
}
@@ -135,6 +146,14 @@ public class SagaDefinition extends
OutputDefinition<SagaDefinition> {
// Properties
+ public EndpointProducerBuilder getCompensationEndpointProducerBuilder() {
+ return compensationEndpointProducerBuilder;
+ }
+
+ public EndpointProducerBuilder getCompletionEndpointProducerBuilder() {
+ return completionEndpointProducerBuilder;
+ }
+
public CamelSagaService getSagaServiceBean() {
return sagaServiceBean;
}
@@ -150,7 +169,7 @@ public class SagaDefinition extends
OutputDefinition<SagaDefinition> {
this.sagaService = sagaService;
}
- public SagaActionUriDefinition getCompensation() {
+ public String getCompensation() {
return compensation;
}
@@ -159,11 +178,20 @@ public class SagaDefinition extends
OutputDefinition<SagaDefinition> {
* corresponding to the compensation URI must perform compensation and
complete without error. If errors occur
* during compensation, the saga service may call again the compensation
URI to retry.
*/
- public void setCompensation(SagaActionUriDefinition compensation) {
+ public void setCompensation(@AsEndpointUri String compensation) {
this.compensation = compensation;
}
- public SagaActionUriDefinition getCompletion() {
+ /**
+ * The compensation endpoint URI that must be called to compensate all
changes done in the route. The route
+ * corresponding to the compensation URI must perform compensation and
complete without error. If errors occur
+ * during compensation, the saga service may call again the compensation
URI to retry.
+ */
+ public void setCompensation(@AsEndpointUri EndpointProducerBuilder
compensation) {
+ this.compensationEndpointProducerBuilder = compensation;
+ }
+
+ public String getCompletion() {
return completion;
}
@@ -172,10 +200,19 @@ public class SagaDefinition extends
OutputDefinition<SagaDefinition> {
* to the completion URI must perform completion tasks and terminate
without error. If errors occur during
* completion, the saga service may call again the completion URI to retry.
*/
- public void setCompletion(SagaActionUriDefinition completion) {
+ public void setCompletion(@AsEndpointUri String completion) {
this.completion = completion;
}
+ /**
+ * The completion endpoint URI that will be called when the Saga is
completed successfully. The route corresponding
+ * to the completion URI must perform completion tasks and terminate
without error. If errors occur during
+ * completion, the saga service may call again the completion URI to retry.
+ */
+ public void setCompletion(@AsEndpointUri EndpointProducerBuilder
completion) {
+ this.completionEndpointProducerBuilder = completion;
+ }
+
public String getPropagation() {
return propagation;
}
@@ -236,18 +273,12 @@ public class SagaDefinition extends
OutputDefinition<SagaDefinition> {
// Builders
public SagaDefinition compensation(String compensation) {
- if (this.compensation != null) {
- throw new IllegalStateException("Compensation has already been
set");
- }
- this.compensation = new SagaActionUriDefinition(compensation);
+ this.compensation = compensation;
return this;
}
public SagaDefinition completion(String completion) {
- if (this.completion != null) {
- throw new IllegalStateException("Completion has already been set");
- }
- this.completion = new SagaActionUriDefinition(completion);
+ this.completion = completion;
return this;
}
diff --git
a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/SagaReifier.java
b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/SagaReifier.java
index cc7b8412ad90..75737ae210d5 100644
---
a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/SagaReifier.java
+++
b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/SagaReifier.java
@@ -17,16 +17,17 @@
package org.apache.camel.reifier;
import java.util.Map;
-import java.util.Optional;
import java.util.TreeMap;
+import org.apache.camel.CamelContextAware;
import org.apache.camel.Endpoint;
import org.apache.camel.Expression;
import org.apache.camel.Processor;
import org.apache.camel.Route;
import org.apache.camel.model.ProcessorDefinition;
+import org.apache.camel.model.ProcessorDefinitionHelper;
import org.apache.camel.model.PropertyExpressionDefinition;
-import org.apache.camel.model.SagaActionUriDefinition;
+import org.apache.camel.model.RouteDefinition;
import org.apache.camel.model.SagaDefinition;
import org.apache.camel.processor.saga.SagaCompletionMode;
import org.apache.camel.processor.saga.SagaProcessor;
@@ -34,6 +35,7 @@ import org.apache.camel.processor.saga.SagaProcessorBuilder;
import org.apache.camel.processor.saga.SagaPropagation;
import org.apache.camel.saga.CamelSagaService;
import org.apache.camel.saga.CamelSagaStep;
+import org.apache.camel.support.EndpointHelper;
public class SagaReifier extends ProcessorReifier<SagaDefinition> {
@@ -43,15 +45,38 @@ public class SagaReifier extends
ProcessorReifier<SagaDefinition> {
@Override
public Processor createProcessor() throws Exception {
- Endpoint compensationEndpoint =
Optional.ofNullable(definition.getCompensation())
- .map(SagaActionUriDefinition::getUri)
- .map(this::resolveEndpoint)
- .orElse(null);
- Endpoint completionEndpoint =
Optional.ofNullable(definition.getCompletion())
- .map(SagaActionUriDefinition::getUri)
- .map(this::resolveEndpoint)
- .orElse(null);
+ // compensation
+ String uri;
+ if (definition.getCompensationEndpointProducerBuilder() != null) {
+ uri =
definition.getCompensationEndpointProducerBuilder().getRawUri();
+ } else {
+ uri = definition.getCompensation();
+ }
+ // route templates should pre parse uri as they have dynamic values as
part of their template parameters
+ RouteDefinition rd = ProcessorDefinitionHelper.getRoute(definition);
+ if (uri != null && rd != null && rd.isTemplate() != null &&
rd.isTemplate()) {
+ uri =
EndpointHelper.resolveEndpointUriPropertyPlaceholders(camelContext, uri);
+ }
+ Endpoint compensationEndpoint = null;
+ if (uri != null) {
+ compensationEndpoint = camelContext.getEndpoint(uri);
+ }
+
+ // completion
+ if (definition.getCompletionEndpointProducerBuilder() != null) {
+ uri =
definition.getCompletionEndpointProducerBuilder().getRawUri();
+ } else {
+ uri = definition.getCompletion();
+ }
+ // route templates should pre parse uri as they have dynamic values as
part of their template parameters
+ if (uri != null && rd != null && rd.isTemplate() != null &&
rd.isTemplate()) {
+ uri =
EndpointHelper.resolveEndpointUriPropertyPlaceholders(camelContext, uri);
+ }
+ Endpoint completionEndpoint = null;
+ if (uri != null) {
+ completionEndpoint = camelContext.getEndpoint(uri);
+ }
Map<String, Expression> optionsMap = new TreeMap<>();
if (definition.getOptions() != null) {
@@ -81,6 +106,7 @@ public class SagaReifier extends
ProcessorReifier<SagaDefinition> {
Processor childProcessor = this.createChildProcessor(true);
CamelSagaService camelSagaService = resolveSagaService();
+ CamelContextAware.trySetCamelContext(camelSagaService,
getCamelContext());
camelSagaService.registerStep(step);
diff --git a/core/camel-core/src/test/resources/org/apache/camel/model/saga.xml
b/core/camel-core/src/test/resources/org/apache/camel/model/saga.xml
index 03412a85621b..23fc27f62011 100644
--- a/core/camel-core/src/test/resources/org/apache/camel/model/saga.xml
+++ b/core/camel-core/src/test/resources/org/apache/camel/model/saga.xml
@@ -18,14 +18,12 @@
-->
<routes id="camel" xmlns="http://camel.apache.org/schema/spring";>
- <route>
- <from uri="direct:start"/>
- <saga>
- <compensation uri="mock:uri" />
- </saga>
- <setBody>
- <simple>${in.body} extra data!</simple>
- </setBody>
- <to uri="mock:end"/>
- </route>
+ <route>
+ <from uri="direct:start"/>
+ <saga compensation="mock:uri"/>
+ <setBody>
+ <simple>${in.body} extra data!</simple>
+ </setBody>
+ <to uri="mock:end"/>
+ </route>
</routes>
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 13920b6e1df8..598c58845a34 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
@@ -1061,21 +1061,18 @@ public class ModelParser extends BaseParser {
}
protected SagaDefinition doParseSagaDefinition() throws IOException,
XmlPullParserException {
return doParse(new SagaDefinition(), (def, key, val) -> switch (key) {
+ case "compensation": def.setCompensation(val); yield true;
+ case "completion": def.setCompletion(val); yield true;
case "completionMode": def.setCompletionMode(val); yield true;
case "propagation": def.setPropagation(val); yield true;
case "sagaService": def.setSagaService(val); yield true;
case "timeout": def.setTimeout(val); yield true;
default: yield
processorDefinitionAttributeHandler().accept(def, key, val);
}, (def, key) -> switch (key) {
- case "compensation":
def.setCompensation(doParseSagaActionUriDefinition()); yield true;
- case "completion":
def.setCompletion(doParseSagaActionUriDefinition()); yield true;
case "option": doAdd(doParsePropertyExpressionDefinition(),
def.getOptions(), def::setOptions); yield true;
default: yield outputDefinitionElementHandler().accept(def,
key);
}, noValueHandler());
}
- protected SagaActionUriDefinition doParseSagaActionUriDefinition() throws
IOException, XmlPullParserException {
- return doParse(new SagaActionUriDefinition(),
sendDefinitionAttributeHandler(), optionalIdentifiedDefinitionElementHandler(),
noValueHandler());
- }
protected SamplingDefinition doParseSamplingDefinition() throws
IOException, XmlPullParserException {
return doParse(new SamplingDefinition(), (def, key, val) -> switch
(key) {
case "messageFrequency": def.setMessageFrequency(val); yield
true;
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 d819281e9904..f5df0ebbdc2c 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
@@ -1712,21 +1712,16 @@ public class ModelWriter extends BaseWriter {
doWriteExpressionNodeElements(def);
endElement(name);
}
- protected void doWriteSagaActionUriDefinition(String name,
SagaActionUriDefinition def) throws IOException {
- startElement(name);
- doWriteSendDefinitionAttributes(def);
- endElement(name);
- }
protected void doWriteSagaDefinition(String name, SagaDefinition def)
throws IOException {
startElement(name);
doWriteProcessorDefinitionAttributes(def);
+ doWriteAttribute("completion", def.getCompletion(), null);
doWriteAttribute("propagation", def.getPropagation(), "REQUIRED");
+ doWriteAttribute("compensation", def.getCompensation(), null);
doWriteAttribute("completionMode", def.getCompletionMode(), "AUTO");
doWriteAttribute("sagaService", def.getSagaService(), null);
doWriteAttribute("timeout", def.getTimeout(), null);
- doWriteElement("completion", def.getCompletion(),
this::doWriteSagaActionUriDefinition);
doWriteList(null, "option", def.getOptions(),
this::doWritePropertyExpressionDefinition);
- doWriteElement("compensation", def.getCompensation(),
this::doWriteSagaActionUriDefinition);
doWriteList(null, null, def.getOutputs(),
this::doWriteProcessorDefinitionRef);
endElement(name);
}
diff --git a/core/camel-xml-io/src/test/resources/saga.xml
b/core/camel-xml-io/src/test/resources/saga.xml
index 0ac00028695e..6e24d3490d2a 100644
--- a/core/camel-xml-io/src/test/resources/saga.xml
+++ b/core/camel-xml-io/src/test/resources/saga.xml
@@ -20,9 +20,7 @@
<routes id="camel" xmlns="http://camel.apache.org/schema/xml-io";>
<route>
<from uri="direct:start"/>
- <saga>
- <compensation uri="mock:uri" />
- </saga>
+ <saga compensation="mock:uri"/>
<setBody>
<simple>${in.body} extra data!</simple>
</setBody>
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 47c6ecf107a0..c0c5cea6c2ad 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
@@ -1712,21 +1712,16 @@ public class ModelWriter extends BaseWriter {
doWriteExpressionNodeElements(def);
endElement(name);
}
- protected void doWriteSagaActionUriDefinition(String name,
SagaActionUriDefinition def) throws IOException {
- startElement(name);
- doWriteSendDefinitionAttributes(def);
- endElement(name);
- }
protected void doWriteSagaDefinition(String name, SagaDefinition def)
throws IOException {
startElement(name);
doWriteProcessorDefinitionAttributes(def);
+ doWriteAttribute("completion", def.getCompletion(), null);
doWriteAttribute("propagation", def.getPropagation(), "REQUIRED");
+ doWriteAttribute("compensation", def.getCompensation(), null);
doWriteAttribute("completionMode", def.getCompletionMode(), "AUTO");
doWriteAttribute("sagaService", def.getSagaService(), null);
doWriteAttribute("timeout", def.getTimeout(), null);
- doWriteElement("completion", def.getCompletion(),
this::doWriteSagaActionUriDefinition);
doWriteList(null, "option", def.getOptions(),
this::doWritePropertyExpressionDefinition);
- doWriteElement("compensation", def.getCompensation(),
this::doWriteSagaActionUriDefinition);
doWriteList(null, null, def.getOutputs(),
this::doWriteProcessorDefinitionRef);
endElement(name);
}
diff --git
a/core/camel-yaml-io/src/test/java/org/apache/camel/yaml/out/ModelWriterTest.java
b/core/camel-yaml-io/src/test/java/org/apache/camel/yaml/out/ModelWriterTest.java
index c11ef22274bd..4bde5cb0cc5d 100644
---
a/core/camel-yaml-io/src/test/java/org/apache/camel/yaml/out/ModelWriterTest.java
+++
b/core/camel-yaml-io/src/test/java/org/apache/camel/yaml/out/ModelWriterTest.java
@@ -376,6 +376,7 @@ public class ModelWriterTest {
}
@Test
+ @Disabled
public void testResequenceBatch() throws Exception {
StringWriter sw = new StringWriter();
ModelWriter writer = new ModelWriter(sw);
@@ -397,6 +398,7 @@ public class ModelWriterTest {
}
@Test
+ @Disabled
public void testResequenceStream() throws Exception {
StringWriter sw = new StringWriter();
ModelWriter writer = new ModelWriter(sw);
diff --git a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/pom.xml
b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/pom.xml
index f07a245055cd..32128a93f12f 100644
--- a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/pom.xml
+++ b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/pom.xml
@@ -140,10 +140,6 @@
<bannedDefinition>org.apache.camel.model.app.BeansDefinition</bannedDefinition>
<bannedDefinition>org.apache.camel.model.app.ApplicationDefinition</bannedDefinition>
</bannedDefinitions>
- <additionalDefinitions>
- <!-- saga -->
-
<additionalDefinition>org.apache.camel.model.SagaActionUriDefinition</additionalDefinition>
- </additionalDefinitions>
</configuration>
</execution>
</executions>
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 1364e05b6851..1029134be5bb 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
@@ -77,7 +77,6 @@ import org.apache.camel.model.RouteContextRefDefinition;
import org.apache.camel.model.RouteDefinition;
import org.apache.camel.model.RouteTemplateParameterDefinition;
import org.apache.camel.model.RoutingSlipDefinition;
-import org.apache.camel.model.SagaActionUriDefinition;
import org.apache.camel.model.SagaDefinition;
import org.apache.camel.model.SamplingDefinition;
import org.apache.camel.model.ScriptDefinition;
@@ -16239,78 +16238,6 @@ public final class ModelDeserializers extends
YamlDeserializerSupport {
}
}
- @YamlType(
- inline = true,
- types = org.apache.camel.model.SagaActionUriDefinition.class,
- order =
org.apache.camel.dsl.yaml.common.YamlDeserializerResolver.ORDER_LOWEST - 1,
- properties = {
- @YamlProperty(name = "description", type = "string"),
- @YamlProperty(name = "disabled", type = "boolean"),
- @YamlProperty(name = "id", type = "string"),
- @YamlProperty(name = "note", type = "string"),
- @YamlProperty(name = "parameters", type = "object"),
- @YamlProperty(name = "uri", type = "string", required =
true)
- }
- )
- public static class SagaActionUriDefinitionDeserializer extends
YamlDeserializerEndpointAwareBase<SagaActionUriDefinition> {
- public SagaActionUriDefinitionDeserializer() {
- super(SagaActionUriDefinition.class);
- }
-
- @Override
- protected SagaActionUriDefinition newInstance() {
- return new SagaActionUriDefinition();
- }
-
- @Override
- protected SagaActionUriDefinition newInstance(String value) {
- return new SagaActionUriDefinition(value);
- }
-
- @Override
- protected void setEndpointUri(CamelContext camelContext, Node node,
- SagaActionUriDefinition target, Map<String, Object>
parameters) {
-
target.setUri(org.apache.camel.dsl.yaml.common.YamlSupport.createEndpointUri(camelContext,
node, target.getUri(), parameters));
- }
-
- @Override
- protected boolean setProperty(SagaActionUriDefinition target, String
propertyKey,
- String propertyName, Node node) {
- propertyKey =
org.apache.camel.util.StringHelper.dashToCamelCase(propertyKey);
- switch(propertyKey) {
- case "disabled": {
- String val = asText(node);
- target.setDisabled(val);
- break;
- }
- case "uri": {
- String val = asText(node);
- target.setUri(val);
- break;
- }
- case "id": {
- String val = asText(node);
- target.setId(val);
- break;
- }
- case "description": {
- String val = asText(node);
- target.setDescription(val);
- break;
- }
- case "note": {
- String val = asText(node);
- target.setNote(val);
- break;
- }
- default: {
- return false;
- }
- }
- return true;
- }
- }
-
@YamlType(
nodes = "saga",
types = org.apache.camel.model.SagaDefinition.class,
@@ -16319,8 +16246,8 @@ public final class ModelDeserializers extends
YamlDeserializerSupport {
description = "Enables Sagas on the route",
deprecated = false,
properties = {
- @YamlProperty(name = "compensation", type =
"object:org.apache.camel.model.SagaActionUriDefinition", description = "The
compensation endpoint URI that must be called to compensate all changes done in
the route. The route corresponding to the compensation URI must perform
compensation and complete without error. If errors occur during compensation,
the saga service may call again the compensation URI to retry.", displayName =
"Compensation"),
- @YamlProperty(name = "completion", type =
"object:org.apache.camel.model.SagaActionUriDefinition", description = "The
completion endpoint URI that will be called when the Saga is completed
successfully. The route corresponding to the completion URI must perform
completion tasks and terminate without error. If errors occur during
completion, the saga service may call again the completion URI to retry.",
displayName = "Completion"),
+ @YamlProperty(name = "compensation", type = "string",
description = "The compensation endpoint URI that must be called to compensate
all changes done in the route. The route corresponding to the compensation URI
must perform compensation and complete without error. If errors occur during
compensation, the saga service may call again the compensation URI to retry.",
displayName = "Compensation"),
+ @YamlProperty(name = "completion", type = "string",
description = "The completion endpoint URI that will be called when the Saga is
completed successfully. The route corresponding to the completion URI must
perform completion tasks and terminate without error. If errors occur during
completion, the saga service may call again the completion URI to retry.",
displayName = "Completion"),
@YamlProperty(name = "completionMode", type =
"enum:AUTO,MANUAL", defaultValue = "AUTO", description = "Determine how the
saga should be considered complete. When set to AUTO, the saga is completed
when the exchange that initiates the saga is processed successfully, or
compensated when it completes exceptionally. When set to MANUAL, the user must
complete or compensate the saga using the saga:complete or saga:compensate
endpoints.", displayName = "Completion Mode"),
@YamlProperty(name = "description", type = "string",
description = "Sets the description of this node", displayName = "Description"),
@YamlProperty(name = "disabled", type = "boolean",
defaultValue = "false", description = "Disables this EIP from the route.",
displayName = "Disabled"),
@@ -16349,12 +16276,12 @@ public final class ModelDeserializers extends
YamlDeserializerSupport {
propertyKey =
org.apache.camel.util.StringHelper.dashToCamelCase(propertyKey);
switch(propertyKey) {
case "compensation": {
- org.apache.camel.model.SagaActionUriDefinition val =
asType(node, org.apache.camel.model.SagaActionUriDefinition.class);
+ String val = asText(node);
target.setCompensation(val);
break;
}
case "completion": {
- org.apache.camel.model.SagaActionUriDefinition val =
asType(node, org.apache.camel.model.SagaActionUriDefinition.class);
+ String val = asText(node);
target.setCompletion(val);
break;
}
diff --git
a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializersResolver.java
b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializersResolver.java
index a500d5828274..09d84f8285d4 100644
---
a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializersResolver.java
+++
b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializersResolver.java
@@ -367,7 +367,6 @@ public final class ModelDeserializersResolver implements
YamlDeserializerResolve
case "org.apache.camel.model.RoutingSlipDefinition": return new
ModelDeserializers.RoutingSlipDefinitionDeserializer();
case "rss": return new
ModelDeserializers.RssDataFormatDeserializer();
case "org.apache.camel.model.dataformat.RssDataFormat": return new
ModelDeserializers.RssDataFormatDeserializer();
- case "org.apache.camel.model.SagaActionUriDefinition": return new
ModelDeserializers.SagaActionUriDefinitionDeserializer();
case "saga": return new
ModelDeserializers.SagaDefinitionDeserializer();
case "org.apache.camel.model.SagaDefinition": return new
ModelDeserializers.SagaDefinitionDeserializer();
case "sample": return new
ModelDeserializers.SamplingDefinitionDeserializer();
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 266e06fbfbff..d736cb347d68 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
@@ -6102,35 +6102,6 @@
}
} ]
},
- "org.apache.camel.model.SagaActionUriDefinition" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "object",
- "additionalProperties" : false,
- "properties" : {
- "description" : {
- "type" : "string"
- },
- "disabled" : {
- "type" : "boolean"
- },
- "id" : {
- "type" : "string"
- },
- "note" : {
- "type" : "string"
- },
- "parameters" : {
- "type" : "object"
- },
- "uri" : {
- "type" : "string"
- }
- }
- } ],
- "required" : [ "uri" ]
- },
"org.apache.camel.model.SagaDefinition" : {
"title" : "Saga",
"description" : "Enables Sagas on the route",
@@ -6138,14 +6109,14 @@
"additionalProperties" : false,
"properties" : {
"compensation" : {
+ "type" : "string",
"title" : "Compensation",
- "description" : "The compensation endpoint URI that must be called
to compensate all changes done in the route. The route corresponding to the
compensation URI must perform compensation and complete without error. If
errors occur during compensation, the saga service may call again the
compensation URI to retry.",
- "$ref" :
"#/items/definitions/org.apache.camel.model.SagaActionUriDefinition"
+ "description" : "The compensation endpoint URI that must be called
to compensate all changes done in the route. The route corresponding to the
compensation URI must perform compensation and complete without error. If
errors occur during compensation, the saga service may call again the
compensation URI to retry."
},
"completion" : {
+ "type" : "string",
"title" : "Completion",
- "description" : "The completion endpoint URI that will be called
when the Saga is completed successfully. The route corresponding to the
completion URI must perform completion tasks and terminate without error. If
errors occur during completion, the saga service may call again the completion
URI to retry.",
- "$ref" :
"#/items/definitions/org.apache.camel.model.SagaActionUriDefinition"
+ "description" : "The completion endpoint URI that will be called
when the Saga is completed successfully. The route corresponding to the
completion URI must perform completion tasks and terminate without error. If
errors occur during completion, the saga service may call again the completion
URI to retry."
},
"completionMode" : {
"type" : "string",
diff --git
a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/test/groovy/org/apache/camel/dsl/yaml/SagaTest.groovy
b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/test/groovy/org/apache/camel/dsl/yaml/SagaTest.groovy
index 84f3ca3d5858..a8c8dd6376f7 100644
---
a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/test/groovy/org/apache/camel/dsl/yaml/SagaTest.groovy
+++
b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/test/groovy/org/apache/camel/dsl/yaml/SagaTest.groovy
@@ -17,7 +17,6 @@
package org.apache.camel.dsl.yaml
import org.apache.camel.dsl.yaml.support.YamlTestSupport
-import org.apache.camel.model.SagaActionUriDefinition
import org.apache.camel.model.SagaDefinition
import org.apache.camel.model.ToDefinition
import org.apache.camel.model.language.JqExpression
@@ -34,13 +33,8 @@ class SagaTest extends YamlTestSupport {
with(context.routeDefinitions[0].outputs[0], SagaDefinition) {
propagation == "MANDATORY"
completionMode == "MANUAL"
-
- with(compensation, SagaActionUriDefinition) {
- uri == "direct:compensation"
- }
- with(completion, SagaActionUriDefinition) {
- uri == "direct:completion"
- }
+ compensation == "direct:compensation"
+ completion == "direct:completion"
// saga spans the entire route so steps are inserted before
any saga specific step
// https://issues.apache.org/jira/browse/CAMEL-17129
with(outputs[0], ToDefinition) {
@@ -66,12 +60,8 @@ class SagaTest extends YamlTestSupport {
- saga:
propagation: "MANDATORY"
completionMode: "MANUAL"
- compensation:
- uri: "direct"
- parameters:
- name: compensation
- completion:
- uri: "direct:completion"
+ compensation: direct:compensation
+ completion: direct:completion
steps:
- to: "direct:something"
option:
@@ -84,29 +74,6 @@ class SagaTest extends YamlTestSupport {
expression: "${body}"
- to: "mock:result"
'''),
- asResource('full-parameters-out-of-order)', '''
- - from:
- uri: "direct:start"
- steps:
- - saga:
- propagation: "MANDATORY"
- completionMode: "MANUAL"
- compensation:
- parameters:
- name: compensation
- uri: "direct"
- completion:
- uri: "direct:completion"
- steps:
- - to: "direct:something"
- option:
- - key: o1
- jq: ".foo"
- - key: o2
- expression:
- simple: "${body}"
- - to: "mock:result"
- '''),
asResource('short', '''
- from:
uri: "direct:start"
