@userdata and @UserDataInside annotations

src/main/java/com/arangodb/entity/DocumentCreateEntity.java

@@ -20,6 +20,8 @@
 
 package com.arangodb.entity;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
+
 /**
  * @author Mark Vollmary
  * @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#create-document">API
@@ -41,6 +43,7 @@ public T getNew() {
  return newDocument;
  }
 
+ @JsonIgnore
  public void setNew(final T newDocument) {
  this.newDocument = newDocument;
  }
@@ -53,6 +56,7 @@ public T getOld() {
  return oldDocument;
  }
 
+ @JsonIgnore
  public void setOld(final T oldDocument) {
  this.oldDocument = oldDocument;
  }

src/main/java/com/arangodb/entity/DocumentDeleteEntity.java

@@ -20,6 +20,8 @@
 
 package com.arangodb.entity;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
+
 /**
  * @author Mark Vollmary
  * @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#removes-a-document">API
@@ -41,6 +43,7 @@ public T getOld() {
  return oldDocument;
  }
 
+ @JsonIgnore
  public void setOld(final T oldDocument) {
  this.oldDocument = oldDocument;
  }

src/main/java/com/arangodb/entity/DocumentUpdateEntity.java

@@ -20,6 +20,7 @@
 
 package com.arangodb.entity;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 /**
@@ -50,6 +51,7 @@ public T getNew() {
  return newDocument;
  }
 
+ @JsonIgnore
  public void setNew(final T newDocument) {
  this.newDocument = newDocument;
  }
@@ -62,6 +64,7 @@ public T getOld() {
  return oldDocument;
  }
 
+ @JsonIgnore
  public void setOld(final T oldDocument) {
  this.oldDocument = oldDocument;
  }

src/main/java/com/arangodb/internal/InternalArangoCollection.java

@@ -126,10 +126,7 @@ protected <T> Request insertDocumentsRequest(final Collection<T> values, final D
  request.putQueryParam(OVERWRITE_MODE, params.getOverwriteMode() != null ? params.getOverwriteMode().getValue() : null);
  request.putQueryParam(MERGE_OBJECTS, params.getMergeObjects());
  request.putHeaderParam(TRANSACTION_ID, params.getStreamTransactionId());
-
- byte[] body = isStringCollection(values) ? getSerde().serialize(stringCollectionToJsonArray((Collection<String>) values))
- : getSerde().serializeUserData(values);
- request.setBody(body);
+ request.setBody(getSerde().serializeCollectionUserData(values));
  return request;
  }
 
@@ -181,9 +178,8 @@ protected Request importDocumentsRequest(final String values, final DocumentImpo
  }
 
  protected Request importDocumentsRequest(final Collection<?> values, final DocumentImportOptions options) {
- byte[] body = isStringCollection(values) ? getSerde().serialize(stringCollectionToJsonArray((Collection<String>) values))
- : getSerde().serializeUserData(values);
- return importDocumentsRequest(options).putQueryParam("type", ImportType.list).setBody(body);
+ return importDocumentsRequest(options).putQueryParam("type", ImportType.list)
+ .setBody(getSerde().serializeCollectionUserData(values));
  }
 
  protected Request importDocumentsRequest(final DocumentImportOptions options) {
@@ -301,10 +297,7 @@ protected <T> Request replaceDocumentsRequest(final Collection<T> values, final
  request.putQueryParam(RETURN_NEW, params.getReturnNew());
  request.putQueryParam(RETURN_OLD, params.getReturnOld());
  request.putQueryParam(SILENT, params.getSilent());
-
- byte[] body = isStringCollection(values) ? getSerde().serialize(stringCollectionToJsonArray((Collection<String>) values))
- : getSerde().serializeUserData(values);
- request.setBody(body);
+ request.setBody(getSerde().serializeCollectionUserData(values));
  return request;
  }
 
@@ -402,10 +395,7 @@ protected <T> Request updateDocumentsRequest(final Collection<T> values, final D
  request.putQueryParam(RETURN_NEW, params.getReturnNew());
  request.putQueryParam(RETURN_OLD, params.getReturnOld());
  request.putQueryParam(SILENT, params.getSilent());
-
- byte[] body = isStringCollection(values) ? getSerde().serialize(stringCollectionToJsonArray((Collection<String>) values))
- : getSerde().serializeUserData(values);
- request.setBody(body);
+ request.setBody(getSerde().serializeCollectionUserData(values));
  return request;
  }
 
@@ -686,12 +676,4 @@ protected ResponseDeserializer<Permissions> getPermissionsResponseDeserialzer()
  return response -> getSerde().deserialize(response.getBody(), ArangoResponseField.RESULT_JSON_POINTER, Permissions.class);
  }
 
- private boolean isStringCollection(final Collection<?> values) {
- return values.stream().allMatch(String.class::isInstance);
- }
-
- private JsonNode stringCollectionToJsonArray(final Collection<String> values) {
- return SerdeUtils.INSTANCE.parseJson("[" + String.join(",", values) + "]");
- }
-
 }

src/main/java/com/arangodb/internal/InternalArangoDatabase.java

@@ -144,8 +144,8 @@ protected ResponseDeserializer<Permissions> getPermissionsResponseDeserialzer()
 
  protected Request queryRequest(final String query, final Map<String, Object> bindVars, final AqlQueryOptions options) {
  final AqlQueryOptions opt = options != null ? options : new AqlQueryOptions();
- final Request request = request(dbName, RequestType.POST, PATH_API_CURSOR).setBody(getSerde().serialize(
- OptionsBuilder.build(opt, query, bindVars != null ? getSerde().serializeUserData(bindVars) : null)));
+ final Request request = request(dbName, RequestType.POST, PATH_API_CURSOR)
+ .setBody(getSerde().serialize(OptionsBuilder.build(opt, query, bindVars)));
  if (opt.getAllowDirtyRead() == Boolean.TRUE) {
  RequestUtils.allowDirtyRead(request);
  }
@@ -190,8 +190,7 @@ protected Request queryCloseRequest(final String id, final AqlQueryOptions optio
  protected Request explainQueryRequest(final String query, final Map<String, Object> bindVars, final AqlQueryExplainOptions options) {
  final AqlQueryExplainOptions opt = options != null ? options : new AqlQueryExplainOptions();
  return request(dbName, RequestType.POST, PATH_API_EXPLAIN)
- .setBody(getSerde().serialize(
- OptionsBuilder.build(opt, query, bindVars != null ? getSerde().serializeUserData(bindVars) : null)));
+ .setBody(getSerde().serialize(OptionsBuilder.build(opt, query, bindVars)));
  }
 
  protected Request parseQueryRequest(final String query) {

src/main/java/com/arangodb/model/AqlQueryExplainOptions.java

@@ -20,10 +20,10 @@
 
 package com.arangodb.model;
 
-import com.arangodb.serde.InternalSerializers;
-import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.arangodb.serde.UserDataInside;
 
 import java.util.Collection;
+import java.util.Map;
 
 /**
  * @author Mark Vollmary
@@ -32,24 +32,24 @@
  */
 public final class AqlQueryExplainOptions {
 
- private byte[] bindVars;
+ private Map<String, Object> bindVars;
  private String query;
  private Options options;
 
  public AqlQueryExplainOptions() {
  super();
  }
 
- @JsonSerialize(using = InternalSerializers.AqlBindVarsSerializer.class)
- public byte[] getBindVars() {
+ @UserDataInside
+ public Map<String, Object> getBindVars() {
  return bindVars;
  }
 
  /**
  * @param bindVars key/value pairs representing the bind parameters
  * @return options
  */
- AqlQueryExplainOptions bindVars(final byte[] bindVars) {
+ AqlQueryExplainOptions bindVars(final Map<String, Object> bindVars) {
  this.bindVars = bindVars;
  return this;
  }

src/main/java/com/arangodb/model/AqlQueryOptions.java

@@ -20,12 +20,12 @@
 
 package com.arangodb.model;
 
-import com.arangodb.serde.InternalSerializers;
-import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.arangodb.serde.UserDataInside;
 
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Map;
 
 /**
  * @author Mark Vollmary
@@ -40,7 +40,7 @@ public final class AqlQueryOptions {
  private Integer batchSize;
  private Boolean cache;
  private Long memoryLimit;
- private byte[] bindVars;
+ private Map<String, Object> bindVars;
  private String query;
  private Options options;
  private Boolean allowDirtyRead;
@@ -147,16 +147,16 @@ public AqlQueryOptions fillBlockCache(final Boolean fillBlockCache) {
  return this;
  }
 
- @JsonSerialize(using = InternalSerializers.AqlBindVarsSerializer.class)
- public byte[] getBindVars() {
+ @UserDataInside
+ public Map<String, Object> getBindVars() {
  return bindVars;
  }
 
  /**
  * @param bindVarsBytes serialized bind parameters
  * @return options
  */
- AqlQueryOptions bindVars(final byte[] bindVarsBytes) {
+ AqlQueryOptions bindVars(final Map<String, Object> bindVarsBytes) {
  this.bindVars = bindVarsBytes;
  return this;
  }

src/main/java/com/arangodb/model/OptionsBuilder.java

@@ -25,6 +25,7 @@
 import com.arangodb.entity.ViewType;
 
 import java.util.Collection;
+import java.util.Map;
 
 /**
  * @author Mark Vollmary
@@ -82,14 +83,14 @@ public static CollectionCreateOptions build(final CollectionCreateOptions option
  return options.name(name);
  }
 
- public static AqlQueryOptions build(final AqlQueryOptions options, final String query, final byte[] bindVars) {
+ public static AqlQueryOptions build(final AqlQueryOptions options, final String query, final Map<String, Object> bindVars) {
  return options.query(query).bindVars(bindVars);
  }
 
  public static AqlQueryExplainOptions build(
  final AqlQueryExplainOptions options,
  final String query,
- final byte[] bindVars) {
+ final Map<String, Object> bindVars) {
  return options.query(query).bindVars(bindVars);
  }
 

src/main/java/com/arangodb/serde/InternalAnnotationIntrospector.java

@@ -0,0 +1,32 @@
+package com.arangodb.serde;
+
+import com.fasterxml.jackson.databind.introspect.Annotated;
+import com.fasterxml.jackson.databind.introspect.JacksonAnnotationIntrospector;
+
+class InternalAnnotationIntrospector extends JacksonAnnotationIntrospector {
+
+ private final UserDataSerializer userDataSerializer;
+
+ InternalAnnotationIntrospector(final UserDataSerializer userDataSerializer) {
+ this.userDataSerializer = userDataSerializer;
+ }
+
+ @Override
+ public Object findSerializer(Annotated a) {
+ if (a.getAnnotation(UserData.class) != null) {
+ return userDataSerializer;
+ } else {
+ return super.findSerializer(a);
+ }
+ }
+
+ @Override
+ public Object findContentSerializer(Annotated a) {
+ if (a.getAnnotation(UserDataInside.class) != null) {
+ return userDataSerializer;
+ } else {
+ return super.findContentSerializer(a);
+ }
+ }
+
+}

src/main/java/com/arangodb/serde/InternalSerde.java

@@ -5,6 +5,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 import java.lang.reflect.Type;
+import java.util.Collection;
 
 public interface InternalSerde extends JacksonSerde {
 
@@ -113,6 +114,14 @@ default <T> T deserialize(byte[] content, String jsonPointer, Type type) {
  */
  byte[] serializeUserData(Object value);
 
+ /**
+ * Serializes each element in the collection using the user serde.
+ *
+ * @param value objects to serialize
+ * @return serialized byte array
+ */
+ byte[] serializeCollectionUserData(Collection<?> value);
+
  /**
  * Deserializes the content and binds it to the target data type, using the user serde.
  *

src/main/java/com/arangodb/serde/InternalSerdeImpl.java

@@ -9,6 +9,9 @@
 
 import java.io.IOException;
 import java.lang.reflect.Type;
+import java.util.Collection;
+import java.util.List;
+import java.util.stream.Collectors;
 
 final class InternalSerdeImpl extends JacksonSerdeImpl implements InternalSerde {
 
@@ -19,6 +22,7 @@ final class InternalSerdeImpl extends JacksonSerdeImpl implements InternalSerde
  this.userSerde = userSerde;
  mapper.registerModule(InternalModule.INSTANCE.get());
  mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+ mapper.setAnnotationIntrospector(new InternalAnnotationIntrospector(new UserDataSerializer(this)));
  }
 
  @Override
@@ -60,13 +64,22 @@ public JsonNode parse(byte[] content, String jsonPointer) {
 
  @Override
  public byte[] serializeUserData(Object value) {
- if (RawJson.class.equals(value.getClass()) || RawBytes.class.equals(value.getClass())) {
+ if (value != null && (RawJson.class.equals(value.getClass()) || RawBytes.class.equals(value.getClass()))) {
  return serialize(value);
  } else {
  return userSerde.serialize(value);
  }
  }
 
+ @Override
+ public byte[] serializeCollectionUserData(Collection<?> value) {
+ List<JsonNode> jsonNodeCollection = value.stream()
+ .map(this::serializeUserData)
+ .map(this::parse)
+ .collect(Collectors.toList());
+ return serialize(jsonNodeCollection);
+ }
+
  @Override
  public <T> T deserializeUserData(byte[] content, Type type) {
  if (RawJson.class.equals(type) || RawBytes.class.equals(type)) {

src/main/java/com/arangodb/serde/InternalSerializers.java

@@ -20,17 +20,6 @@
 
 public final class InternalSerializers {
 
- public static class AqlBindVarsSerializer extends JsonSerializer<byte[]> {
- @Override
- public void serialize(byte[] value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
- // TODO: find a way to append raw bytes directly
- // see https://github.com/FasterXML/jackson-dataformats-binary/issues/331
- try (JsonParser parser = gen.getCodec().getFactory().createParser(value)) {
- gen.writeTree(parser.readValueAsTree());
- }
- }
- }
-
  public static class CollectionSchemaRuleSerializer extends JsonSerializer<String> {
  @Override
  public void serialize(String value, JsonGenerator gen, SerializerProvider serializers) throws IOException {

src/main/java/com/arangodb/serde/UserData.java

@@ -0,0 +1,14 @@
+package com.arangodb.serde;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Marker annotation for fields that need to be serialized/deserialized using the user serde.
+ */
+@Target({ElementType.METHOD, ElementType.FIELD})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface UserData {
+}