CAMEL-23033: camel-yaml-dsl - Setting routePolicy on route should be routePolicyRef. Also polished docs, and made onException route dumper correct for handled/continued

Author: davsclaus

core/camel-core-model/src/main/java/org/apache/camel/model/OnExceptionDefinition.java

@@ -31,10 +31,9 @@
 import org.apache.camel.LoggingLevel;
 import org.apache.camel.Predicate;
 import org.apache.camel.Processor;
-import org.apache.camel.builder.ExpressionBuilder;
+import org.apache.camel.model.language.ConstantExpression;
 import org.apache.camel.spi.AsPredicate;
 import org.apache.camel.spi.Metadata;
-import org.apache.camel.support.ExpressionToPredicateAdapter;
 import org.apache.camel.util.ObjectHelper;
 
 /**
@@ -222,8 +221,8 @@ public OnExceptionDefinition onException(Class<? extends Throwable> exceptionTyp
      * @return         the builder
      */
     public OnExceptionDefinition handled(boolean handled) {
-        Expression expression = ExpressionBuilder.constantExpression(Boolean.toString(handled));
-        return handled(expression);
+        setHandled(new ExpressionSubElementDefinition(new ConstantExpression(Boolean.toString(handled))));
+        return this;
     }
 
     /**
@@ -233,7 +232,7 @@ public OnExceptionDefinition handled(boolean handled) {
      * @return         the builder
      */
     public OnExceptionDefinition handled(@AsPredicate Predicate handled) {
-        setHandledPolicy(handled);
+        setHandled(new ExpressionSubElementDefinition(handled));
         return this;
     }
 
@@ -244,7 +243,7 @@ public OnExceptionDefinition handled(@AsPredicate Predicate handled) {
      * @return         the builder
      */
     public OnExceptionDefinition handled(@AsPredicate Expression handled) {
-        setHandledPolicy(ExpressionToPredicateAdapter.toPredicate(handled));
+        setHandled(new ExpressionSubElementDefinition(handled));
         return this;
     }
 
@@ -257,8 +256,8 @@ public OnExceptionDefinition handled(@AsPredicate Expression handled) {
      * @return           the builder
      */
     public OnExceptionDefinition continued(boolean continued) {
-        Expression expression = ExpressionBuilder.constantExpression(Boolean.toString(continued));
-        return continued(expression);
+        setContinued(new ExpressionSubElementDefinition(new ConstantExpression(Boolean.toString(continued))));
+        return this;
     }
 
     /**
@@ -270,7 +269,7 @@ public OnExceptionDefinition continued(boolean continued) {
      * @return           the builder
      */
     public OnExceptionDefinition continued(@AsPredicate Predicate continued) {
-        setContinuedPolicy(continued);
+        setContinued(new ExpressionSubElementDefinition(continued));
         return this;
     }
 
@@ -283,7 +282,7 @@ public OnExceptionDefinition continued(@AsPredicate Predicate continued) {
      * @return           the builder
      */
     public OnExceptionDefinition continued(@AsPredicate Expression continued) {
-        setContinuedPolicy(ExpressionToPredicateAdapter.toPredicate(continued));
+        setContinued(new ExpressionSubElementDefinition(continued));
         return this;
     }
 
@@ -310,7 +309,7 @@ public OnExceptionDefinition onWhen(@AsPredicate Predicate predicate) {
      * @return            the builder
      */
     public OnExceptionDefinition retryWhile(@AsPredicate Predicate retryWhile) {
-        setRetryWhilePolicy(retryWhile);
+        setRetryWhile(new ExpressionSubElementDefinition(retryWhile));
         return this;
     }
 

docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_18.adoc

@@ -11,6 +11,12 @@ Note that manual migration is still required.
 See the xref:camel-upgrade-recipes-tool.adoc[documentation] page for details.
 ====
 
+== Upgrading from 4.18.0 to 4.18.1
+
+In the YAML DSL we have renamed `routePolicy` to `routePolicyRef` on the `route` node,
+as that is the correct name.
+
+
 == Upgrading Camel 4.17 to 4.18
 
 === camel-simple

docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_19.adoc

@@ -22,6 +22,9 @@ Removed 2 deprecated methods in Java DSL for `throttler` EIP.
 
 === camel-yaml-io / camel-xml-io
 
+In the YAML DSL we have renamed `routePolicy` to `routePolicyRef` on the `route` node,
+as that is the correct name.
+
 When dumping routes in YAML or XML format via `camel-yaml-io` or `camel-xml-io` then the structure of routes
 and all the EIP options now respect the intended order in the model.
 

docs/user-manual/modules/ROOT/pages/cronscheduledroutepolicy.adoc

@@ -26,16 +26,16 @@ information must be provided.
 === Starting a route
 
 [width="100%",cols="25%,25%,25%,25%",options="header",]
-|=======================================================================
+|===
 |Parameter Name |Type |Default Value |Description
 |routeStartTime |String |  |the initial scheduled date and time as a
 Cron Expression for route start
-|=======================================================================
+|===
 
 === Stopping a route
 
 [width="100%",cols="25%,25%,25%,25%",options="header",]
-|=======================================================================
+|===
 |Parameter Name |Type |Default Value |Description
 |routeStopTime |String |  |the initial scheduled date and time as a Cron
 Expression for route stop
@@ -45,33 +45,36 @@ initiating graceful route stop
 
 |routeStopTimeUnit |long |TimeUnit.MILLISECONDS |the time unit for the
 grace period expressed as `java.util.concurrent.TimeUnit`
-|=======================================================================
+|===
 
 === Suspending a route
 
 [width="100%",cols="25%,25%,25%,25%",options="header",]
-|=======================================================================
+|===
 |Parameter Name |Type |Default Value |Description
 |routeSuspendTime |String |  |the initial scheduled date and time as a
 Cron Expression for route suspension
-|=======================================================================
+|===
 
 === Resuming a route
 
 [width="100%",cols="25%,25%,25%,25%",options="header",]
-|=======================================================================
+|===
 |Parameter Name |Type |Default Value |Description
 |routeResumeTime |String |  |the initial scheduled date and time as a
 Cron Expression for route resumption
-|=======================================================================
+|===
 
 == Configuring the route policy
 
 Once the `org.apache.camel.routepolicy.quartz.CronScheduledRoutePolicy`
 is created it can be wired into the Camel route as follows:
 
-In Java:
+[tabs]
+====
 
+Java::
++
 [source,java]
 ----
 CronScheduledRoutePolicy startPolicy = new CronScheduledRoutePolicy();
@@ -82,8 +85,8 @@ from("direct:start")
     .to("mock:success");
 ----
 
-And with Spring XML:
-
+Spring XML::
++
 [source,xml]
 ----
 <bean id="startPolicy" class="org.apache.camel.routepolicy.quartz.CronScheduledRoutePolicy">
@@ -98,6 +101,27 @@ And with Spring XML:
 </camelContext>
 ----
 
+YAML::
++
+[source,yaml]
+----
+- beans:
+  - name: startPolicy
+    type: org.apache.camel.routepolicy.quartz.CronScheduledRoutePolicy
+    properties:
+      routeStartTime: "*/3 * * * * ?"
+- route:
+    id: testRoute
+    autoStartup: "false"
+    routePolicyRef: startPolicy
+    from:
+      uri: direct:start
+      steps:
+        - to:
+            uri: mock:success
+----
+====
+
 IMPORTANT: Notice how the route to be scheduled *MUST* be configured to not
 xref:configuring-route-startup-ordering-and-autostartup.adoc[auto-startup], to let
 the route scheduler take control of starting and stopping the route accordingly.

docs/user-manual/modules/ROOT/pages/debugger.adoc

@@ -15,14 +15,14 @@ method and return `true`.
 In this unit test
 
 [source,java]
------------------------------------------------
+----
 public class DebugTest extends CamelTestSupport
------------------------------------------------
+----
 
 We want to debug the following route
 
 [source,java]
------------------------------------------------
+----
 @Override
 protected RouteBuilder createRouteBuilder() throws Exception {
     return new RouteBuilder() {
@@ -36,7 +36,7 @@ protected RouteBuilder createRouteBuilder() throws Exception {
         }
     };
 }
------------------------------------------------
+----
 
 Which can easily done by overriding the `debugBefore` method as shown
 
@@ -83,7 +83,7 @@ A trick to debug a Camel route written with Java DSL is to modify the route to i
 For instance:
 
 [source,java]
------------------------------------------------
+----
 public class MyRouteBuilder extends RouteBuilder {
 
     @Override
@@ -101,7 +101,7 @@ public class MyRouteBuilder extends RouteBuilder {
         	.log("${body}");
     }
 }
------------------------------------------------
+----
 
 === Implementing a custom debugger
 

docs/user-manual/modules/ROOT/pages/defaulterrorhandler.adoc

@@ -30,28 +30,111 @@ In this route below, any exception thrown in, such as the `validateOrder`
 bean, will be propagated back to the caller via the jetty endpoint, which
 then returns an HTTP error message back to the client.
 
+[tabs]
+====
+
+Java::
++
 [source,java]
 ----
 from("jetty:http://localhost/myservice/order")
   .to("bean:validateOrder")
   .to("jms:queue:order");
 ----
 
+XML::
++
+[source,xml]
+----
+<route>
+    <from uri="jetty:http://localhost/myservice/order"/>
+    <to uri="bean:validateOrder"/>
+    <to uri="jms:queue:order"/>
+</route>
+----
+
+YAML::
++
+[source,yaml]
+----
+- route:
+    from:
+      uri: jetty:http://localhost/myservice/order
+      steps:
+        - to:
+            uri: bean:validateOrder
+        - to:
+            uri: jms:queue:order
+----
+====
+
 We can add an `onException` in case we want to catch certain exceptions
 and route them differently, for instance to catch a
-`ValidationException` and return a fixed response to the caller.
+`org.apache.camel.ValidationException` and return a fixed response to the caller.
+
+[tabs]
+====
 
+Java::
++
 [source,java]
 ----
 onException(ValidationException.class)
   .handled(true)
-  .transform(body(constant("INVALID ORDER")));
+  .transform(constant("INVALID ORDER"));
 
 from("jetty:http://localhost/myservice/order")
   .to("bean:validateOrder")
   .to("jms:queue:order");
 ----
 
+XML::
++
+[source,xml]
+----
+<onException>
+    <exception>org.apache.camel.ValidationException</exception>
+    <handled>
+        <constant>true</constant>
+    </handled>
+    <transform>
+        <constant>INVALID ORDER</constant>
+    </transform>
+</onException>
+
+<route>
+    <from uri="jetty:http://localhost/myservice/order"/>
+    <to uri="bean:validateOrder"/>
+    <to uri="jms:queue:order"/>
+</route>
+----
+
+YAML::
++
+[source,yaml]
+----
+- onException:
+    exception:
+      - org.apache.camel.ValidationException
+    handled:
+      constant:
+        expression: "true"
+    steps:
+      - transform:
+          expression:
+            constant:
+              expression: INVALID ORDER
+- route:
+    from:
+      uri: jetty:http://localhost/myservice/order
+      steps:
+        - to:
+            uri: bean:validateOrder
+        - to:
+            uri: jms:queue:order
+----
+====
+
 When the `ValidationException` is thrown from the `validateOrder` bean,
 it is intercepted by Camel error handler which lets the
 `onException(ValidationException.class)` handle the exception.