#1152 - Refactor EJson internals extracting io.ebean.service.SpiJsonService

src/main/java/io/ebean/XServiceProvider.java

@@ -1,6 +1,6 @@
 package io.ebean;
 
-import io.ebean.plugin.SpiRawSqlService;
+import io.ebean.service.SpiRawSqlService;
 
 import java.util.Iterator;
 import java.util.ServiceLoader;

src/main/java/io/ebean/service/SpiJsonService.java

@@ -0,0 +1,125 @@
+package io.ebean.service;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.core.JsonToken;
+
+import java.io.IOException;
+import java.io.Reader;
+import java.io.Writer;
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * JSON service that Ebean is expected to provide.
+ *
+ * Supports converting between JSON content and simple java Maps/Lists.
+ */
+public interface SpiJsonService {
+
+  /**
+   * Write the nested Map/List as json.
+   */
+  String write(Object object) throws IOException;
+
+  /**
+   * Write the nested Map/List as json to the writer.
+   */
+  void write(Object object, Writer writer) throws IOException;
+
+  /**
+   * Write the nested Map/List as json to the jsonGenerator.
+   */
+  void write(Object object, JsonGenerator jsonGenerator) throws IOException;
+
+  /**
+   * Write the collection as json array to the jsonGenerator.
+   */
+  void writeCollection(Collection<Object> collection, JsonGenerator jsonGenerator) throws IOException;
+
+  /**
+   * Parse the json and return as a Map additionally specifying if the returned map should
+   * be modify aware meaning that it can detect when it has been modified.
+   */
+  Map<String, Object> parseObject(String json, boolean modifyAware) throws IOException;
+
+  /**
+   * Parse the json and return as a Map.
+   */
+  Map<String, Object> parseObject(String json) throws IOException;
+
+  /**
+   * Parse the json and return as a Map taking a reader.
+   */
+  Map<String, Object> parseObject(Reader reader, boolean modifyAware) throws IOException;
+
+  /**
+   * Parse the json and return as a Map taking a reader.
+   */
+  Map<String, Object> parseObject(Reader reader) throws IOException;
+
+  /**
+   * Parse the json and return as a Map taking a JsonParser.
+   */
+  Map<String, Object> parseObject(JsonParser parser) throws IOException;
+
+  /**
+   * Parse the json and return as a Map taking a JsonParser and a starting token.
+   * <p>
+   * Used when the first token is checked to see if the value is null prior to calling this.
+   * </p>
+   */
+  Map<String, Object> parseObject(JsonParser parser, JsonToken token) throws IOException;
+
+  /**
+   * Parse the json and return as a modify aware List.
+   */
+  <T> List<T> parseList(String json, boolean modifyAware) throws IOException;
+
+  /**
+   * Parse the json and return as a List.
+   */
+  List<Object> parseList(String json) throws IOException;
+
+  /**
+   * Parse the json and return as a List taking a Reader.
+   */
+  List<Object> parseList(Reader reader) throws IOException;
+
+  /**
+   * Parse the json and return as a List taking a JsonParser.
+   */
+  List<Object> parseList(JsonParser parser) throws IOException;
+
+  /**
+   * Parse the json returning as a List taking into account the current token.
+   */
+  <T> List<T> parseList(JsonParser parser, JsonToken currentToken) throws IOException;
+
+  /**
+   * Parse the json and return as a List or Map.
+   */
+  Object parse(String json) throws IOException;
+
+  /**
+   * Parse the json and return as a List or Map.
+   */
+  Object parse(Reader reader) throws IOException;
+
+  /**
+   * Parse the json and return as a List or Map.
+   */
+  Object parse(JsonParser parser) throws IOException;
+
+  /**
+   * Parse the json returning a Set that might be modify aware.
+   */
+  <T> Set<T> parseSet(String json, boolean modifyAware) throws IOException;
+
+  /**
+   * Parse the json returning as a Set taking into account the current token.
+   */
+  <T> Set<T> parseSet(JsonParser parser, JsonToken currentToken) throws IOException;
+}

src/main/java/io/ebean/service/SpiRawSqlService.java

@@ -1,4 +1,4 @@
-package io.ebean.plugin;
+package io.ebean.service;
 
 import io.ebean.RawSql;
 import io.ebean.RawSqlBuilder;
@@ -6,7 +6,7 @@ import io.ebean.RawSqlBuilder;
 import java.sql.ResultSet;
 
 /**
- * Service provided for parsing and column mapping raw SQL queries.
+ * Service provided by Ebean for parsing and column mapping raw SQL queries.
  */
 public interface SpiRawSqlService {
 

src/main/java/io/ebean/text/json/EJson.java

@@ -1,17 +1,18 @@
 package io.ebean.text.json;
 
-import io.ebeaninternal.server.type.ModifyAwareList;
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.core.JsonToken;
+import io.ebean.service.SpiJsonService;
 
 import java.io.IOException;
 import java.io.Reader;
 import java.io.Writer;
 import java.util.Collection;
-import java.util.LinkedHashSet;
+import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
+import java.util.ServiceLoader;
 import java.util.Set;
 
 /**
@@ -19,32 +20,43 @@ import java.util.Set;
  */
 public class EJson {
 
+  private static SpiJsonService plugin = init();
+
+  private static SpiJsonService init() {
+
+    Iterator<SpiJsonService> loader = ServiceLoader.load(SpiJsonService.class).iterator();
+    if (loader.hasNext()) {
+      return loader.next();
+    }
+    throw new IllegalStateException("No service implementation found for SpiJsonService?");
+  }
+
   /**
    * Write the nested Map/List as json.
    */
   public static String write(Object object) throws IOException {
-    return EJsonWriter.write(object);
+    return plugin.write(object);
   }
 
   /**
    * Write the nested Map/List as json to the writer.
    */
   public static void write(Object object, Writer writer) throws IOException {
-    EJsonWriter.write(object, writer);
+    plugin.write(object, writer);
   }
 
   /**
    * Write the nested Map/List as json to the jsonGenerator.
    */
   public static void write(Object object, JsonGenerator jsonGenerator) throws IOException {
-    EJsonWriter.write(object, jsonGenerator);
+    plugin.write(object, jsonGenerator);
   }
 
   /**
    * Write the collection as json array to the jsonGenerator.
    */
   public static void writeCollection(Collection<Object> collection, JsonGenerator jsonGenerator) throws IOException {
-    EJsonWriter.writeCollection(collection, jsonGenerator);
+    plugin.writeCollection(collection, jsonGenerator);
   }
 
   /**
@@ -52,35 +64,35 @@ public class EJson {
    * be modify aware meaning that it can detect when it has been modified.
    */
   public static Map<String, Object> parseObject(String json, boolean modifyAware) throws IOException {
-    return EJsonReader.parseObject(json, modifyAware);
+    return plugin.parseObject(json, modifyAware);
   }
 
   /**
    * Parse the json and return as a Map.
    */
   public static Map<String, Object> parseObject(String json) throws IOException {
-    return EJsonReader.parseObject(json);
+    return plugin.parseObject(json);
   }
 
   /**
    * Parse the json and return as a Map taking a reader.
    */
   public static Map<String, Object> parseObject(Reader reader, boolean modifyAware) throws IOException {
-    return EJsonReader.parseObject(reader, modifyAware);
+    return plugin.parseObject(reader, modifyAware);
   }
 
   /**
    * Parse the json and return as a Map taking a reader.
    */
   public static Map<String, Object> parseObject(Reader reader) throws IOException {
-    return EJsonReader.parseObject(reader);
+    return plugin.parseObject(reader);
   }
 
   /**
    * Parse the json and return as a Map taking a JsonParser.
    */
   public static Map<String, Object> parseObject(JsonParser parser) throws IOException {
-    return EJsonReader.parseObject(parser);
+    return plugin.parseObject(parser);
   }
 
   /**
@@ -90,35 +102,35 @@ public class EJson {
    * </p>
    */
   public static Map<String, Object> parseObject(JsonParser parser, JsonToken token) throws IOException {
-    return EJsonReader.parseObject(parser, token);
+    return plugin.parseObject(parser, token);
   }
 
   /**
    * Parse the json and return as a modify aware List.
    */
   public static <T> List<T> parseList(String json, boolean modifyAware) throws IOException {
-    return EJsonReader.parseList(json, modifyAware);
+    return plugin.parseList(json, modifyAware);
   }
 
   /**
    * Parse the json and return as a List.
    */
   public static List<Object> parseList(String json) throws IOException {
-    return EJsonReader.parseList(json);
+    return plugin.parseList(json);
   }
 
   /**
    * Parse the json and return as a List taking a Reader.
    */
   public static List<Object> parseList(Reader reader) throws IOException {
-    return EJsonReader.parseList(reader);
+    return plugin.parseList(reader);
   }
 
   /**
    * Parse the json and return as a List taking a JsonParser.
    */
   public static List<Object> parseList(JsonParser parser) throws IOException {
-    return EJsonReader.parseList(parser, false);
+    return plugin.parseList(parser);
   }
 
   /**
@@ -126,50 +138,41 @@ public class EJson {
    */
   @SuppressWarnings("unchecked")
   public static <T> List<T> parseList(JsonParser parser, JsonToken currentToken) throws IOException {
-    return (List<T>) EJsonReader.parse(parser, currentToken, false);
+    return plugin.parseList(parser, currentToken);
   }
 
   /**
    * Parse the json and return as a List or Map.
    */
   public static Object parse(String json) throws IOException {
-    return EJsonReader.parse(json);
+    return plugin.parse(json);
   }
 
   /**
    * Parse the json and return as a List or Map.
    */
   public static Object parse(Reader reader) throws IOException {
-    return EJsonReader.parse(reader);
+    return plugin.parse(reader);
   }
 
   /**
    * Parse the json and return as a List or Map.
    */
   public static Object parse(JsonParser parser) throws IOException {
-    return EJsonReader.parse(parser);
+    return plugin.parse(parser);
   }
 
   /**
    * Parse the json returning a Set that might be modify aware.
    */
   public static <T> Set<T> parseSet(String json, boolean modifyAware) throws IOException {
-    List<T> list = parseList(json, modifyAware);
-    if (list == null) {
-      return null;
-    }
-
-    if (modifyAware) {
-      return ((ModifyAwareList<T>) list).asSet();
-    } else {
-      return new LinkedHashSet<T>(list);
-    }
+    return plugin.parseSet(json, modifyAware);
   }
 
   /**
    * Parse the json returning as a Set taking into account the current token.
    */
   public static <T> Set<T> parseSet(JsonParser parser, JsonToken currentToken) throws IOException {
-    return new LinkedHashSet<T>(parseList(parser, currentToken));
+    return plugin.parseSet(parser, currentToken);
   }
 }

src/main/java/io/ebeaninternal/json/DJsonService.java

@@ -0,0 +1,175 @@
+package io.ebeaninternal.json;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.core.JsonToken;
+import io.ebean.service.SpiJsonService;
+
+import java.io.IOException;
+import java.io.Reader;
+import java.io.Writer;
+import java.util.Collection;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * Utility that converts between JSON content and simple java Maps/Lists.
+ */
+public class DJsonService implements SpiJsonService {
+
+  /**
+   * Write the nested Map/List as json.
+   */
+  public String write(Object object) throws IOException {
+    return EJsonWriter.write(object);
+  }
+
+  /**
+   * Write the nested Map/List as json to the writer.
+   */
+  public void write(Object object, Writer writer) throws IOException {
+    EJsonWriter.write(object, writer);
+  }
+
+  /**
+   * Write the nested Map/List as json to the jsonGenerator.
+   */
+  public void write(Object object, JsonGenerator jsonGenerator) throws IOException {
+    EJsonWriter.write(object, jsonGenerator);
+  }
+
+  /**
+   * Write the collection as json array to the jsonGenerator.
+   */
+  public void writeCollection(Collection<Object> collection, JsonGenerator jsonGenerator) throws IOException {
+    EJsonWriter.writeCollection(collection, jsonGenerator);
+  }
+
+  /**
+   * Parse the json and return as a Map additionally specifying if the returned map should
+   * be modify aware meaning that it can detect when it has been modified.
+   */
+  public Map<String, Object> parseObject(String json, boolean modifyAware) throws IOException {
+    return EJsonReader.parseObject(json, modifyAware);
+  }
+
+  /**
+   * Parse the json and return as a Map.
+   */
+  public Map<String, Object> parseObject(String json) throws IOException {
+    return EJsonReader.parseObject(json);
+  }
+
+  /**
+   * Parse the json and return as a Map taking a reader.
+   */
+  public Map<String, Object> parseObject(Reader reader, boolean modifyAware) throws IOException {
+    return EJsonReader.parseObject(reader, modifyAware);
+  }
+
+  /**
+   * Parse the json and return as a Map taking a reader.
+   */
+  public Map<String, Object> parseObject(Reader reader) throws IOException {
+    return EJsonReader.parseObject(reader);
+  }
+
+  /**
+   * Parse the json and return as a Map taking a JsonParser.
+   */
+  public Map<String, Object> parseObject(JsonParser parser) throws IOException {
+    return EJsonReader.parseObject(parser);
+  }
+
+  /**
+   * Parse the json and return as a Map taking a JsonParser and a starting token.
+   * <p>
+   * Used when the first token is checked to see if the value is null prior to calling this.
+   * </p>
+   */
+  public Map<String, Object> parseObject(JsonParser parser, JsonToken token) throws IOException {
+    return EJsonReader.parseObject(parser, token);
+  }
+
+  /**
+   * Parse the json and return as a modify aware List.
+   */
+  public <T> List<T> parseList(String json, boolean modifyAware) throws IOException {
+    return EJsonReader.parseList(json, modifyAware);
+  }
+
+  /**
+   * Parse the json and return as a List.
+   */
+  public List<Object> parseList(String json) throws IOException {
+    return EJsonReader.parseList(json);
+  }
+
+  /**
+   * Parse the json and return as a List taking a Reader.
+   */
+  public List<Object> parseList(Reader reader) throws IOException {
+    return EJsonReader.parseList(reader);
+  }
+
+  /**
+   * Parse the json and return as a List taking a JsonParser.
+   */
+  public List<Object> parseList(JsonParser parser) throws IOException {
+    return EJsonReader.parseList(parser, false);
+  }
+
+  /**
+   * Parse the json returning as a List taking into account the current token.
+   */
+  @SuppressWarnings("unchecked")
+  public <T> List<T> parseList(JsonParser parser, JsonToken currentToken) throws IOException {
+    return (List<T>) EJsonReader.parse(parser, currentToken, false);
+  }
+
+  /**
+   * Parse the json and return as a List or Map.
+   */
+  public Object parse(String json) throws IOException {
+    return EJsonReader.parse(json);
+  }
+
+  /**
+   * Parse the json and return as a List or Map.
+   */
+  public Object parse(Reader reader) throws IOException {
+    return EJsonReader.parse(reader);
+  }
+
+  /**
+   * Parse the json and return as a List or Map.
+   */
+  public Object parse(JsonParser parser) throws IOException {
+    return EJsonReader.parse(parser);
+  }
+
+  /**
+   * Parse the json returning a Set that might be modify aware.
+   */
+  public <T> Set<T> parseSet(String json, boolean modifyAware) throws IOException {
+    List<T> list = parseList(json, modifyAware);
+    if (list == null) {
+      return null;
+    }
+
+    if (modifyAware) {
+      return ((ModifyAwareList<T>) list).asSet();
+    } else {
+      return new LinkedHashSet<T>(list);
+    }
+  }
+
+  /**
+   * Parse the json returning as a Set taking into account the current token.
+   */
+  public <T> Set<T> parseSet(JsonParser parser, JsonToken currentToken) throws IOException {
+    return new LinkedHashSet<>(parseList(parser, currentToken));
+  }
+}

src/main/java/io/ebeaninternal/json/EJsonReader.java

@@ -1,9 +1,5 @@
-package io.ebean.text.json;
+package io.ebeaninternal.json;
 
-import io.ebeaninternal.server.type.ModifyAwareFlag;
-import io.ebeaninternal.server.type.ModifyAwareList;
-import io.ebeaninternal.server.type.ModifyAwareMap;
-import io.ebeaninternal.server.type.ModifyAwareOwner;
 import com.fasterxml.jackson.core.JsonFactory;
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.core.JsonToken;

src/main/java/io/ebeaninternal/json/EJsonWriter.java

@@ -1,4 +1,4 @@
-package io.ebean.text.json;
+package io.ebeaninternal.json;
 
 import com.fasterxml.jackson.core.JsonFactory;
 import com.fasterxml.jackson.core.JsonGenerator;

src/main/java/io/ebeaninternal/json/ModifyAwareFlag.java

@@ -1,4 +1,4 @@
-package io.ebeaninternal.server.type;
+package io.ebeaninternal.json;
 
 /**
  * Detects when content has been modified and as such needs to be persisted (included in an update).

src/main/java/io/ebeaninternal/json/ModifyAwareIterator.java

@@ -1,4 +1,4 @@
-package io.ebeaninternal.server.type;
+package io.ebeaninternal.json;
 
 import java.util.Iterator;
 

src/main/java/io/ebeaninternal/json/ModifyAwareList.java

@@ -1,4 +1,4 @@
-package io.ebeaninternal.server.type;
+package io.ebeaninternal.json;
 
 import java.util.Collection;
 import java.util.Iterator;

src/main/java/io/ebeaninternal/json/ModifyAwareListIterator.java

@@ -1,4 +1,4 @@
-package io.ebeaninternal.server.type;
+package io.ebeaninternal.json;
 
 import java.util.ListIterator;
 

src/main/java/io/ebeaninternal/json/ModifyAwareMap.java

@@ -1,4 +1,4 @@
-package io.ebeaninternal.server.type;
+package io.ebeaninternal.json;
 
 import java.util.Collection;
 import java.util.LinkedHashSet;

src/main/java/io/ebeaninternal/json/ModifyAwareOwner.java

@@ -1,4 +1,4 @@
-package io.ebeaninternal.server.type;
+package io.ebeaninternal.json;
 
 import java.io.Serializable;
 

src/main/java/io/ebeaninternal/json/ModifyAwareSet.java

@@ -1,4 +1,4 @@
-package io.ebeaninternal.server.type;
+package io.ebeaninternal.json;
 
 import java.util.Collection;
 import java.util.Iterator;

src/main/java/io/ebeaninternal/server/rawsql/DRawSqlService.java

@@ -2,7 +2,7 @@ package io.ebeaninternal.server.rawsql;
 
 import io.ebean.RawSql;
 import io.ebean.RawSqlBuilder;
-import io.ebean.plugin.SpiRawSqlService;
+import io.ebean.service.SpiRawSqlService;
 
 import java.sql.ResultSet;
 

src/main/java/io/ebeaninternal/server/type/ScalarTypeArrayList.java

@@ -2,6 +2,7 @@ package io.ebeaninternal.server.type;
 
 
 import io.ebean.text.json.EJson;
+import io.ebeaninternal.json.ModifyAwareList;
 import io.ebeanservice.docstore.api.mapping.DocPropertyType;
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.JsonParser;

src/main/java/io/ebeaninternal/server/type/ScalarTypeArraySet.java

@@ -4,6 +4,7 @@ package io.ebeaninternal.server.type;
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.JsonParser;
 import io.ebean.text.json.EJson;
+import io.ebeaninternal.json.ModifyAwareSet;
 import io.ebeanservice.docstore.api.mapping.DocPropertyType;
 
 import javax.persistence.PersistenceException;

src/main/java/io/ebeaninternal/server/type/ScalarTypeJsonCollection.java

@@ -1,5 +1,6 @@
 package io.ebeaninternal.server.type;
 
+import io.ebeaninternal.json.ModifyAwareOwner;
 import io.ebeanservice.docstore.api.mapping.DocPropertyType;
 
 import java.io.DataInput;

src/main/java/io/ebeaninternal/server/type/ScalarTypeJsonMap.java

@@ -3,6 +3,7 @@ package io.ebeaninternal.server.type;
 import io.ebean.config.dbplatform.DbPlatformType;
 import io.ebean.text.TextException;
 import io.ebean.text.json.EJson;
+import io.ebeaninternal.json.ModifyAwareOwner;
 import io.ebeaninternal.util.EncodeUtil;
 import io.ebeanservice.docstore.api.mapping.DocPropertyType;
 import com.fasterxml.jackson.core.JsonGenerator;

src/main/java/io/ebeaninternal/server/type/ScalarTypeJsonObjectMapper.java

@@ -1,6 +1,10 @@
 package io.ebeaninternal.server.type;
 
 import io.ebean.config.dbplatform.DbPlatformType;
+import io.ebeaninternal.json.ModifyAwareList;
+import io.ebeaninternal.json.ModifyAwareMap;
+import io.ebeaninternal.json.ModifyAwareOwner;
+import io.ebeaninternal.json.ModifyAwareSet;
 import io.ebeanservice.docstore.api.mapping.DocPropertyType;
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.JsonParser;

src/main/java/io/ebeaninternal/server/type/ScalarTypePostgresHstore.java

@@ -3,6 +3,8 @@ package io.ebeaninternal.server.type;
 import io.ebean.config.dbplatform.DbPlatformType;
 import io.ebean.text.TextException;
 import io.ebean.text.json.EJson;
+import io.ebeaninternal.json.ModifyAwareMap;
+import io.ebeaninternal.json.ModifyAwareOwner;
 import io.ebeanservice.docstore.api.mapping.DocPropertyType;
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.JsonParser;