DATAMONGO-1158 - Add Support for mongo-java-driver 3.0

pom.xml

@@ -5,7 +5,7 @@
 
 	<groupId>org.springframework.data</groupId>
 	<artifactId>spring-data-mongodb-parent</artifactId>
-	<version>1.7.0.BUILD-SNAPSHOT</version>
+	<version>1.7.0.DATAMONGO-1158-SNAPSHOT</version>
 	<packaging>pom</packaging>
 
 	<name>Spring Data MongoDB</name>

spring-data-mongodb-cross-store/pom.xml

@@ -6,7 +6,7 @@
 	<parent>
 		<groupId>org.springframework.data</groupId>
 		<artifactId>spring-data-mongodb-parent</artifactId>
-		<version>1.7.0.BUILD-SNAPSHOT</version>
+		<version>1.7.0.DATAMONGO-1158-SNAPSHOT</version>
 		<relativePath>../pom.xml</relativePath>
 	</parent>
 
@@ -48,7 +48,7 @@
 		<dependency>
 			<groupId>org.springframework.data</groupId>
 			<artifactId>spring-data-mongodb</artifactId>
-			<version>1.7.0.BUILD-SNAPSHOT</version>
+			<version>1.7.0.DATAMONGO-1158-SNAPSHOT</version>
 		</dependency>
 
 		<dependency>

spring-data-mongodb-distribution/pom.xml

@@ -13,7 +13,7 @@
 	<parent>
 		<groupId>org.springframework.data</groupId>
 		<artifactId>spring-data-mongodb-parent</artifactId>
-		<version>1.7.0.BUILD-SNAPSHOT</version>
+		<version>1.7.0.DATAMONGO-1158-SNAPSHOT</version>
 		<relativePath>../pom.xml</relativePath>
 	</parent>
 

spring-data-mongodb-log4j/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>org.springframework.data</groupId>
 		<artifactId>spring-data-mongodb-parent</artifactId>
-		<version>1.7.0.BUILD-SNAPSHOT</version>
+		<version>1.7.0.DATAMONGO-1158-SNAPSHOT</version>
 		<relativePath>../pom.xml</relativePath>
 	</parent>
 

spring-data-mongodb/pom.xml

@@ -11,7 +11,7 @@
 	<parent>
 		<groupId>org.springframework.data</groupId>
 		<artifactId>spring-data-mongodb-parent</artifactId>
-		<version>1.7.0.BUILD-SNAPSHOT</version>
+		<version>1.7.0.DATAMONGO-1158-SNAPSHOT</version>
 		<relativePath>../pom.xml</relativePath>
 	</parent>
 

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

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2015 the original author or authors.
+ *
+ * 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.
+ */
+package org.springframework.data.mongodb;
+
+import org.springframework.util.ClassUtils;
+
+/**
+ * {@link MongoClientVersion} holds information about the used mongo-java client and is used to distinguish between
+ * different versions.
+ * 
+ * @author Christoph Strobl
+ * @since 1.7
+ */
+public class MongoClientVersion {
+
+	private static final boolean IS_MONGO_30 = ClassUtils.isPresent("com.mongodb.binding.SingleServerBinding",
+			MongoClientVersion.class.getClassLoader());
+	private static final boolean IS_ASYNC_CLIENT = ClassUtils.isPresent("com.mongodb.async.client.MongoClient",
+			MongoClientVersion.class.getClassLoader());
+
+	/**
+	 * @return true if mongo-java-driver version 3 or later is on classpath.
+	 */
+	public static boolean isMongo3Driver() {
+		return IS_MONGO_30;
+	}
+
+	/**
+	 * @return true if mongodb-driver-async is on classpath.
+	 */
+	public static boolean isAsyncClient() {
+		return IS_ASYNC_CLIENT;
+	}
+}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2014 the original author or authors.
+ * Copyright 2011-2015 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -46,6 +46,7 @@
 import org.springframework.util.StringUtils;
 
 import com.mongodb.Mongo;
+import com.mongodb.MongoClient;
 
 /**
  * Base class for Spring Data MongoDB configuration using JavaConfig.
@@ -54,6 +55,7 @@
  * @author Oliver Gierke
  * @author Thomas Darimont
  * @author Ryan Tenney
+ * @author Christoph Strobl
  */
 @Configuration
 public abstract class AbstractMongoConfiguration {
@@ -70,7 +72,10 @@ public abstract class AbstractMongoConfiguration {
 	 * returned by {@link #getDatabaseName()} later on effectively.
 	 * 
 	 * @return
+	 * @deprecated since 1.7. {@link MongoClient} should hold authentication data within
+	 *             {@link MongoClient#getCredentialsList()}
 	 */
+	@Deprecated
 	protected String getAuthenticationDatabaseName() {
 		return null;
 	}
@@ -129,7 +134,10 @@ protected String getMappingBasePackage() {
 	 * be used.
 	 * 
 	 * @return
+	 * @deprecated since 1.7. {@link MongoClient} should hold authentication data within
+	 *             {@link MongoClient#getCredentialsList()}
 	 */
+	@Deprecated
 	protected UserCredentials getUserCredentials() {
 		return null;
 	}

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

@@ -0,0 +1,86 @@
+/*
+ * Copyright 2015 the original author or authors.
+ *
+ * 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.
+ */
+package org.springframework.data.mongodb.config;
+
+import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.parsing.BeanComponentDefinition;
+import org.springframework.beans.factory.parsing.CompositeComponentDefinition;
+import org.springframework.beans.factory.support.BeanDefinitionBuilder;
+import org.springframework.beans.factory.xml.BeanDefinitionParser;
+import org.springframework.beans.factory.xml.ParserContext;
+import org.springframework.data.config.BeanComponentDefinitionBuilder;
+import org.springframework.data.config.ParsingUtils;
+import org.springframework.data.mongodb.core.MongoClientFactoryBean;
+import org.springframework.util.StringUtils;
+import org.w3c.dom.Element;
+
+/**
+ * Parser for {@code mongo-client} definitions.
+ * 
+ * @author Christoph Strobl
+ * @since 1.7
+ */
+public class MongoClientParser implements BeanDefinitionParser {
+
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.beans.factory.xml.BeanDefinitionParser#parse(org.w3c.dom.Element, org.springframework.beans.factory.xml.ParserContext)
+	 */
+	public BeanDefinition parse(Element element, ParserContext parserContext) {
+
+		Object source = parserContext.extractSource(element);
+		String id = element.getAttribute("id");
+
+		BeanComponentDefinitionBuilder helper = new BeanComponentDefinitionBuilder(element, parserContext);
+
+		BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MongoClientFactoryBean.class);
+
+		ParsingUtils.setPropertyValue(builder, element, "port", "port");
+		ParsingUtils.setPropertyValue(builder, element, "host", "host");
+		ParsingUtils.setPropertyValue(builder, element, "credentials", "credentials");
+
+		MongoParsingUtils.parseMongoClientOptions(element, builder);
+		MongoParsingUtils.parseReplicaSet(element, builder);
+
+		String defaultedId = StringUtils.hasText(id) ? id : BeanNames.MONGO_BEAN_NAME;
+
+		parserContext.pushContainingComponent(new CompositeComponentDefinition("Mongo", source));
+
+		BeanComponentDefinition mongoComponent = helper.getComponent(builder, defaultedId);
+		parserContext.registerBeanComponent(mongoComponent);
+
+		BeanComponentDefinition serverAddressPropertyEditor = helper.getComponent(MongoParsingUtils
+				.getServerAddressPropertyEditorBuilder());
+		parserContext.registerBeanComponent(serverAddressPropertyEditor);
+
+		BeanComponentDefinition writeConcernEditor = helper.getComponent(MongoParsingUtils
+				.getWriteConcernPropertyEditorBuilder());
+		parserContext.registerBeanComponent(writeConcernEditor);
+
+		BeanComponentDefinition readPreferenceEditor = helper.getComponent(MongoParsingUtils
+				.getReadPreferencePropertyEditorBuilder());
+		parserContext.registerBeanComponent(readPreferenceEditor);
+
+		BeanComponentDefinition credentialsEditor = helper.getComponent(MongoParsingUtils
+				.getMongoCredentialPropertyEditor());
+		parserContext.registerBeanComponent(credentialsEditor);
+
+		parserContext.popAndRegisterContainingComponent();
+
+		return mongoComponent.getBeanDefinition();
+	}
+
+}

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

@@ -0,0 +1,124 @@
+/*
+ * Copyright 2015 the original author or authors.
+ *
+ * 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.
+ */
+package org.springframework.data.mongodb.config;
+
+import java.beans.PropertyEditorSupport;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Properties;
+
+import org.springframework.util.StringUtils;
+
+import com.mongodb.MongoCredential;
+
+/**
+ * Parse a {@link String} to a Collection of {@link MongoCredential}.
+ * 
+ * @author Christoph Strobl
+ * @since 1.7
+ */
+public class MongoCredentialPropertyEditor extends PropertyEditorSupport {
+
+	private static final String AUTH_MECHANISM_KEY = "uri.authMechanism";
+	private static final String USERNAME_PASSWORD_DELIMINATOR = ":";
+	private static final String DATABASE_DELIMINATOR = "@";
+	private static final String OPTIONS_DELIMINATOR = "?";
+	private static final String OPTION_VALUE_DELIMINATOR = "&";
+
+	@Override
+	public void setAsText(String text) throws IllegalArgumentException {
+
+		if (!StringUtils.hasText(text)) {
+			return;
+		}
+
+		List<MongoCredential> credentials = new ArrayList<MongoCredential>();
+		for (String credentialString : text.split(",")) {
+
+			if (!text.contains(USERNAME_PASSWORD_DELIMINATOR) || !text.contains(DATABASE_DELIMINATOR)) {
+				throw new IllegalArgumentException("Credentials need to be in format 'username:password@database'!");
+			}
+
+			String[] userNameAndPassword = extractUserNameAndPassword(credentialString);
+			String database = extractDB(credentialString);
+			Properties options = extractOptions(credentialString);
+
+			if (!options.isEmpty()) {
+				if (options.containsKey(AUTH_MECHANISM_KEY)) {
+					String authMechanism = options.getProperty(AUTH_MECHANISM_KEY);
+					if (MongoCredential.GSSAPI_MECHANISM.equals(authMechanism)) {
+						credentials.add(MongoCredential.createGSSAPICredential(userNameAndPassword[0]));
+					} else if (MongoCredential.MONGODB_CR_MECHANISM.equals(authMechanism)) {
+						credentials.add(MongoCredential.createMongoCRCredential(userNameAndPassword[0], database,
+								userNameAndPassword[1].toCharArray()));
+					} else if (MongoCredential.MONGODB_X509_MECHANISM.equals(authMechanism)) {
+						credentials.add(MongoCredential.createMongoX509Credential(userNameAndPassword[0]));
+					} else if (MongoCredential.PLAIN_MECHANISM.equals(authMechanism)) {
+						credentials.add(MongoCredential.createPlainCredential(userNameAndPassword[0], database,
+								userNameAndPassword[1].toCharArray()));
+					} else if (MongoCredential.SCRAM_SHA_1_MECHANISM.equals(authMechanism)) {
+						credentials.add(MongoCredential.createScramSha1Credential(userNameAndPassword[0], database,
+								userNameAndPassword[1].toCharArray()));
+					} else {
+						throw new IllegalArgumentException(String.format(
+								"Cannot create MongoCredentials for unknown auth mechanism '%s'!", authMechanism));
+					}
+				}
+			} else {
+				credentials.add(MongoCredential.createCredential(userNameAndPassword[0], database,
+						userNameAndPassword[1].toCharArray()));
+			}
+		}
+
+		setValue(credentials);
+	}
+
+	private String[] extractUserNameAndPassword(String text) {
+
+		int dbSeperationIndex = text.lastIndexOf(DATABASE_DELIMINATOR);
+		String userNameAndPassword = text.substring(0, dbSeperationIndex);
+		return userNameAndPassword.split(USERNAME_PASSWORD_DELIMINATOR);
+	}
+
+	private String extractDB(String text) {
+
+		int dbSeperationIndex = text.lastIndexOf(DATABASE_DELIMINATOR);
+
+		String tmp = text.substring(dbSeperationIndex + 1);
+		int optionsSeperationIndex = tmp.lastIndexOf(OPTIONS_DELIMINATOR);
+
+		return optionsSeperationIndex > -1 ? tmp.substring(0, optionsSeperationIndex) : tmp;
+	}
+
+	private Properties extractOptions(String text) {
+
+		int optionsSeperationIndex = text.lastIndexOf(OPTIONS_DELIMINATOR);
+		int dbSeperationIndex = text.lastIndexOf(OPTIONS_DELIMINATOR);
+
+		if (optionsSeperationIndex == -1 || dbSeperationIndex > optionsSeperationIndex) {
+			return new Properties();
+		}
+
+		Properties properties = new Properties();
+
+		for (String option : text.substring(optionsSeperationIndex + 1).split(OPTION_VALUE_DELIMINATOR)) {
+			String[] optionArgs = option.split("=");
+			properties.put(optionArgs[0], optionArgs[1]);
+		}
+
+		return properties;
+	}
+}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2014 the original author or authors.
+ * Copyright 2011-2015 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +22,7 @@
  * 
  * @author Oliver Gierke
  * @author Martin Baumgartner
+ * @author Christoph Strobl
  */
 public class MongoNamespaceHandler extends NamespaceHandlerSupport {
 
@@ -33,6 +34,7 @@ public void init() {
 
 		registerBeanDefinitionParser("mapping-converter", new MappingMongoConverterParser());
 		registerBeanDefinitionParser("mongo", new MongoParser());
+		registerBeanDefinitionParser("mongo-client", new MongoClientParser());
 		registerBeanDefinitionParser("db-factory", new MongoDbFactoryParser());
 		registerBeanDefinitionParser("jmx", new MongoJmxParser());
 		registerBeanDefinitionParser("auditing", new MongoAuditingBeanDefinitionParser());