Fix #1605

Author: cowtowncoder

release-notes/CREDITS

@@ -642,3 +642,8 @@ Harleen Sahni (harleensahni@github)
   * Reported #403: Make FAIL_ON_NULL_FOR_PRIMITIVES apply to primitive arrays and other
     types that wrap primitives
    (2.9.0)
+
+Jared Jacobs (2is10@github)
+  * Requested #1605: Allow serialization of `InetAddress` as simple numeric host address
+   (2.9.0)
+

release-notes/VERSION

@@ -74,6 +74,8 @@ Project: jackson-databind
 #1554: Support deserialization of `Shape.OBJECT` ("as POJO") for `Map`s (and map-like types)
 #1556: Add `ObjectMapper.updateValue()` method to update instance with given overrides
  (suggested by syncer@github)
+#1605: Allow serialization of `InetAddress` as simple numeric host address
+ (requested by Jared J)
 
 2.8.9 (not yet released)
 

src/main/java/com/fasterxml/jackson/databind/module/SimpleModule.java

@@ -33,7 +33,7 @@ public class SimpleModule
 
     protected final String _name;
     protected final Version _version;
-    
+
     protected SimpleSerializers _serializers = null;
     protected SimpleDeserializers _deserializers = null;
 

src/main/java/com/fasterxml/jackson/databind/ser/std/InetAddressSerializer.java

@@ -3,38 +3,90 @@
 import java.io.IOException;
 import java.net.InetAddress;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.core.*;
+import com.fasterxml.jackson.databind.BeanProperty;
+import com.fasterxml.jackson.databind.JsonMappingException;
+import com.fasterxml.jackson.databind.JsonSerializer;
 import com.fasterxml.jackson.databind.SerializerProvider;
 import com.fasterxml.jackson.databind.jsontype.TypeSerializer;
+import com.fasterxml.jackson.databind.ser.ContextualSerializer;
 
 /**
  * Simple serializer for {@link java.net.InetAddress}. Main complexity is
  * with registration, since same serializer is to be used for sub-classes.
+ *<p>
+ * Since 2.9 allows use of {@link JsonFormat} configuration (annotation,
+ * per-type defaulting) so that if <code>JsonFormat.Shape.NUMBER</code>
+ * (or <code>ARRAY</code>) is used, will serialize as "host address"
+ * (dotted numbers) instead of simple conversion.
  */
 @SuppressWarnings("serial")
 public class InetAddressSerializer
     extends StdScalarSerializer<InetAddress>
+    implements ContextualSerializer
 {
-    public InetAddressSerializer() { super(InetAddress.class); }
+    /**
+     * @since 2.9
+     */
+    protected final boolean _asNumeric;
 
+    public InetAddressSerializer() {
+        this(false);
+    }
+
+    /**
+     * @since 2.9
+     */
+    public InetAddressSerializer(boolean asNumeric) {
+        super(InetAddress.class);
+        _asNumeric = asNumeric;
+    }
+    
     @Override
-    public void serialize(InetAddress value, JsonGenerator jgen, SerializerProvider provider) throws IOException
+    public JsonSerializer<?> createContextual(SerializerProvider serializers,
+            BeanProperty property) throws JsonMappingException
     {
-        // Ok: get textual description; choose "more specific" part
-        String str = value.toString().trim();
-        int ix = str.indexOf('/');
-        if (ix >= 0) {
-            if (ix == 0) { // missing host name; use address
-                str = str.substring(1);
-            } else { // otherwise use name
-                str = str.substring(0, ix);
+        JsonFormat.Value format = findFormatOverrides(serializers,
+                property, handledType());
+        boolean asNumeric = false;
+        if (format != null) {
+            JsonFormat.Shape shape = format.getShape();
+            if (shape.isNumeric() || shape == JsonFormat.Shape.ARRAY) {
+                asNumeric = true;
+            }
+        }
+        if (asNumeric != _asNumeric) {
+            return new InetAddressSerializer(asNumeric);
+        }
+        return this;
+    }
+
+    @Override
+    public void serialize(InetAddress value, JsonGenerator g, SerializerProvider provider) throws IOException
+    {
+        String str;
+
+        if (_asNumeric) { // since 2.9
+            str = value.getHostAddress();
+        } else {
+            // Ok: get textual description; choose "more specific" part
+            str = value.toString().trim();
+            int ix = str.indexOf('/');
+            if (ix >= 0) {
+                if (ix == 0) { // missing host name; use address
+                    str = str.substring(1);
+                } else { // otherwise use name
+                    str = str.substring(0, ix);
+                }
             }
         }
-        jgen.writeString(str);
+        g.writeString(str);
     }
 
     @Override
-    public void serializeWithType(InetAddress value, JsonGenerator jgen, SerializerProvider provider, TypeSerializer typeSer) throws IOException, JsonGenerationException
+    public void serializeWithType(InetAddress value, JsonGenerator jgen, SerializerProvider provider,
+            TypeSerializer typeSer) throws IOException, JsonGenerationException
     {
         // Better ensure we don't use specific sub-classes...
         typeSer.writeTypePrefixForScalar(value, jgen, InetAddress.class);

src/test/java/com/fasterxml/jackson/databind/ser/jdk/TestJdkTypes.java renamed to src/test/java/com/fasterxml/jackson/databind/ser/jdk/JDKTypeSerializationTest.java

@@ -9,18 +9,25 @@
 import java.util.*;
 import java.util.regex.Pattern;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.*;
 
 /**
  * Unit tests for JDK types not covered by other tests (i.e. things
  * that are not Enums, Collections, Maps, or standard Date/Time types)
  */
-public class TestJdkTypes
+public class JDKTypeSerializationTest
     extends com.fasterxml.jackson.databind.BaseMapTest
 {
     private final ObjectMapper MAPPER = objectMapper();
 
+    static class InetAddressBean {
+        public InetAddress value;
+
+        public InetAddressBean(InetAddress i) { value = i; }
+    }
+    
     public void testBigDecimal() throws Exception
     {
         Map<String, Object> map = new HashMap<String, Object>();
@@ -83,19 +90,26 @@ public void testLocale() throws IOException
     public void testInetAddress() throws IOException
     {
         assertEquals(quote("127.0.0.1"), MAPPER.writeValueAsString(InetAddress.getByName("127.0.0.1")));
-        assertEquals(quote("google.com"), MAPPER.writeValueAsString(InetAddress.getByName("google.com")));
+        InetAddress input = InetAddress.getByName("google.com");
+        assertEquals(quote("google.com"), MAPPER.writeValueAsString(input));
+
+        ObjectMapper mapper = new ObjectMapper();
+        mapper.configOverride(InetAddress.class)
+            .setFormat(JsonFormat.Value.forShape(JsonFormat.Shape.NUMBER));
+        String json = mapper.writeValueAsString(input);
+        assertEquals(quote(input.getHostAddress()), json);
+
+        assertEquals(String.format("{\"value\":\"%s\"}", input.getHostAddress()),
+                mapper.writeValueAsString(new InetAddressBean(input)));
     }
 
     public void testInetSocketAddress() throws IOException
     {
-        assertEquals(
-                quote("127.0.0.1:8080"),
+        assertEquals(quote("127.0.0.1:8080"),
                 MAPPER.writeValueAsString(new InetSocketAddress("127.0.0.1", 8080)));
-        assertEquals(
-                quote("google.com:6667"),
+        assertEquals(quote("google.com:6667"),
                 MAPPER.writeValueAsString(new InetSocketAddress("google.com", 6667)));
-        assertEquals(
-                quote("[2001:db8:85a3:8d3:1319:8a2e:370:7348]:443"),
+        assertEquals(quote("[2001:db8:85a3:8d3:1319:8a2e:370:7348]:443"),
                 MAPPER.writeValueAsString(new InetSocketAddress("2001:db8:85a3:8d3:1319:8a2e:370:7348", 443)));
     }