CAMEL-8799: Make it possible for JsonPath to suppress PathNotFoundExc…

…eption
apache · May 30, 2015 · 9732938 · 9732938
1 parent 0654622
commit 9732938
Show file tree

Hide file tree

Showing 7 changed files with 92 additions and 9 deletions.
diff --git a/camel-core/src/main/java/org/apache/camel/builder/ExpressionClauseSupport.java b/camel-core/src/main/java/org/apache/camel/builder/ExpressionClauseSupport.java
@@ -333,7 +333,21 @@ public T javaScript(String text) {
      * @return the builder to continue processing the DSL
      */
     public T jsonpath(String text) {
-        return expression(new JsonPathExpression(text));
+        return jsonpath(text, false);
+    }
+
+    /**
+     * Evaluates a <a href="http://camel.apache.org/jsonpath.html">Json Path
+     * expression</a>
+     *
+     * @param text the expression to be evaluated
+     * @param suppressExceptions whether to suppress exceptions such as PathNotFoundException
+     * @return the builder to continue processing the DSL
+     */
+    public T jsonpath(String text, boolean suppressExceptions) {
+        JsonPathExpression expression = new JsonPathExpression(text);
+        expression.setSuppressExceptions(suppressExceptions);
+        return expression(expression);
     }
 
     /**
@@ -351,6 +365,23 @@ public T jsonpath(String text, Class<?> resultType) {
         return result;
     }
 
+    /**
+     * Evaluates a <a href="http://camel.apache.org/jsonpath.html">Json Path
+     * expression</a>
+     *
+     * @param text the expression to be evaluated
+     * @param suppressExceptions whether to suppress exceptions such as PathNotFoundException
+     * @param resultType the return type expected by the expression
+     * @return the builder to continue processing the DSL
+     */
+    public T jsonpath(String text, boolean suppressExceptions, Class<?> resultType) {
+        JsonPathExpression expression = new JsonPathExpression(text);
+        expression.setSuppressExceptions(suppressExceptions);
+        expression.setResultType(resultType);
+        setExpressionType(expression);
+        return result;
+    }
+
     /**
      * Evaluates a <a href="http://commons.apache.org/jxpath/">JXPath expression</a>
      *

diff --git a/camel-core/src/main/java/org/apache/camel/model/language/JsonPathExpression.java b/camel-core/src/main/java/org/apache/camel/model/language/JsonPathExpression.java
@@ -42,6 +42,8 @@ public class JsonPathExpression extends ExpressionDefinition {
     private String resultTypeName;
     @XmlTransient
     private Class<?> resultType;
+    @XmlAttribute @Metadata(defaultValue = "false")
+    private Boolean suppressExceptions;
 
     public JsonPathExpression() {
     }
@@ -72,6 +74,17 @@ public void setResultType(Class<?> resultType) {
         this.resultType = resultType;
     }
 
+    public Boolean getSuppressExceptions() {
+        return suppressExceptions;
+    }
+
+    /**
+     * Whether to suppress exceptions such as PathNotFoundException.
+     */
+    public void setSuppressExceptions(Boolean suppressExceptions) {
+        this.suppressExceptions = suppressExceptions;
+    }
+
     public String getLanguage() {
         return "jsonpath";
     }
@@ -93,6 +106,9 @@ protected void configureExpression(CamelContext camelContext, Expression express
         if (resultType != null) {
             setProperty(expression, "resultType", resultType);
         }
+        if (suppressExceptions != null) {
+            setProperty(expression, "suppressExceptions", suppressExceptions);
+        }
         super.configureExpression(camelContext, expression);
     }
 
@@ -101,6 +117,9 @@ protected void configurePredicate(CamelContext camelContext, Predicate predicate
         if (resultType != null) {
             setProperty(predicate, "resultType", resultType);
         }
+        if (suppressExceptions != null) {
+            setProperty(predicate, "suppressExceptions", suppressExceptions);
+        }
         super.configurePredicate(camelContext, predicate);
     }
 

diff --git a/components/camel-jsonpath/src/main/java/org/apache/camel/jsonpath/JsonPath.java b/components/camel-jsonpath/src/main/java/org/apache/camel/jsonpath/JsonPath.java
@@ -40,6 +40,11 @@
 
     String value();
 
+    /**
+     * Whether to suppress exceptions such as PathNotFoundException
+     */
+    boolean suppressExceptions() default false;
+
     /**
      * To configure the json path options to use
      */

diff --git a/...jsonpath/src/main/java/org/apache/camel/jsonpath/JsonPathAnnotationExpressionFactory.java b/...jsonpath/src/main/java/org/apache/camel/jsonpath/JsonPathAnnotationExpressionFactory.java
@@ -39,6 +39,9 @@ public Expression createExpression(CamelContext camelContext, Annotation annotat
 
         if (annotation instanceof JsonPath) {
             JsonPath jsonPathAnnotation = (JsonPath) annotation;
+
+            answer.setSuppressExceptions(jsonPathAnnotation.suppressExceptions());
+
             Option[] options = jsonPathAnnotation.options();
             answer.setOptions(options);
         }

diff --git a/components/camel-jsonpath/src/main/java/org/apache/camel/jsonpath/JsonPathEngine.java b/components/camel-jsonpath/src/main/java/org/apache/camel/jsonpath/JsonPathEngine.java
@@ -40,15 +40,23 @@ public class JsonPathEngine {
     private final Configuration configuration;
 
     public JsonPathEngine(String expression) {
-        this(expression, null);
+        this(expression, false, null);
     }
 
-    public JsonPathEngine(String expression, Option[] options) {
+    public JsonPathEngine(String expression, boolean suppressExceptions, Option[] options) {
         Defaults defaults = DefaultsImpl.INSTANCE;
         if (options != null) {
-            this.configuration = Configuration.builder().jsonProvider(defaults.jsonProvider()).options(options).build();
+            Configuration.ConfigurationBuilder builder = Configuration.builder().jsonProvider(defaults.jsonProvider()).options(options);
+            if (suppressExceptions) {
+                builder.options(Option.SUPPRESS_EXCEPTIONS);
+            }
+            this.configuration = builder.build();
         } else {
-            this.configuration = Configuration.builder().jsonProvider(defaults.jsonProvider()).build();
+            Configuration.ConfigurationBuilder builder = Configuration.builder().jsonProvider(defaults.jsonProvider());
+            if (suppressExceptions) {
+                builder.options(Option.SUPPRESS_EXCEPTIONS);
+            }
+            this.configuration = builder.build();
         }
         this.path = JsonPath.compile(expression);
     }

diff --git a/components/camel-jsonpath/src/main/java/org/apache/camel/jsonpath/JsonPathExpression.java b/components/camel-jsonpath/src/main/java/org/apache/camel/jsonpath/JsonPathExpression.java
@@ -28,6 +28,7 @@ public class JsonPathExpression extends ExpressionAdapter {
     private JsonPathEngine engine;
 
     private Class<?> resultType;
+    private boolean suppressExceptions;
     private Option[] options;
 
     public JsonPathExpression(String expression) {
@@ -36,7 +37,7 @@ public JsonPathExpression(String expression) {
 
     public void init() {
         try {
-            engine = new JsonPathEngine(expression, options);
+            engine = new JsonPathEngine(expression, suppressExceptions, options);
         } catch (Exception e) {
             throw new ExpressionIllegalSyntaxException(expression, e);
         }
@@ -46,14 +47,31 @@ public Class<?> getResultType() {
         return resultType;
     }
 
+    /**
+     * To configure the result type to use
+     */
     public void setResultType(Class<?> resultType) {
         this.resultType = resultType;
     }
 
+    public boolean isSuppressExceptions() {
+        return suppressExceptions;
+    }
+
+    /**
+     * Whether to suppress exceptions such as PathNotFoundException
+     */
+    public void setSuppressExceptions(boolean suppressExceptions) {
+        this.suppressExceptions = suppressExceptions;
+    }
+
     public Option[] getOptions() {
         return options;
     }
 
+    /**
+     * To configure the json path options to use
+     */
     public void setOptions(Option[] options) {
         this.options = options;
     }

diff --git a/...amel/jsonpath/JsonPathBeanOptionTest.java → ...h/JsonPathBeanSuppressExceptionsTest.java b/...amel/jsonpath/JsonPathBeanOptionTest.java → ...h/JsonPathBeanSuppressExceptionsTest.java
@@ -16,12 +16,11 @@
  */
 package org.apache.camel.jsonpath;
 
-import com.jayway.jsonpath.Option;
 import org.apache.camel.builder.RouteBuilder;
 import org.apache.camel.test.junit4.CamelTestSupport;
 import org.junit.Test;
 
-public class JsonPathBeanOptionTest extends CamelTestSupport {
+public class JsonPathBeanSuppressExceptionsTest extends CamelTestSupport {
 
     @Test
     public void testFullName() throws Exception {
@@ -52,7 +51,7 @@ public void configure() {
     protected static class FullNameBean {
         // middle name is optional
         public static String getName(@JsonPath("person.firstname") String first,
-                                     @JsonPath(value = "person.middlename", options = Option.SUPPRESS_EXCEPTIONS) String middle,
+                                     @JsonPath(value = "person.middlename", suppressExceptions = true) String middle,
                                      @JsonPath("person.lastname") String last) {
             if (middle != null) {
                 return first + " " + middle + " " + last;