Support for authorizedDatabases option

JAVA-3694

Author: jstewart148

driver-core/src/main/com/mongodb/internal/async/client/AsyncListDatabasesIterable.java

@@ -67,4 +67,15 @@ public interface AsyncListDatabasesIterable<T> extends AsyncMongoIterable<T> {
      * @mongodb.server.release 3.4.3
      */
     AsyncListDatabasesIterable<T> nameOnly(@Nullable Boolean nameOnly);
+
+    /**
+     * Sets the authorizedDatabasesOnly flag that indicates whether the command should return just the databases which the user
+     * is authorized to see.
+     *
+     * @param authorizedDatabasesOnly the authorizedDatabasesOnly flag, which may be null
+     * @return this
+     * @since 4.1
+     * @mongodb.server.release 4.0
+     */
+    AsyncListDatabasesIterable<T> authorizedDatabasesOnly(@Nullable Boolean authorizedDatabasesOnly);
 }

driver-core/src/main/com/mongodb/internal/async/client/AsyncListDatabasesIterableImpl.java

@@ -38,6 +38,7 @@ final class AsyncListDatabasesIterableImpl<TResult> extends AsyncMongoIterableIm
     private long maxTimeMS;
     private Bson filter;
     private Boolean nameOnly;
+    private Boolean authorizedDatabasesOnly;
 
     AsyncListDatabasesIterableImpl(@Nullable final AsyncClientSession clientSession, final Class<TResult> resultClass,
                                    final CodecRegistry codecRegistry, final ReadPreference readPreference,
@@ -73,8 +74,14 @@ public AsyncListDatabasesIterable<TResult> nameOnly(@Nullable final Boolean name
         return this;
     }
 
+    @Override
+    public AsyncListDatabasesIterable<TResult> authorizedDatabasesOnly(@Nullable final Boolean authorizedDatabasesOnly) {
+        this.authorizedDatabasesOnly = authorizedDatabasesOnly;
+        return this;
+    }
+
     @Override
     AsyncReadOperation<AsyncBatchCursor<TResult>> asAsyncReadOperation() {
-        return operations.listDatabases(resultClass, filter, nameOnly, maxTimeMS);
+        return operations.listDatabases(resultClass, filter, nameOnly, maxTimeMS, authorizedDatabasesOnly);
     }
 }

driver-core/src/main/com/mongodb/internal/operation/AsyncOperations.java

@@ -251,8 +251,9 @@ public <TResult> AsyncReadOperation<AsyncBatchCursor<TResult>> listCollections(f
     }
 
     public <TResult> AsyncReadOperation<AsyncBatchCursor<TResult>> listDatabases(final Class<TResult> resultClass, final Bson filter,
-                                                                                 final Boolean nameOnly, final long maxTimeMS) {
-        return operations.listDatabases(resultClass, filter, nameOnly, maxTimeMS);
+                                                                                 final Boolean nameOnly, final long maxTimeMS,
+                                                                                 final Boolean authorizedDatabasesOnly) {
+        return operations.listDatabases(resultClass, filter, nameOnly, maxTimeMS, authorizedDatabasesOnly);
     }
 
     public <TResult> AsyncReadOperation<AsyncBatchCursor<TResult>> listIndexes(final Class<TResult> resultClass, final Integer batchSize,

driver-core/src/main/com/mongodb/internal/operation/ListDatabasesOperation.java

@@ -58,6 +58,7 @@ public class ListDatabasesOperation<T> implements AsyncReadOperation<AsyncBatchC
     private long maxTimeMS;
     private BsonDocument filter;
     private Boolean nameOnly;
+    private Boolean authorizedDatabasesOnly;
 
     /**
      * Construct a new instance.
@@ -132,6 +133,18 @@ public ListDatabasesOperation<T> nameOnly(final Boolean nameOnly) {
         return this;
     }
 
+    /**
+     * Sets the authorizedDatabasesOnly flag that indicates whether the command should return just the databases which the user
+     * is authorized to see.
+     *
+     * @param authorizedDatabasesOnly the authorizedDatabasesOnly flag, which may be null
+     * @return this
+     */
+    public ListDatabasesOperation<T> authorizedDatabasesOnly(final Boolean authorizedDatabasesOnly) {
+        this.authorizedDatabasesOnly = authorizedDatabasesOnly;
+        return this;
+    }
+
     /**
      * Enables retryable reads if a read fails due to a network error.
      *
@@ -166,6 +179,17 @@ public Boolean getNameOnly() {
         return nameOnly;
     }
 
+    /**
+     * Gets the authorizedDatabasesOnly flag that indicates whether the command should return just the databases which the user
+     * is authorized to see.
+     *
+     * @return the authorized databases value
+     * @since 4.1
+     */
+    public Boolean getAuthorizedDatabasesOnly() {
+        return authorizedDatabasesOnly;
+    }
+
     /**
      * Executing this will return a list of all the databases names in the MongoDB instance.
      *
@@ -231,6 +255,9 @@ private BsonDocument getCommand() {
         if (nameOnly != null) {
             command.put("nameOnly", new BsonBoolean(nameOnly));
         }
+        if (authorizedDatabasesOnly != null) {
+            command.put("authorizedDatabases", new BsonBoolean(authorizedDatabasesOnly));
+        }
         return command;
     }
 }

driver-core/src/main/com/mongodb/internal/operation/Operations.java

@@ -508,11 +508,13 @@ <TResult> ListCollectionsOperation<TResult> listCollections(final String databas
     }
 
     <TResult> ListDatabasesOperation<TResult> listDatabases(final Class<TResult> resultClass, final Bson filter,
-                                                                   final Boolean nameOnly, final long maxTimeMS) {
+                                                            final Boolean nameOnly, final long maxTimeMS,
+                                                            final Boolean authorizedDatabasesOnly) {
         return new ListDatabasesOperation<TResult>(codecRegistry.get(resultClass)).maxTime(maxTimeMS, MILLISECONDS)
                 .retryReads(retryReads)
                 .filter(toBsonDocumentOrNull(filter))
-                .nameOnly(nameOnly);
+                .nameOnly(nameOnly)
+                .authorizedDatabasesOnly(authorizedDatabasesOnly);
     }
 
     <TResult> ListIndexesOperation<TResult> listIndexes(final Class<TResult> resultClass, final Integer batchSize,

driver-core/src/main/com/mongodb/internal/operation/SyncOperations.java

@@ -235,8 +235,9 @@ public <TResult> ReadOperation<BatchCursor<TResult>> listCollections(final Strin
     }
 
     public <TResult> ReadOperation<BatchCursor<TResult>> listDatabases(final Class<TResult> resultClass, final Bson filter,
-                                                                       final Boolean nameOnly, final long maxTimeMS) {
-        return operations.listDatabases(resultClass, filter, nameOnly, maxTimeMS);
+                                                                       final Boolean nameOnly, final long maxTimeMS,
+                                                                       final Boolean authorizedDatabases) {
+        return operations.listDatabases(resultClass, filter, nameOnly, maxTimeMS, authorizedDatabases);
     }
 
     public <TResult> ReadOperation<BatchCursor<TResult>> listIndexes(final Class<TResult> resultClass, final Integer batchSize,

driver-core/src/test/functional/com/mongodb/internal/operation/ListDatabasesOperationSpecification.groovy

@@ -64,6 +64,14 @@ class ListDatabasesOperationSpecification extends OperationFunctionalSpecificati
         then:
         names.contains(getDatabaseName())
 
+        when:
+        operation = operation.authorizedDatabasesOnly(true).nameOnly(true)
+                .filter(new BsonDocument('name',  new BsonRegularExpression("^${getDatabaseName()}")))
+        names = executeAndCollectBatchCursorResults(operation, async)*.get('name')
+
+        then:
+        names.contains(getDatabaseName())
+
         where:
         async << [true, false]
     }

driver-core/src/test/unit/com/mongodb/internal/async/client/AsyncListDatabasesIterableSpecification.groovy

@@ -48,7 +48,7 @@ class AsyncListDatabasesIterableSpecification extends Specification {
                 it[0].onResult(null, null)
             }
         }
-        def executor = new TestOperationExecutor([cursor, cursor]);
+        def executor = new TestOperationExecutor([cursor, cursor, cursor]);
         def listDatabasesIterable = new AsyncListDatabasesIterableImpl<Document>(null, Document, codecRegistry, readPreference,
                 executor, true)
                 .maxTime(1000, MILLISECONDS)
@@ -73,6 +73,16 @@ class AsyncListDatabasesIterableSpecification extends Specification {
         then: 'should use the overrides'
         expect operation, isTheSameAs(new ListDatabasesOperation<Document>(new DocumentCodec()).maxTime(999, MILLISECONDS)
                 .filter(BsonDocument.parse('{a: 1}')).nameOnly(true).retryReads(true))
+
+        when: 'overriding initial options'
+        listDatabasesIterable.maxTime(101, MILLISECONDS).filter(Document.parse('{a: 1}'))
+                .authorizedDatabasesOnly(true).into([]) { result, t -> }
+
+        operation = executor.getReadOperation() as ListDatabasesOperation<Document>
+
+        then: 'should use the overrides'
+        expect operation, isTheSameAs(new ListDatabasesOperation<Document>(new DocumentCodec()).maxTime(101, MILLISECONDS)
+                .filter(BsonDocument.parse('{a: 1}')).nameOnly(true).authorizedDatabasesOnly(true).retryReads(true))
     }
 
     def 'should follow the MongoIterable interface as expected'() {

driver-reactive-streams/src/main/com/mongodb/reactivestreams/client/ListDatabasesPublisher.java

@@ -61,6 +61,17 @@ public interface ListDatabasesPublisher<TResult> extends Publisher<TResult> {
      */
     ListDatabasesPublisher<TResult> nameOnly(Boolean nameOnly);
 
+    /**
+     * Sets the authorizedDatabasesOnly flag that indicates whether the command should return just the databases which the user
+     * is authorized to see.
+     *
+     * @param authorizedDatabasesOnly the authorizedDatabasesOnly flag, which may be null
+     * @return this
+     * @since 4.1
+     * @mongodb.server.release 4.0
+     */
+    ListDatabasesPublisher<TResult> authorizedDatabasesOnly(Boolean authorizedDatabasesOnly);
+
     /**
      * Sets the number of documents to return per batch.
      *

driver-reactive-streams/src/main/com/mongodb/reactivestreams/client/internal/ListDatabasesPublisherImpl.java

@@ -54,6 +54,12 @@ public ListDatabasesPublisher<TResult> nameOnly(final Boolean nameOnly) {
         return this;
     }
 
+    @Override
+    public ListDatabasesPublisher<TResult> authorizedDatabasesOnly(final Boolean authorizedDatabasesOnly) {
+        wrapped.authorizedDatabasesOnly(authorizedDatabasesOnly);
+        return this;
+    }
+
     @Override
     public ListDatabasesPublisher<TResult> batchSize(final int batchSize) {
         wrapped.batchSize(batchSize);