JAVA-2656: Deprecate MongoClient constructors that allow more than one credential to be used, and add otherwise equivalent constructors that take a single credential

Author: jyemin

driver/src/main/com/mongodb/MongoClient.java

@@ -36,6 +36,7 @@
 
 import static com.mongodb.assertions.Assertions.notNull;
 import static java.util.Arrays.asList;
+import static java.util.Collections.singletonList;
 import static org.bson.codecs.configuration.CodecRegistries.fromProviders;
 
 /**
@@ -47,7 +48,7 @@
  * MongoClient mongoClient1 = new MongoClient("localhost");
  * MongoClient mongoClient2 = new MongoClient("localhost", 27017);
  * MongoClient mongoClient4 = new MongoClient(new ServerAddress("localhost"));
- * MongoClient mongoClient5 = new MongoClient(new ServerAddress("localhost"), new MongoClientOptions.Builder().build());
+ * MongoClient mongoClient5 = new MongoClient(new ServerAddress("localhost"), MongoClientOptions.builder().build());
  * </pre>
  * <p>You can connect to a <a href="http://www.mongodb.org/display/DOCS/Replica+Sets">replica set</a> using the Java driver by passing a
  * ServerAddress list to the MongoClient constructor. For example:</p>
@@ -171,9 +172,11 @@ public MongoClient(final ServerAddress addr) {
      * @param credentialsList the list of credentials used to authenticate all connections
      * @see com.mongodb.ServerAddress
      * @since 2.11.0
+     * @deprecated Prefer {@link #MongoClient(ServerAddress, MongoCredential, MongoClientOptions)}
      */
+    @Deprecated
     public MongoClient(final ServerAddress addr, final List<MongoCredential> credentialsList) {
-        this(addr, credentialsList, new MongoClientOptions.Builder().build());
+        this(addr, credentialsList, MongoClientOptions.builder().build());
     }
 
     /**
@@ -195,11 +198,26 @@ public MongoClient(final ServerAddress addr, final MongoClientOptions options) {
      * @param options         default options
      * @see com.mongodb.ServerAddress
      * @since 2.11.0
+     * @deprecated Prefer {@link #MongoClient(ServerAddress, MongoCredential, MongoClientOptions)}
      */
+    @Deprecated
     public MongoClient(final ServerAddress addr, final List<MongoCredential> credentialsList, final MongoClientOptions options) {
         super(addr, credentialsList, options);
     }
 
+    /**
+     * Creates a Mongo instance based on a (single) mongo node using a given server address, credential, and options
+     *
+     * @param addr            the database address
+     * @param credential      the credential used to authenticate all connections
+     * @param options         default options
+     * @see com.mongodb.ServerAddress
+     * @since 3.6.0
+     */
+    public MongoClient(final ServerAddress addr, final MongoCredential credential, final MongoClientOptions options) {
+        super(addr, singletonList(credential), options);
+    }
+
     /**
      * <p>Creates an instance based on a list of replica set members or mongos servers. For a replica set it will discover all members.
      * For a list with a single seed, the driver will still discover all members of the replica set.  For a direct
@@ -234,7 +252,9 @@ public MongoClient(final List<ServerAddress> seeds) {
      * @param credentialsList the list of credentials used to authenticate all connections
      * @see MongoClientOptions#getLocalThreshold()
      * @since 2.11.0
+     * @deprecated Prefer {@link #MongoClient(List, MongoCredential, MongoClientOptions)}
      */
+    @Deprecated
     public MongoClient(final List<ServerAddress> seeds, final List<MongoCredential> credentialsList) {
         this(seeds, credentialsList, new MongoClientOptions.Builder().build());
     }
@@ -276,11 +296,35 @@ public MongoClient(final List<ServerAddress> seeds, final MongoClientOptions opt
      * @param options         the options
      * @see MongoClientOptions#getLocalThreshold()
      * @since 2.11.0
+     * @deprecated Prefer {@link #MongoClient(List, MongoCredential, MongoClientOptions)}
      */
+    @Deprecated
     public MongoClient(final List<ServerAddress> seeds, final List<MongoCredential> credentialsList, final MongoClientOptions options) {
         super(seeds, credentialsList, options);
     }
 
+    /**
+     * <p>Creates an instance based on a list of replica set members or mongos servers. For a replica set it will discover all members.
+     * For a list with a single seed, the driver will still discover all members of the replica set.  For a direct
+     * connection to a replica set member, with no discovery, use the {@link #MongoClient(ServerAddress, List, MongoClientOptions)}
+     * constructor instead.</p>
+     *
+     * <p>When there is more than one server to choose from based on the type of request (read or write) and the read preference (if it's a
+     * read request), the driver will randomly select a server to send a request. This applies to both replica sets and sharded clusters.
+     * The servers to randomly select from are further limited by the local threshold.  See
+     * {@link MongoClientOptions#getLocalThreshold()}</p>
+     *
+     * @param seeds Put as many servers as you can in the list and the system will figure out the rest.  This can either be a list of mongod
+     *              servers in the same replica set or a list of mongos servers in the same sharded cluster.
+     * @param credential the credential used to authenticate all connections
+     * @param options         the options
+     * @see MongoClientOptions#getLocalThreshold()
+     * @since 3.6.0
+     */
+    public MongoClient(final List<ServerAddress> seeds, final MongoCredential credential, final MongoClientOptions options) {
+        super(seeds, singletonList(credential), options);
+    }
+
     /**
      * Creates a Mongo described by a URI. If only one address is used it will only connect to that node, otherwise it will discover all
      * nodes.
@@ -317,12 +361,31 @@ public MongoClient(final MongoClientURI uri, final MongoDriverInformation mongoD
      * @param mongoDriverInformation any driver information to associate with the MongoClient
      * @see com.mongodb.ServerAddress
      * @since 3.4
+     * @deprecated Prefer {@link #MongoClient(ServerAddress, MongoCredential, MongoClientOptions, MongoDriverInformation)}
      */
+    @Deprecated
     public MongoClient(final ServerAddress addr, final List<MongoCredential> credentialsList, final MongoClientOptions options,
                        final MongoDriverInformation mongoDriverInformation) {
         super(addr, credentialsList, options, mongoDriverInformation);
     }
 
+    /**
+     * Creates a MongoClient to a single node using a given ServerAddress.
+     *
+     * <p>Note: Intended for driver and library authors to associate extra driver metadata with the connections.</p>
+     *
+     * @param addr            the database address
+     * @param credential      the credential used to authenticate all connections
+     * @param options         default options
+     * @param mongoDriverInformation any driver information to associate with the MongoClient
+     * @see com.mongodb.ServerAddress
+     * @since 3.6
+     */
+    public MongoClient(final ServerAddress addr, final MongoCredential credential, final MongoClientOptions options,
+                       final MongoDriverInformation mongoDriverInformation) {
+        super(addr, singletonList(credential), options, mongoDriverInformation);
+    }
+
     /**
      * Creates a MongoClient
      *
@@ -334,12 +397,31 @@ public MongoClient(final ServerAddress addr, final List<MongoCredential> credent
      * @param options         the options
      * @param mongoDriverInformation any driver information to associate with the MongoClient
      * @since 3.4
+     * @deprecated Prefer {@link #MongoClient(List, MongoCredential, MongoClientOptions, MongoDriverInformation)}
      */
+    @Deprecated
     public MongoClient(final List<ServerAddress> seeds, final List<MongoCredential> credentialsList, final MongoClientOptions options,
                        final MongoDriverInformation mongoDriverInformation) {
         super(seeds, credentialsList, options, mongoDriverInformation);
     }
 
+    /**
+     * Creates a MongoClient
+     *
+     * <p>Note: Intended for driver and library authors to associate extra driver metadata with the connections.</p>
+     *
+     * @param seeds Put as many servers as you can in the list and the system will figure out the rest.  This can either be a list of mongod
+     *              servers in the same replica set or a list of mongos servers in the same sharded cluster.
+     * @param credential      the credential used to authenticate all connections
+     * @param options         the options
+     * @param mongoDriverInformation any driver information to associate with the MongoClient
+     * @since 3.6
+     */
+    public MongoClient(final List<ServerAddress> seeds, final MongoCredential credential, final MongoClientOptions options,
+                       final MongoDriverInformation mongoDriverInformation) {
+        super(seeds, singletonList(credential), options, mongoDriverInformation);
+    }
+
     /**
      * Gets the options that this client uses to connect to server.
      *

driver/src/test/unit/com/mongodb/MongoConstructorsTest.java

@@ -21,7 +21,6 @@
 
 import java.net.UnknownHostException;
 import java.util.Arrays;
-import java.util.Collections;
 import java.util.List;
 
 import static org.junit.Assert.assertEquals;
@@ -71,13 +70,6 @@ public void shouldGetSeedList() throws UnknownHostException {
         }
     }
 
-    @Test
-    public void shouldUseGivenCredentials() throws UnknownHostException {
-        Mongo mongo = new MongoClient(new ServerAddress(),
-                                      Arrays.asList(MongoCredential.createMongoCRCredential("user", "admin", "pwd".toCharArray())));
-        mongo.close();
-    }
-
     @Test
     public void shouldDefaultToPrimaryReadPreference() throws UnknownHostException {
         Mongo mongo = new MongoClient();
@@ -93,8 +85,7 @@ public void shouldAllowRequiredReplicaSetNameForSingleServerConstructors() throw
         Mongo mongo = new MongoClient("localhost", MongoClientOptions.builder().requiredReplicaSetName("test").build());
         mongo.close();
 
-        mongo = new MongoClient(new ServerAddress(), Collections.<MongoCredential>emptyList(),
-                                MongoClientOptions.builder().requiredReplicaSetName("test").build());
+        mongo = new MongoClient(new ServerAddress(), MongoClientOptions.builder().requiredReplicaSetName("test").build());
         mongo.close();
 
         mongo = new MongoClient(new MongoClientURI("mongodb://localhost/?setName=test"));