DATAMONGO-1176 - Switch to Document API.

We use the Document API when interacting with the MongoDB Java Driver. This allows us to make use of new features and enables us to use the Codec API and prepares the project for future enhancements concerning the drivers the reactive API.

Author: christophstrobl

pom.xml

@@ -29,7 +29,7 @@
 		<project.type>multi</project.type>
 		<dist.id>spring-data-mongodb</dist.id>
 		<springdata.commons>2.0.0.BUILD-SNAPSHOT</springdata.commons>
-		<mongo>2.14.0</mongo>
+		<mongo>3.2.2</mongo>
 	</properties>
 
 	<developers>

spring-data-mongodb-cross-store/src/main/java/org/springframework/data/mongodb/crossstore/MongoChangeSetPersister.java

@@ -17,6 +17,7 @@
 
 import javax.persistence.EntityManagerFactory;
 
+import org.bson.Document;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.dao.DataAccessException;
@@ -29,10 +30,10 @@
 import org.springframework.data.mongodb.core.MongoTemplate;
 import org.springframework.util.ClassUtils;
 
-import com.mongodb.BasicDBObject;
-import com.mongodb.DBCollection;
-import com.mongodb.DBObject;
 import com.mongodb.MongoException;
+import com.mongodb.client.MongoCollection;
+import com.mongodb.client.model.Filters;
+import com.mongodb.client.result.DeleteResult;
 
 /**
  * @author Thomas Risberg
@@ -74,15 +75,15 @@ public void getPersistentState(Class<? extends ChangeSetBacked> entityClass, Obj
 
 		String collName = getCollectionNameForEntity(entityClass);
 
-		final DBObject dbk = new BasicDBObject();
+		final Document dbk = new Document();
 		dbk.put(ENTITY_ID, id);
 		dbk.put(ENTITY_CLASS, entityClass.getName());
 		if (log.isDebugEnabled()) {
 			log.debug("Loading MongoDB data for {}", dbk);
 		}
 		mongoTemplate.execute(collName, new CollectionCallback<Object>() {
-			public Object doInCollection(DBCollection collection) throws MongoException, DataAccessException {
-				for (DBObject dbo : collection.find(dbk)) {
+			public Object doInCollection(MongoCollection<Document> collection) throws MongoException, DataAccessException {
+				for (Document dbo : collection.find(dbk)) {
 					String key = (String) dbo.get(ENTITY_FIELD_NAME);
 					if (log.isDebugEnabled()) {
 						log.debug("Processing key: {}", key);
@@ -143,27 +144,31 @@ public Object persistState(ChangeSetBacked entity, ChangeSet cs) throws DataAcce
 		for (String key : cs.getValues().keySet()) {
 			if (key != null && !key.startsWith("_") && !key.equals(ChangeSetPersister.ID_KEY)) {
 				Object value = cs.getValues().get(key);
-				final DBObject dbQuery = new BasicDBObject();
+				final Document dbQuery = new Document();
 				dbQuery.put(ENTITY_ID, getPersistentId(entity, cs));
 				dbQuery.put(ENTITY_CLASS, entity.getClass().getName());
 				dbQuery.put(ENTITY_FIELD_NAME, key);
-				DBObject dbId = mongoTemplate.execute(collName, new CollectionCallback<DBObject>() {
-					public DBObject doInCollection(DBCollection collection) throws MongoException, DataAccessException {
-						return collection.findOne(dbQuery);
+				final Document dbId = mongoTemplate.execute(collName, new CollectionCallback<Document>() {
+					public Document doInCollection(MongoCollection<Document> collection)
+							throws MongoException, DataAccessException {
+						Document id = collection.find(dbQuery).first();
+						return id;
 					}
 				});
+
 				if (value == null) {
 					if (log.isDebugEnabled()) {
 						log.debug("Flush: removing: {}", dbQuery);
 					}
 					mongoTemplate.execute(collName, new CollectionCallback<Object>() {
-						public Object doInCollection(DBCollection collection) throws MongoException, DataAccessException {
-							collection.remove(dbQuery);
+						public Object doInCollection(MongoCollection<Document> collection)
+								throws MongoException, DataAccessException {
+							DeleteResult dr = collection.deleteMany(dbQuery);
 							return null;
 						}
 					});
 				} else {
-					final DBObject dbDoc = new BasicDBObject();
+					final Document dbDoc = new Document();
 					dbDoc.putAll(dbQuery);
 					if (log.isDebugEnabled()) {
 						log.debug("Flush: saving: {}", dbQuery);
@@ -174,8 +179,18 @@ public Object doInCollection(DBCollection collection) throws MongoException, Dat
 						dbDoc.put("_id", dbId.get("_id"));
 					}
 					mongoTemplate.execute(collName, new CollectionCallback<Object>() {
-						public Object doInCollection(DBCollection collection) throws MongoException, DataAccessException {
-							collection.save(dbDoc);
+						public Object doInCollection(MongoCollection<Document> collection)
+								throws MongoException, DataAccessException {
+
+							if (dbId != null) {
+								collection.replaceOne(Filters.eq("_id", dbId.get("_id")), dbDoc);
+							} else {
+
+								if (dbDoc.containsKey("_id") && dbDoc.get("_id") == null) {
+									dbDoc.remove("_id");
+								}
+								collection.insertOne(dbDoc);
+							}
 							return null;
 						}
 					});

spring-data-mongodb-cross-store/src/test/java/org/springframework/data/mongodb/crossstore/CrossStoreMongoTests.java

@@ -18,6 +18,7 @@
 import javax.persistence.EntityManager;
 import javax.persistence.PersistenceContext;
 
+import org.bson.Document;
 import org.junit.After;
 import org.junit.Assert;
 import org.junit.Before;
@@ -36,8 +37,6 @@
 import org.springframework.transaction.support.TransactionCallback;
 import org.springframework.transaction.support.TransactionTemplate;
 
-import com.mongodb.DBObject;
-
 /**
  * Integration tests for MongoDB cross-store persistence (mainly {@link MongoChangeSetPersister}).
  * 
@@ -48,14 +47,11 @@
 @ContextConfiguration("classpath:/META-INF/spring/applicationContext.xml")
 public class CrossStoreMongoTests {
 
-	@Autowired
-	MongoTemplate mongoTemplate;
+	@Autowired MongoTemplate mongoTemplate;
 
-	@PersistenceContext
-	EntityManager entityManager;
+	@PersistenceContext EntityManager entityManager;
 
-	@Autowired
-	PlatformTransactionManager transactionManager;
+	@Autowired PlatformTransactionManager transactionManager;
 	TransactionTemplate txTemplate;
 
 	@Before
@@ -187,7 +183,7 @@ public Person doInTransaction(TransactionStatus status) {
 
 		boolean weFound3 = false;
 
-		for (DBObject dbo : this.mongoTemplate.getCollection(mongoTemplate.getCollectionName(Person.class)).find()) {
+		for (Document dbo : this.mongoTemplate.getCollection(mongoTemplate.getCollectionName(Person.class)).find()) {
 			Assert.assertTrue(!dbo.get("_entity_id").equals(2L));
 			if (dbo.get("_entity_id").equals(3L)) {
 				weFound3 = true;

spring-data-mongodb-cross-store/src/test/resources/META-INF/spring/applicationContext.xml

@@ -20,7 +20,7 @@
   <mongo:mapping-converter/>
 
   <!--  Mongo config -->
-  <bean id="mongo" class="org.springframework.data.mongodb.core.MongoFactoryBean">
+  <bean id="mongo" class="org.springframework.data.mongodb.core.MongoClientFactoryBean">
     <property name="host" value="localhost"/>
     <property name="port" value="27017"/>
   </bean>

spring-data-mongodb/pom.xml

@@ -18,6 +18,7 @@
 	<properties>
 		<objenesis>1.3</objenesis>
 		<equalsverifier>1.5</equalsverifier>
+		<mongo>3.2.2</mongo>
 	</properties>
 
 	<dependencies>

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/MongoDbFactory.java

@@ -20,6 +20,7 @@
 import org.springframework.data.mongodb.core.MongoExceptionTranslator;
 
 import com.mongodb.DB;
+import com.mongodb.client.MongoDatabase;
 
 /**
  * Interface for factories creating {@link DB} instances.
@@ -35,7 +36,7 @@ public interface MongoDbFactory {
 	 * @return
 	 * @throws DataAccessException
 	 */
-	DB getDb() throws DataAccessException;
+	MongoDatabase getDb() throws DataAccessException;
 
 	/**
 	 * Creates a {@link DB} instance to access the database with the given name.
@@ -44,12 +45,14 @@ public interface MongoDbFactory {
 	 * @return
 	 * @throws DataAccessException
 	 */
-	DB getDb(String dbName) throws DataAccessException;
+	MongoDatabase getDb(String dbName) throws DataAccessException;
 
 	/**
 	 * Exposes a shared {@link MongoExceptionTranslator}.
 	 * 
 	 * @return will never be {@literal null}.
 	 */
 	PersistenceExceptionTranslator getExceptionTranslator();
+
+	DB getLegacyDb();
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoDbFactoryParser.java

@@ -32,7 +32,7 @@
 import org.springframework.beans.factory.xml.ParserContext;
 import org.springframework.data.authentication.UserCredentials;
 import org.springframework.data.config.BeanComponentDefinitionBuilder;
-import org.springframework.data.mongodb.core.MongoFactoryBean;
+import org.springframework.data.mongodb.core.MongoClientFactoryBean;
 import org.springframework.data.mongodb.core.SimpleMongoDbFactory;
 import org.springframework.util.StringUtils;
 import org.w3c.dom.Element;
@@ -131,7 +131,7 @@ protected AbstractBeanDefinition parseInternal(Element element, ParserContext pa
 	 */
 	private BeanDefinition registerMongoBeanDefinition(Element element, ParserContext parserContext) {
 
-		BeanDefinitionBuilder mongoBuilder = BeanDefinitionBuilder.genericBeanDefinition(MongoFactoryBean.class);
+		BeanDefinitionBuilder mongoBuilder = BeanDefinitionBuilder.genericBeanDefinition(MongoClientFactoryBean.class);
 		setPropertyValue(mongoBuilder, element, "host");
 		setPropertyValue(mongoBuilder, element, "port");
 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/BulkOperations.java

@@ -21,8 +21,6 @@
 import org.springframework.data.mongodb.core.query.Update;
 import org.springframework.data.util.Pair;
 
-import com.mongodb.BulkWriteResult;
-
 /**
  * Bulk operations for insert/update/remove actions on a collection. These bulks operation are available since MongoDB
  * 2.6 and make use of low level bulk commands on the protocol level. This interface defines a fluent API to add
@@ -141,5 +139,5 @@ public enum BulkMode {
 	 * @return Result of the bulk operation providing counters for inserts/updates etc.
 	 * @throws {@link BulkOperationException} if an error occurred during bulk processing.
 	 */
-	BulkWriteResult execute();
+	com.mongodb.bulk.BulkWriteResult execute();
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/CollectionCallback.java

@@ -15,12 +15,14 @@
  */
 package org.springframework.data.mongodb.core;
 
-import com.mongodb.DBCollection;
-import com.mongodb.MongoException;
+import org.bson.Document;
 import org.springframework.dao.DataAccessException;
 
+import com.mongodb.MongoException;
+import com.mongodb.client.MongoCollection;
+
 public interface CollectionCallback<T> {
 
-	T doInCollection(DBCollection collection) throws MongoException, DataAccessException;
+	T doInCollection(MongoCollection<Document> collection) throws MongoException, DataAccessException;
 
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/CursorPreparer.java

@@ -15,7 +15,10 @@
  */
 package org.springframework.data.mongodb.core;
 
+import org.bson.Document;
+
 import com.mongodb.DBCursor;
+import com.mongodb.client.FindIterable;
 
 /**
  * Simple callback interface to allow customization of a {@link DBCursor}.
@@ -29,5 +32,5 @@ interface CursorPreparer {
 	 * 
 	 * @param cursor
 	 */
-	DBCursor prepare(DBCursor cursor);
+	FindIterable<Document> prepare(FindIterable<Document> cursor);
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/DbCallback.java

@@ -15,11 +15,12 @@
  */
 package org.springframework.data.mongodb.core;
 
-import com.mongodb.DB;
-import com.mongodb.MongoException;
 import org.springframework.dao.DataAccessException;
 
+import com.mongodb.MongoException;
+import com.mongodb.client.MongoDatabase;
+
 public interface DbCallback<T> {
 
-	T doInDB(DB db) throws MongoException, DataAccessException;
+	T doInDB(MongoDatabase db) throws MongoException, DataAccessException;
 }