Fixed #2126

Author: cowtowncoder

release-notes/VERSION-2.x

@@ -13,6 +13,7 @@ Project: jackson-databind
  (requested by Christopher S)
 #2116: Make NumberSerializers.Base public and its inherited classes not final
  (requested by Édouard M)
+#2126: `DeserializationContext.instantiationException()` throws `InvalidDefinitionException`
 
 2.9.7 (not yet released)
 

src/main/java/com/fasterxml/jackson/databind/DeserializationContext.java

@@ -22,6 +22,7 @@
 import com.fasterxml.jackson.databind.exc.InvalidFormatException;
 import com.fasterxml.jackson.databind.exc.InvalidTypeIdException;
 import com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException;
+import com.fasterxml.jackson.databind.exc.ValueInstantiationException;
 import com.fasterxml.jackson.databind.introspect.Annotated;
 import com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition;
 import com.fasterxml.jackson.databind.jsontype.TypeDeserializer;
@@ -1594,8 +1595,6 @@ public JsonMappingException weirdNativeValueException(Object value, Class<?> ins
      * if necessary.
      */
     public JsonMappingException instantiationException(Class<?> instClass, Throwable cause) {
-        // Most likely problem with Creator definition, right?
-        final JavaType type = constructType(instClass);
         String excMsg;
         if (cause == null) {
             excMsg = "N/A";
@@ -1604,9 +1603,9 @@ public JsonMappingException instantiationException(Class<?> instClass, Throwable
         }
         String msg = String.format("Cannot construct instance of %s, problem: %s",
                 ClassUtil.nameOf(instClass), excMsg);
-        InvalidDefinitionException e = InvalidDefinitionException.from(_parser, msg, type);
-        e.initCause(cause);
-        return e;
+        // [databind#2162]: use specific exception type as we don't know if it's
+        // due to type definition, input, or neither
+        return ValueInstantiationException.from(_parser, msg, constructType(instClass), cause);
     }
 
     /**
@@ -1619,11 +1618,12 @@ public JsonMappingException instantiationException(Class<?> instClass, Throwable
      * if necessary.
      */
     public JsonMappingException instantiationException(Class<?> instClass, String msg0) {
-        // Most likely problem with Creator definition, right?
-        JavaType type = constructType(instClass);
-        String msg = String.format("Cannot construct instance of %s: %s",
-                ClassUtil.nameOf(instClass), msg0);
-        return InvalidDefinitionException.from(_parser, msg, type);
+        // [databind#2162]: use specific exception type as we don't know if it's
+        // due to type definition, input, or neither
+        return ValueInstantiationException.from(_parser,
+                String.format("Cannot construct instance of %s: %s",
+                        ClassUtil.nameOf(instClass), msg0),
+                constructType(instClass));
     }
 
     @Override

src/main/java/com/fasterxml/jackson/databind/deser/std/StdValueInstantiator.java

@@ -439,7 +439,7 @@ public AnnotatedParameter getIncompleteParameter() {
      */
 
     /**
-     * @deprecated Since 2.7 call either {@link #unwrapAndWrapException} or
+     * @deprecated Since 2.7 call either {@link #rewrapCtorProblem} or
      *  {@link #wrapAsJsonMappingException}
      */
     @Deprecated // since 2.7
@@ -457,8 +457,10 @@ protected JsonMappingException wrapException(Throwable t)
     }
 
     /**
-     * @since 2.7
+     * @deprecated Since 2.7 call either {@link #rewrapCtorProblem} or
+     *  {@link #wrapAsJsonMappingException}
      */
+    @Deprecated // since 2.10
     protected JsonMappingException unwrapAndWrapException(DeserializationContext ctxt, Throwable t)
     {
         // 05-Nov-2015, tatu: This used to always unwrap the whole exception, but now only
@@ -472,6 +474,11 @@ protected JsonMappingException unwrapAndWrapException(DeserializationContext ctx
     }
 
     /**
+     * Helper method that will return given {@link Throwable} case as
+     * a {@link JsonMappingException} (if it is of that type), or call
+     * {@link DeserializationContext#instantiationException(Class, Throwable)} to
+     * produce and return suitable {@link JsonMappingException}.
+     *
      * @since 2.7
      */
     protected JsonMappingException wrapAsJsonMappingException(DeserializationContext ctxt,
@@ -485,6 +492,10 @@ protected JsonMappingException wrapAsJsonMappingException(DeserializationContext
     }
 
     /**
+     * Method that subclasses may call for standard handling of an exception thrown when
+     * calling constructor or factory method. Will unwrap {@link ExceptionInInitializerError}
+     * and {@link InvocationTargetException}s, then call {@link #wrapAsJsonMappingException}.
+     *
      * @since 2.7
      */
     protected JsonMappingException rewrapCtorProblem(DeserializationContext ctxt,

src/main/java/com/fasterxml/jackson/databind/exc/ValueInstantiationException.java

@@ -0,0 +1,57 @@
+package com.fasterxml.jackson.databind.exc;
+
+import com.fasterxml.jackson.core.JsonParser;
+
+import com.fasterxml.jackson.databind.JavaType;
+import com.fasterxml.jackson.databind.JsonMappingException;
+
+/**
+ * Exception type used for generic failures during processing by
+ * {@link com.fasterxml.jackson.databind.deser.ValueInstantiator}:
+ * commonly used to wrap exceptions thrown by constructor or factory
+ * method.
+ *<p>
+ * Note that this type is sibling of {@link MismatchedInputException} and
+ * {@link InvalidDefinitionException} since it is not clear if problem is
+ * with input, or type definition (or possibly neither).
+ * It is recommended that if either specific input, or type definition problem
+ * is known, a more accurate exception is used instead.
+ *
+ * @since 2.10
+ */
+@SuppressWarnings("serial")
+public class ValueInstantiationException
+    extends JsonMappingException
+{
+    protected final JavaType _type;
+
+    protected ValueInstantiationException(JsonParser p, String msg,
+            JavaType type, Throwable cause) {
+        super(p, msg, cause);
+        _type = type;
+    }
+
+    protected ValueInstantiationException(JsonParser p, String msg,
+            JavaType type) {
+        super(p, msg);
+        _type = type;
+    }
+
+    public static ValueInstantiationException from(JsonParser p, String msg,
+            JavaType type) {
+        return new ValueInstantiationException(p, msg, type);
+    }
+
+    public static ValueInstantiationException from(JsonParser p, String msg,
+            JavaType type, Throwable cause) {
+        return new ValueInstantiationException(p, msg, type, cause);
+    }
+
+    /**
+     * Accessor for type fully resolved type that had the problem; this should always
+     * known and available, never <code>null</code>
+     */
+    public JavaType getType() {
+        return _type;
+    }
+}

src/test/java/com/fasterxml/jackson/databind/deser/creators/TestCreators2.java

@@ -9,6 +9,9 @@
 import com.fasterxml.jackson.core.*;
 import com.fasterxml.jackson.databind.*;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.exc.InvalidDefinitionException;
+import com.fasterxml.jackson.databind.exc.MismatchedInputException;
+import com.fasterxml.jackson.databind.exc.ValueInstantiationException;
 
 public class TestCreators2 extends BaseMapTest
 {
@@ -190,7 +193,7 @@ public void testExceptionFromConstructor() throws Exception
         try {
             MAPPER.readValue("{}", BustedCtor.class);
             fail("Expected exception");
-        } catch (JsonMappingException e) {
+        } catch (ValueInstantiationException e) {
             verifyException(e, ": foobar");
             // also: should have nested exception
             Throwable t = e.getCause();
@@ -200,6 +203,8 @@ public void testExceptionFromConstructor() throws Exception
             assertNotNull(t);
             assertEquals(IllegalArgumentException.class, t.getClass());
             assertEquals("foobar", t.getMessage());
+        } catch (Exception e) {
+            fail("Should have caught ValueInstantiationException, got: "+e);
         }
     }
 
@@ -210,7 +215,6 @@ public void testSimpleConstructor() throws Exception
         assertEquals("abc", new String(test.bytes, "UTF-8"));
     }
 
-    // Test for [JACKSON-372]
     public void testMissingPrimitives() throws Exception
     {
         Primitives p = MAPPER.readValue("{}", Primitives.class);
@@ -238,11 +242,11 @@ public void testJackson438() throws Exception
         try {
             MAPPER.readValue("{ \"name\":\"foobar\" }", BeanFor438.class);
             fail("Should have failed");
-        } catch (Exception e0) {
+        } catch (JsonMappingException e0) {
             e = e0;
         }
-        if (!(e instanceof JsonMappingException)) {
-            fail("Should have received JsonMappingException, caught "+e.getClass().getName());
+        if (!(e instanceof ValueInstantiationException)) {
+            fail("Should have received ValueInstantiationException, caught "+e.getClass().getName());
         }
         verifyException(e, "don't like that name");
         // Ok: also, let's ensure root cause is directly linked, without other extra wrapping:
@@ -259,7 +263,7 @@ public void testCreatorWithDupNames() throws Exception
         try {
             MAPPER.readValue("{\"bar\":\"x\"}", BrokenCreatorBean.class);
             fail("Should have caught duplicate creator parameters");
-        } catch (JsonMappingException e) {
+        } catch (InvalidDefinitionException e) {
             verifyException(e, "duplicate creator property \"bar\"");
             verifyException(e, "for type `com.fasterxml.jackson.databind.");
             verifyException(e, "$BrokenCreatorBean`");
@@ -278,7 +282,7 @@ public void testIgnoredSingleArgCtor() throws Exception
         try {
             MAPPER.readValue(quote("abc"), IgnoredCtor.class);
             fail("Should have caught missing constructor problem");
-        } catch (JsonMappingException e) {
+        } catch (MismatchedInputException e) {
             verifyException(e, "no String-argument constructor/factory method");
         }
     }

src/test/java/com/fasterxml/jackson/databind/deser/filter/ProblemHandlerTest.java

@@ -10,8 +10,8 @@
 import com.fasterxml.jackson.databind.*;
 import com.fasterxml.jackson.databind.deser.DeserializationProblemHandler;
 import com.fasterxml.jackson.databind.deser.ValueInstantiator;
-import com.fasterxml.jackson.databind.exc.InvalidDefinitionException;
 import com.fasterxml.jackson.databind.exc.InvalidTypeIdException;
+import com.fasterxml.jackson.databind.exc.ValueInstantiationException;
 import com.fasterxml.jackson.databind.jsontype.TypeIdResolver;
 
 /**
@@ -92,14 +92,14 @@ static class InstantiationProblemHandler
         public InstantiationProblemHandler(Object v0) {
             value = v0;
         }
-    
+
         @Override
         public Object handleInstantiationProblem(DeserializationContext ctxt,
                 Class<?> instClass, Object argument, Throwable t)
             throws IOException
         {
-            if (!(t instanceof InvalidDefinitionException)) {
-                throw new IllegalArgumentException("Should have gotten `InvalidDefinitionException`, instead got: "+t);
+            if (!(t instanceof ValueInstantiationException)) {
+                throw new IllegalArgumentException("Should have gotten `ValueInstantiationException`, instead got: "+t);
             }
             return value;
         }
@@ -109,7 +109,7 @@ static class MissingInstantiationHandler
         extends DeserializationProblemHandler
     {
         protected final Object value;
-    
+
         public MissingInstantiationHandler(Object v0) {
             value = v0;
         }