Configure jackson to turn off FAIL_ON_UNKNOWN_PROPERTIES. This ensures that Jackson is

more lenient when it sees extra attributes in the request payload. Add custom exception
mapper for handling jackson json exceptions during deserialization

Change-Id: Id2da67b4edfc92f1d11e41fd349814c2de05079c
Signed-off-by: Prasanth Pallamreddy <ppallamr@cisco.com>

diff --git a/opendaylight/northbound/commons/pom.xml b/opendaylight/northbound/commons/pom.xml
index 692b17a9a6c5409bdb38d1e729b504a5177a4f27..972bece91fd2ce9e0400bf2500397e76a2d19691 100644 (file)
--- a/opendaylight/northbound/commons/pom.xml
+++ b/opendaylight/northbound/commons/pom.xml
@@ -48,7 +48,9 @@
               org.osgi.service.packageadmin,
               org.osgi.util.tracker,
               javax.servlet.http,
+              org.codehaus.jackson,
               org.codehaus.jackson.jaxrs,
+              org.codehaus.jackson.map,
               org.slf4j
             </Import-Package>
           </instructions>

diff --git a/opendaylight/northbound/commons/src/main/java/org/opendaylight/controller/northbound/commons/JacksonJsonProcessingExceptionMapper.java b/opendaylight/northbound/commons/src/main/java/org/opendaylight/controller/northbound/commons/JacksonJsonProcessingExceptionMapper.java
new file mode 100644 (file)
index 0000000..ca0d1b7
--- /dev/null
+++ b/opendaylight/northbound/commons/src/main/java/org/opendaylight/controller/northbound/commons/JacksonJsonProcessingExceptionMapper.java
@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.opendaylight.controller.northbound.commons;
+
+import javax.ws.rs.Consumes;
+import javax.ws.rs.core.GenericEntity;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.ext.ExceptionMapper;
+import javax.ws.rs.ext.Provider;
+
+import org.codehaus.jackson.JsonProcessingException;
+
+/**
+ * A custom exception mapper for handling Jackson JsonProcessingException types
+ */
+@Provider
+@Consumes({MediaType.APPLICATION_JSON, "text/json"})
+public class JacksonJsonProcessingExceptionMapper
+    implements ExceptionMapper<JsonProcessingException>
+{
+
+    @Override
+    public Response toResponse(JsonProcessingException exception) {
+        GenericEntity<String> entity =
+                new GenericEntity<String>(exception.getMessage()) {};
+        return Response.status(Response.Status.BAD_REQUEST).entity(entity).build();
+    }
+}
+

diff --git a/opendaylight/northbound/commons/src/main/java/org/opendaylight/controller/northbound/commons/NorthboundApplication.java b/opendaylight/northbound/commons/src/main/java/org/opendaylight/controller/northbound/commons/NorthboundApplication.java
index 1d3919f4ea396739af2dfb89a953a24cf59dd5de..5b8219126b8abbb7c82124b22f502505c2791e8c 100644 (file)
--- a/opendaylight/northbound/commons/src/main/java/org/opendaylight/controller/northbound/commons/NorthboundApplication.java
+++ b/opendaylight/northbound/commons/src/main/java/org/opendaylight/controller/northbound/commons/NorthboundApplication.java
@@ -20,6 +20,7 @@ import javax.xml.bind.JAXBException;
 import javax.xml.bind.annotation.XmlRootElement;
 
 import org.codehaus.jackson.jaxrs.JacksonJaxbJsonProvider;
+import org.codehaus.jackson.map.DeserializationConfig;
 import org.opendaylight.controller.northbound.bundlescanner.IBundleScanService;
 import org.osgi.framework.Bundle;
 import org.osgi.framework.BundleContext;
@@ -54,7 +55,8 @@ public class NorthboundApplication extends Application {
             }
 
         } );
-        singletons.add(new JacksonJaxbJsonProvider());
+        singletons.add(getJsonProvider());
+        singletons.add(new JacksonJsonProcessingExceptionMapper());
         return singletons;
     }
 
@@ -65,6 +67,13 @@ public class NorthboundApplication extends Application {
         return result;
     }
 
+    private static final JacksonJaxbJsonProvider getJsonProvider() {
+        JacksonJaxbJsonProvider jsonProvider = new JacksonJaxbJsonProvider();
+        jsonProvider.configure(DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES,
+                false);
+        return jsonProvider;
+    }
+
     private BundleContext getBundleContext() {
         ClassLoader tlcl = Thread.currentThread().getContextClassLoader();
         Bundle bundle = null;

diff --git a/opendaylight/northbound/integrationtest/src/test/java/org/opendaylight/controller/northbound/integrationtest/NorthboundIT.java b/opendaylight/northbound/integrationtest/src/test/java/org/opendaylight/controller/northbound/integrationtest/NorthboundIT.java
index 4404951135391f632a968aae8345e472e8f413c0..e7ca7f57822a438e4243a29115fd38f854dce5ed 100644 (file)
--- a/opendaylight/northbound/integrationtest/src/test/java/org/opendaylight/controller/northbound/integrationtest/NorthboundIT.java
+++ b/opendaylight/northbound/integrationtest/src/test/java/org/opendaylight/controller/northbound/integrationtest/NorthboundIT.java
@@ -428,6 +428,11 @@ public class NorthboundIT {
         // Test GET deleted subnet1
         result = getJsonResult(baseURL + "default/subnet/" + name1);
         Assert.assertEquals(404, httpResponseCode.intValue());
+
+        // TEST PUT bad subnet, expect 400, validate JSON exception mapper
+        JSONObject joBad = new JSONObject().put("foo", "bar");
+        result = getJsonResult(baseURL + "default/subnet/foo", "PUT", joBad.toString());
+        Assert.assertEquals(400, httpResponseCode.intValue());
   }
 
     @Test