ChangeLog

@@ -1,3 +1,9 @@
+v4.5.2 (2018-06-25)
+---------------------------
+* added support for custom serializer
+  * added ArangoDB.Builder.serializer(ArangoSerialization)
+  * added link to jackson-dataformat-velocypack in docs
+
 v4.5.1 (2018-06-21)
 ---------------------------
 * fixed exists() method in ArangoDatabase, ArangoCollection, ArangoGraph: check for ArangoDB error num

docs/Drivers/Java/Reference/Serialization.md

@@ -75,6 +75,13 @@ Added support for:
 ArangoDB arangoDB = new ArangoDB.Builder().registerModule(new VPackJodaModule()).build();
 ```
 
+## Use of jackson as an alternative serializer
+
+Since version 4.5.2, the driver supports alternative serializer to de-/serialize documents, edges and query results. One implementation is [VelocyJack](https://github.com/arangodb/jackson-dataformat-velocypack#usage-within-arangodb-java-driver) which is based on [Jackson](https://github.com/FasterXML/jackson) working with [jackson-dataformat-velocypack](https://github.com/arangodb/jackson-dataformat-velocypack).
+
+
+**Note**: Any registered custom [serializer/deserializer or module](#custom-serialization) will be ignored.
+
 ## custom serialization
 
 ```Java

pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>com.arangodb</groupId>
 	<artifactId>arangodb-java-driver</artifactId>
-	<version>4.5.1</version>
+	<version>4.5.2</version>
 	<inceptionYear>2016</inceptionYear>
 	<packaging>jar</packaging>
 
@@ -23,11 +23,16 @@
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<slf4j-api.version>1.7.13</slf4j-api.version>
+		<arangodb.velocypack.version>1.2.0</arangodb.velocypack.version>
+
+		<!-- provided -->
+		<httpclient.version>4.5.1</httpclient.version>
+
+		<!-- test -->		
 		<logback-classic.version>1.1.3</logback-classic.version>
 		<hamcrest-all.version>1.3</hamcrest-all.version>
 		<junit.version>4.12</junit.version>
-		<httpclient.version>4.5.1</httpclient.version>
-		<arangodb.velocypack.version>1.2.0</arangodb.velocypack.version>
+		<arangodb.velocypack.jackson.version>0.1.1</arangodb.velocypack.jackson.version>
 	</properties>
 
 	<developers>
@@ -117,6 +122,19 @@
 					<target>1.6</target>
 					<compilerArgument></compilerArgument>
 				</configuration>
+				<executions>
+					<execution>
+						<id>test-compile</id>
+						<phase>process-test-sources</phase>
+						<goals>
+							<goal>testCompile</goal>
+						</goals>
+						<configuration>
+							<source>1.6</source>
+							<target>1.7</target>
+						</configuration>
+					</execution>
+				</executions>
 			</plugin>
 
 			<plugin>
@@ -213,6 +231,11 @@
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-api</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>com.arangodb</groupId>
+			<artifactId>jackson-dataformat-velocypack</artifactId>
+			<scope>test</scope>
+		</dependency>
 		<dependency>
 			<groupId>ch.qos.logback</groupId>
 			<artifactId>logback-classic</artifactId>
@@ -247,6 +270,11 @@
 				<artifactId>slf4j-api</artifactId>
 				<version>${slf4j-api.version}</version>
 			</dependency>
+			<dependency>
+				<groupId>com.arangodb</groupId>
+				<artifactId>jackson-dataformat-velocypack</artifactId>
+				<version>${arangodb.velocypack.jackson.version}</version>
+			</dependency>
 			<dependency>
 				<groupId>ch.qos.logback</groupId>
 				<artifactId>logback-classic</artifactId>

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

@@ -43,8 +43,10 @@
 import com.arangodb.internal.net.HostHandler;
 import com.arangodb.internal.net.HostResolver;
 import com.arangodb.internal.util.ArangoDeserializerImpl;
+import com.arangodb.internal.util.ArangoSerializationFactory;
+import com.arangodb.internal.util.ArangoSerializationFactory.Serializer;
 import com.arangodb.internal.util.ArangoSerializerImpl;
-import com.arangodb.internal.util.ArangoUtilImpl;
+import com.arangodb.internal.util.DefaultArangoSerialization;
 import com.arangodb.internal.velocypack.VPackDocumentModule;
 import com.arangodb.internal.velocystream.VstCommunicationSync;
 import com.arangodb.model.LogOptions;
@@ -276,8 +278,10 @@ public Builder registerJsonModules(final VPackParserModule... module) {
 		 * 
 		 * @param serializer
 		 *            custom serializer
+		 * @deprecated use {@link #serializer(ArangoSerialization)} instead
 		 * @return builder
 		 */
+		@Deprecated
 		public Builder setSerializer(final ArangoSerializer serializer) {
 			serializer(serializer);
 			return this;
@@ -291,13 +295,30 @@ public Builder setSerializer(final ArangoSerializer serializer) {
 		 * 
 		 * @param deserializer
 		 *            custom deserializer
+		 * @deprecated use {@link #serializer(ArangoSerialization)} instead
 		 * @return builder
 		 */
+		@Deprecated
 		public Builder setDeserializer(final ArangoDeserializer deserializer) {
 			deserializer(deserializer);
 			return this;
 		}
 
+		/**
+		 * Replace the built-in serializer/deserializer with the given one.
+		 * 
+		 * <br />
+		 * <b>ATTENTION!:</b> Any registered custom serializer/deserializer or module will be ignored.
+		 * 
+		 * @param serialization
+		 *            custom serializer/deserializer
+		 * @return builder
+		 */
+		public Builder serializer(final ArangoSerialization serialization) {
+			setSerializer(serialization);
+			return this;
+		}
+
 		public synchronized ArangoDB build() {
 			if (hosts.isEmpty()) {
 				hosts.add(host);
@@ -313,6 +334,10 @@ public synchronized ArangoDB build() {
 					: new ArangoSerializerImpl(vpacker, vpackerNull, vpackParser);
 			final ArangoDeserializer deserializerTemp = deserializer != null ? deserializer
 					: new ArangoDeserializerImpl(vpackerNull, vpackParser);
+			final DefaultArangoSerialization internal = new DefaultArangoSerialization(serializerTemp,
+					deserializerTemp);
+			final ArangoSerialization custom = customSerializer != null ? customSerializer : internal;
+			final ArangoSerializationFactory util = new ArangoSerializationFactory(internal, custom);
 
 			final HostResolver hostResolver = createHostResolver();
 			final HostHandler hostHandler = createHostHandler(hostResolver);
@@ -323,7 +348,7 @@ public synchronized ArangoDB build() {
 					new HttpCommunication.Builder(hostHandler, protocol).timeout(timeout).user(user).password(password)
 							.useSsl(useSsl).sslContext(sslContext).maxConnections(maxConnections)
 							.connectionTtl(connectionTtl),
-					new ArangoUtilImpl(serializerTemp, deserializerTemp), collectionCache, protocol, hostResolver);
+					util, collectionCache, protocol, hostResolver);
 		}
 
 	}
@@ -591,4 +616,7 @@ UserEntity createUser(final String user, final String passwd, final UserCreateOp
 	ArangoDB _setCursorInitializer(final ArangoCursorInitializer cursorInitializer);
 
 	ArangoSerialization util();
+
+	ArangoSerialization util(Serializer serializer);
+
 }

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

@@ -1,84 +1,85 @@
-/*
- * DISCLAIMER
- *
- * Copyright 2016 ArangoDB GmbH, Cologne, Germany
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * Copyright holder is ArangoDB GmbH, Cologne, Germany
- */
-
-package com.arangodb.internal;
-
-import java.util.Iterator;
-import java.util.NoSuchElementException;
-
-import com.arangodb.ArangoCursor;
-import com.arangodb.entity.CursorEntity;
-import com.arangodb.velocypack.VPackSlice;
-
-/**
- * @author Mark Vollmary
- * @param <T>
- *
- */
-public class ArangoCursorIterator<T> implements Iterator<T> {
-
-	private CursorEntity result;
-	private int pos;
-
-	private final ArangoCursor<T> cursor;
-	private final InternalArangoDatabase<?, ?, ?, ?> db;
-	private final ArangoCursorExecute execute;
-
-	public ArangoCursorIterator(final ArangoCursor<T> cursor, final ArangoCursorExecute execute,
-		final InternalArangoDatabase<?, ?, ?, ?> db, final CursorEntity result) {
-		super();
-		this.cursor = cursor;
-		this.execute = execute;
-		this.db = db;
-		this.result = result;
-		pos = 0;
-	}
-
-	public CursorEntity getResult() {
-		return result;
-	}
-
-	@Override
-	public boolean hasNext() {
-		return pos < result.getResult().size() || result.getHasMore();
-	}
-
-	@Override
-	public T next() {
-		if (pos >= result.getResult().size() && result.getHasMore()) {
-			result = execute.next(cursor.getId());
-			pos = 0;
-		}
-		if (!hasNext()) {
-			throw new NoSuchElementException();
-		}
-		return deserialize(result.getResult().get(pos++), cursor.getType());
-	}
-
-	protected <R> R deserialize(final VPackSlice result, final Class<R> type) {
-		return db.util().deserialize(result, type);
-	}
-
-	@Override
-	public void remove() {
-		throw new UnsupportedOperationException();
-	}
-
-}
+/*
+ * DISCLAIMER
+ *
+ * Copyright 2016 ArangoDB GmbH, Cologne, Germany
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Copyright holder is ArangoDB GmbH, Cologne, Germany
+ */
+
+package com.arangodb.internal;
+
+import java.util.Iterator;
+import java.util.NoSuchElementException;
+
+import com.arangodb.ArangoCursor;
+import com.arangodb.entity.CursorEntity;
+import com.arangodb.internal.util.ArangoSerializationFactory.Serializer;
+import com.arangodb.velocypack.VPackSlice;
+
+/**
+ * @author Mark Vollmary
+ * @param <T>
+ *
+ */
+public class ArangoCursorIterator<T> implements Iterator<T> {
+
+	private CursorEntity result;
+	private int pos;
+
+	private final ArangoCursor<T> cursor;
+	private final InternalArangoDatabase<?, ?, ?, ?> db;
+	private final ArangoCursorExecute execute;
+
+	public ArangoCursorIterator(final ArangoCursor<T> cursor, final ArangoCursorExecute execute,
+		final InternalArangoDatabase<?, ?, ?, ?> db, final CursorEntity result) {
+		super();
+		this.cursor = cursor;
+		this.execute = execute;
+		this.db = db;
+		this.result = result;
+		pos = 0;
+	}
+
+	public CursorEntity getResult() {
+		return result;
+	}
+
+	@Override
+	public boolean hasNext() {
+		return pos < result.getResult().size() || result.getHasMore();
+	}
+
+	@Override
+	public T next() {
+		if (pos >= result.getResult().size() && result.getHasMore()) {
+			result = execute.next(cursor.getId());
+			pos = 0;
+		}
+		if (!hasNext()) {
+			throw new NoSuchElementException();
+		}
+		return deserialize(result.getResult().get(pos++), cursor.getType());
+	}
+
+	protected <R> R deserialize(final VPackSlice result, final Class<R> type) {
+		return db.util(Serializer.CUSTOM).deserialize(result, type);
+	}
+
+	@Override
+	public void remove() {
+		throw new UnsupportedOperationException();
+	}
+
+}

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

@@ -44,6 +44,8 @@
 import com.arangodb.internal.net.HostHandle;
 import com.arangodb.internal.net.HostResolver;
 import com.arangodb.internal.net.HostResolver.EndpointResolver;
+import com.arangodb.internal.util.ArangoSerializationFactory;
+import com.arangodb.internal.util.ArangoSerializationFactory.Serializer;
 import com.arangodb.internal.velocystream.VstCommunicationSync;
 import com.arangodb.internal.velocystream.VstProtocol;
 import com.arangodb.internal.velocystream.internal.ConnectionSync;
@@ -68,12 +70,14 @@ public class ArangoDBImpl extends InternalArangoDB<ArangoExecutorSync, Response,
 	private CommunicationProtocol cp;
 
 	public ArangoDBImpl(final VstCommunicationSync.Builder vstBuilder, final HttpCommunication.Builder httpBuilder,
-		final ArangoSerialization util, final CollectionCache collectionCache, final Protocol protocol,
+		final ArangoSerializationFactory util, final CollectionCache collectionCache, final Protocol protocol,
 		final HostResolver hostResolver) {
-		super(new ArangoExecutorSync(createProtocol(vstBuilder, httpBuilder, util, collectionCache, protocol), util,
+		super(new ArangoExecutorSync(
+				createProtocol(vstBuilder, httpBuilder, util.get(Serializer.INTERNAL), collectionCache, protocol), util,
 				new DocumentCache()), util);
 		cp = createProtocol(new VstCommunicationSync.Builder(vstBuilder).maxConnections(1),
-			new HttpCommunication.Builder(httpBuilder).maxConnections(1), util, collectionCache, protocol);
+			new HttpCommunication.Builder(httpBuilder).maxConnections(1), util.get(Serializer.INTERNAL),
+			collectionCache, protocol);
 		collectionCache.init(new DBAccess() {
 			@Override
 			public ArangoDatabase db(final String name) {
@@ -292,4 +296,5 @@ public ArangoDBImpl _setCursorInitializer(final ArangoCursorInitializer cursorIn
 		this.cursorInitializer = cursorInitializer;
 		return this;
 	}
+
 }