renamed ArangoDB.Builder.serializer to ArangoDB.Builder.serde

Author: rashtao

docker/start_db.sh

@@ -70,7 +70,7 @@ docker run -d \
     --auth.jwt-secret=/jwtSecret \
     --starter.address="${GW}" \
     --docker.image="${DOCKER_IMAGE}" \
-    --starter.local --starter.mode=${STARTER_MODE} --all.log.level=debug --all.log.output=+ --log.verbose
+    --starter.local --starter.mode=${STARTER_MODE} --all.log.level=debug --all.log.output=+ --log.verbose --all.server.descriptors-minimum=1024
 
 
 wait_server() {

driver/src/main/java/com/arangodb/ArangoDB.java

@@ -549,16 +549,24 @@ public Builder responseQueueTimeSamples(final Integer responseQueueTimeSamples)
         }
 
         /**
-         * Replace the built-in serializer/deserializer with the given one.
+         * Sets the serde for the user data.
+         * This is used to serialize and deserialize all the data payload such as:
+         * - documents, vertexes, edges
+         * - AQL bind vars
+         * - body payload of requests and responses in {@link ArangoDB#execute(Request, Class)}
          * <p>
-         * <br />
-         * <b>ATTENTION!:</b> Any registered custom serializer/deserializer or module will be ignored.
+         * However, note that the following types will always be serialized and deserialized using the internal serde:
+         * - {@link com.fasterxml.jackson.databind.JsonNode}
+         * - {@link com.arangodb.util.RawJson}
+         * - {@link com.arangodb.util.RawBytes}
+         * - {@link com.arangodb.entity.BaseDocument}
+         * - {@link com.arangodb.entity.BaseEdgeDocument}
          *
-         * @param serialization custom serializer/deserializer
+         * @param serde custom serde for the user data
          * @return {@link ArangoDB.Builder}
          */
-        public Builder serializer(final ArangoSerde serialization) {
-            setSerializer(serialization);
+        public Builder serde(final ArangoSerde serde) {
+            setUserDataSerde(serde);
             return this;
         }
 
@@ -572,7 +580,7 @@ public ArangoDB build() {
                 throw new ArangoDBException("No host has been set!");
             }
 
-            final ArangoSerde userSerde = customSerializer != null ? customSerializer :
+            final ArangoSerde userSerde = this.userDataSerde != null ? this.userDataSerde :
                     JacksonSerde.of(ContentType.of(protocol));
             final InternalSerde serde = InternalSerde.of(ContentType.of(protocol), userSerde);
 

driver/src/main/java/com/arangodb/async/ArangoDBAsync.java

@@ -502,7 +502,7 @@ public Builder loadBalancingStrategy(final LoadBalancingStrategy loadBalancingSt
          * @return {@link ArangoDBAsync.Builder}
          */
         public Builder serializer(final ArangoSerde serialization) {
-            setSerializer(serialization);
+            setUserDataSerde(serialization);
             return this;
         }
 
@@ -516,7 +516,7 @@ public ArangoDBAsync build() {
                 throw new ArangoDBException("No host has been set!");
             }
 
-            final ArangoSerde userSerde = customSerializer != null ? customSerializer : JacksonSerde.of(ContentType.VPACK);
+            final ArangoSerde userSerde = this.userDataSerde != null ? this.userDataSerde : JacksonSerde.of(ContentType.VPACK);
             final InternalSerde serde = InternalSerde.of(ContentType.VPACK, userSerde);
 
             final int max = maxConnections != null ? Math.max(1, maxConnections)

driver/src/main/java/com/arangodb/internal/InternalArangoDBBuilder.java

@@ -58,7 +58,7 @@ public abstract class InternalArangoDBBuilder {
     protected Boolean acquireHostList = ArangoDefaults.DEFAULT_ACQUIRE_HOST_LIST;
     protected Integer acquireHostListInterval = ArangoDefaults.DEFAULT_ACQUIRE_HOST_LIST_INTERVAL;
     protected LoadBalancingStrategy loadBalancingStrategy = ArangoDefaults.DEFAULT_LOAD_BALANCING_STRATEGY;
-    protected ArangoSerde customSerializer;
+    protected ArangoSerde userDataSerde;
     protected Integer responseQueueTimeSamples = ArangoDefaults.DEFAULT_RESPONSE_QUEUE_TIME_SAMPLES;
 
     private static void loadHosts(final ConfigPropertiesProvider properties, final Collection<HostDescription> hosts) {
@@ -226,8 +226,8 @@ protected void setResponseQueueTimeSamples(final Integer responseQueueTimeSample
         this.responseQueueTimeSamples = responseQueueTimeSamples;
     }
 
-    protected void setSerializer(final ArangoSerde serializer) {
-        this.customSerializer = serializer;
+    protected void setUserDataSerde(final ArangoSerde serde) {
+        this.userDataSerde = serde;
     }
 
     protected HostHandler createHostHandler(final HostResolver hostResolver) {

driver/src/test/java/com/arangodb/BaseJunit5.java

@@ -25,7 +25,7 @@ class BaseJunit5 {
             new ArangoDB.Builder().loadProperties(new FileConfigPropertiesProvider()).useProtocol(Protocol.HTTP_JSON).build(),
             new ArangoDB.Builder().loadProperties(new FileConfigPropertiesProvider()).useProtocol(Protocol.HTTP2_VPACK).build(),
             new ArangoDB.Builder().loadProperties(new FileConfigPropertiesProvider()).useProtocol(Protocol.HTTP2_JSON).build(),
-            new ArangoDB.Builder().loadProperties(new FileConfigPropertiesProvider()).useProtocol(Protocol.HTTP2_JSON).serializer(JsonbSerde.create()).build()
+            new ArangoDB.Builder().loadProperties(new FileConfigPropertiesProvider()).useProtocol(Protocol.HTTP2_JSON).serde(JsonbSerde.create()).build()
     );
 
     protected static Stream<ArangoDatabase> dbsStream() {

driver/src/test/java/com/arangodb/serde/CustomSerdeTest.java

@@ -72,7 +72,7 @@ static void init() {
         arangoDB = new ArangoDB.Builder()
                 .loadProperties(new FileConfigPropertiesProvider())
                 .useProtocol(Protocol.VST)
-                .serializer(serde).build();
+                .serde(serde).build();
 
         db = arangoDB.db(DbName.of("custom-serde-test"));
         if (!db.exists()) {