Fix #2382: allow AutoCloseable closing with SerializationFeature.CLOSE_CLOSEABLE (#4836)

Author: cowtowncoder

release-notes/VERSION

@@ -43,6 +43,8 @@ Versions: 3.x (for earlier see VERSION-2.x)
 #2040: Remove `JsonSerializer.isEmpty()` from 3.0
 #2176: Add `JsonMapper.shared()` static method
 #2177: Change parent type of `JsonProcessingException` to be `RuntimeException`
+#2382: Support `AutoCloseable` with `SerializationFeature.CLOSE_CLOSEABLE`
+ (requested by @Logic-32)
 #2405: Make `java.sql.Date` serializer default to same output as `java.util.Date`
 #2411: `valueToTree()` during serialization (via `SerializerProvider()`)
  (requested by XakepSDK@github)

src/main/java/tools/jackson/databind/ObjectMapper.java

@@ -1232,7 +1232,8 @@ public void writeValue(JsonGenerator g, Object value) throws JacksonException
             }
         }
         */
-        if (config.isEnabled(SerializationFeature.CLOSE_CLOSEABLE) && (value instanceof Closeable)) {
+        if (config.isEnabled(SerializationFeature.CLOSE_CLOSEABLE)
+                && (value instanceof AutoCloseable)) {
             _writeCloseableValue(g, value, config);
         } else {
             _serializationContext(config).serializeValue(g, value);
@@ -1876,7 +1877,8 @@ protected final void _configAndWriteValue(SerializationContextExt prov,
             JsonGenerator g, Object value)
         throws JacksonException
     {
-        if (prov.isEnabled(SerializationFeature.CLOSE_CLOSEABLE) && (value instanceof Closeable)) {
+        if (prov.isEnabled(SerializationFeature.CLOSE_CLOSEABLE)
+                && (value instanceof AutoCloseable)) {
             _configAndWriteCloseable(prov, g, value);
             return;
         }
@@ -1897,10 +1899,10 @@ private final void _configAndWriteCloseable(SerializationContextExt prov,
             JsonGenerator g, Object value)
         throws JacksonException
     {
-        Closeable toClose = (Closeable) value;
+        AutoCloseable toClose = (AutoCloseable) value;
         try {
             prov.serializeValue(g, value);
-            Closeable tmpToClose = toClose;
+            AutoCloseable tmpToClose = toClose;
             toClose = null;
             tmpToClose.close();
         } catch (Exception e) {

src/main/java/tools/jackson/databind/ObjectWriter.java

@@ -950,9 +950,9 @@ public void writeValue(JsonGenerator g, Object value)
     {
         _assertNotNull("g", g);
         if (_config.isEnabled(SerializationFeature.CLOSE_CLOSEABLE)
-                && (value instanceof Closeable))
+                && (value instanceof AutoCloseable))
         {
-            Closeable toClose = (Closeable) value;
+            AutoCloseable toClose = (AutoCloseable) value;
             try {
                 _prefetch.serialize(g, value, _serializationContext());
                 if (_config.isEnabled(SerializationFeature.FLUSH_AFTER_WRITE_VALUE)) {
@@ -966,6 +966,8 @@ public void writeValue(JsonGenerator g, Object value)
                 toClose.close();
             } catch (IOException e) {
                 throw JacksonIOException.construct(e, g);
+            } catch (Exception e) {
+                ClassUtil.closeOnFailAndThrowAsJacksonE(g, e);
             }
         } else {
             _prefetch.serialize(g, value, _serializationContext());
@@ -1101,7 +1103,8 @@ public byte[] writeValueAsBytes(Object value) throws JacksonException
     protected final void _configAndWriteValue(SerializationContextExt ctxt,
             JsonGenerator gen, Object value) throws JacksonException
     {
-        if (_config.isEnabled(SerializationFeature.CLOSE_CLOSEABLE) && (value instanceof Closeable)) {
+        if (_config.isEnabled(SerializationFeature.CLOSE_CLOSEABLE)
+                && (value instanceof AutoCloseable)) {
             _writeCloseable(gen, value);
             return;
         }
@@ -1121,10 +1124,10 @@ protected final void _configAndWriteValue(SerializationContextExt ctxt,
     private final void _writeCloseable(JsonGenerator gen, Object value)
         throws JacksonException
     {
-        Closeable toClose = (Closeable) value;
+        AutoCloseable toClose = (AutoCloseable) value;
         try {
             _prefetch.serialize(gen, value, _serializationContext());
-            Closeable tmpToClose = toClose;
+            AutoCloseable tmpToClose = toClose;
             toClose = null;
             tmpToClose.close();
         } catch (Exception e) {

src/main/java/tools/jackson/databind/SerializationFeature.java

@@ -129,22 +129,27 @@ public enum SerializationFeature implements ConfigFeature
     /**********************************************************************
      */
 
-     /**
-      * Feature that determines whether <code>close</code> method of
-      * serialized <b>root level</b> objects (ones for which <code>ObjectMapper</code>'s
-      * writeValue() (or equivalent) method is called)
-      * that implement {@link java.io.Closeable}
-      * is called after serialization or not. If enabled, <b>close()</b> will
-      * be called after serialization completes (whether succesfully, or
-      * due to an error manifested by an exception being thrown). You can
-      * think of this as sort of "finally" processing.
-      *<p>
-      * NOTE: only affects behavior with <b>root</b> objects, and not other
-      * objects reachable from the root object. Put another way, only one
-      * call will be made for each 'writeValue' call.
+    /**
+     * Feature that determines whether {@code close()} method of
+     * serialized <b>root level</b> objects (ones for which {@link ObjectMapper}'s
+     * (and {@link ObjectWriter}'s)
+     * writeValue() (or equivalent) method is called)
+     * that implement {@link java.lang.AutoCloseable}
+     * is called after serialization or not. If enabled, <b>close()</b> will
+     * be called after serialization completes (whether successfully, or
+     * due to an error manifested by an exception being thrown). You can
+     * think of this as sort of "finally" processing.
+     *<p>
+     * NOTE: only affects behavior with <b>root</b> objects, and not other
+     * objects reachable from the root object. Put another way, only one
+     * call will be made for each 'writeValue' call.
+     *<p>
+     * NOTE: in Jackson 2.x this used to only apply to {@link java.io.Closeable}s,
+     * but now it also applies to {@link java.lang.AutoCloseable}s as well (as
+     * of Jackson 3.0).
      *<p>
      * Feature is disabled by default.
-      */
+     */
     CLOSE_CLOSEABLE(false),
 
     /**

src/main/java/tools/jackson/databind/util/ClassUtil.java

@@ -391,7 +391,7 @@ public static void closeOnFailAndThrowAsJacksonE(JsonGenerator g, Exception fail
      * secondary exception without masking original one.
      */
     public static void closeOnFailAndThrowAsJacksonE(JsonGenerator g,
-            Closeable toClose, Exception fail)
+            AutoCloseable toClose, Exception fail)
         throws JacksonException
     {
         if (g != null) {

src/test/java/tools/jackson/databind/ser/SerializationFeaturesTest.java

@@ -18,7 +18,7 @@
 public class SerializationFeaturesTest
     extends DatabindTestUtil
 {
-    static class CloseableBean implements Closeable
+    static class CloseableBean implements AutoCloseable
     {
         public int a = 3;
 
@@ -43,7 +43,7 @@ private static class StringListBean {
     /**********************************************************
      */
 
-    private final ObjectMapper MAPPER = new ObjectMapper();
+    private final ObjectMapper MAPPER = newJsonMapper();
 
     @SuppressWarnings("resource")
     @Test
@@ -54,10 +54,23 @@ public void testCloseCloseable() throws IOException
         MAPPER.writeValueAsString(bean);
         assertFalse(bean.wasClosed);
 
-        // but can enable it:
+        // via writer as well
         bean = new CloseableBean();
         MAPPER.writer()
-            .with(SerializationFeature.CLOSE_CLOSEABLE)
+            .writeValueAsString(bean);
+        assertFalse(bean.wasClosed);
+        
+        // but can enable it:
+        ObjectMapper mapper2 = jsonMapperBuilder()
+                .enable(SerializationFeature.CLOSE_CLOSEABLE)
+                .build();
+        bean = new CloseableBean();
+        mapper2.writeValueAsString(bean);
+        assertTrue(bean.wasClosed);
+
+        // and same via writer
+        bean = new CloseableBean();
+        mapper2.writer()
             .writeValueAsString(bean);
         assertTrue(bean.wasClosed);