DOCSP-47273: FAQ reorg

Author: norareidy

source/connection/connect.txt

@@ -200,3 +200,111 @@ class. Select the tab that corresponds to your preferred class.
                  .build();
          MongoClient mongoClient = MongoClients.create(settings);
 
+Frequently Asked Questions
+--------------------------
+
+This section answers questions that may arise when
+connecting to MongoDB.
+
+Why are there two types of ``MongoClient`` in the Java driver?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are two types of ``MongoClient`` because we wanted a cleaner API
+for new users that didn't have the confusion of including multiple CRUD
+APIs. We wanted to ensure that the new CRUD API was available in a Java
+package structure that would work well with Java module support
+introduced in Java 9.
+
+Which type of ``MongoClient`` should I use?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+New applications generally use the
+``com.mongodb.client.MongoClient`` interface, which supports:
+
+- Configuration with ``MongoClientSettings`` and ``ConnectionString``.  You can create instances of this interface via factory methods defined in the ``com.mongodb.client.MongoClients`` class.
+- CRUD API using ``MongoDatabase``, and from there, ``MongoCollection``
+
+Use the ``com.mongodb.MongoClient`` class if you require support for the legacy API, which supports:
+
+- Configuration with ``MongoClientOptions`` and ``MongoClientURI``
+- CRUD API using ``DB``, and from there, ``DBCollection``.  You can access this API via the ``getDB()`` method.
+
+For applications that require a mix of the new and legacy APIs, ``com.mongodb.MongoClient`` also supports:
+
+- Configuration with ``MongoClientSettings`` and ``ConnectionString``, the only difference being that you create instances via constructors instead of a factory class.
+- CRUD API using ``MongoDatabase``, and from there, ``MongoCollection``.  You can access this API via the ``getDatabase()`` method.
+
+How do I prevent the "java.lang.NoClassDefFoundError: com/mongodb/MongoClient" error?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You might encounter a ``java.lang.NoClassDefFoundError`` exception when your
+Java runtime environment cannot locate a class file at runtime. When you
+attempt to run application code that uses the {+driver-long+}, you must include
+the appropriate driver JAR files on the classpath.
+
+If you receive this error after adding the {+driver-short+} JAR files to
+your classpath, check the following items in your environment:
+
+- The JAR files exist in the locations specified by the classpath.
+- The classpath syntax is correct.
+- If you define the classpath in an environment variable, the Java runtime
+  environment uses that variable.
+- If you use a dependency manager, it does not report any unresolvable conflicts.
+
+.. tip::
+
+   This error contains the package and class name, which can help you identify
+   which driver JAR might be missing from your classpath. To locate the
+   driver JAR that the error refers to, check each of the entries in the
+   :ref:`API documentation <java-api-landing>`.
+
+How do I prevent the "com.mongodb.MongoSecurityException" error?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Your application might throw this exception if you specify invalid or
+incorrectly formatted credentials when connecting to a MongoDB deployment.
+
+If you receive this error when you attempt to connect to a MongoDB deployment,
+check the following items in your code:
+
+- The connection URI corresponds to the correct MongoDB deployment.
+  To learn more about setting your connection URI, see :ref:`connection-uri`.
+
+- The credentials for the authentication mechanism that you specified are
+  correct. To learn how to specify your credentials, see the
+  :ref:`authentication-mechanisms` and :ref:`enterprise-authentication-mechanisms`
+  guides.
+
+- The name of the authentication database that you specified is correct. To
+  learn how to set up the users and roles for your MongoDB deployment, see
+  `Manage Users and Roles <https://www.mongodb.com/docs/manual/tutorial/manage-users-and-roles/>`__
+  in the Server documentation.
+
+How do I prevent the "IllegalStateException: state should be: open" error?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You might encounter this exception if you call an operation on a ``MongoClient``
+instance that closed its connections to MongoDB. Once the ``close()`` method
+is called on the ``MongoClient``, any further operation calls on that instance
+throw this exception.
+
+To avoid this exception, do not call operations on ``MongoClient`` instance
+after any code that calls ``close()`` on it.
+
+.. tip::
+
+   The code that closes the ``MongoClient`` instance might be difficult to
+   locate in certain cases. To locate potential sources of this exception,
+   search for the following cases:
+
+   - Calls to ``close()`` on a ``MongoClient`` instance
+   - Operation calls on a ``MongoClient`` instance that are outside the scope
+     of the try-with-resources statement in which the ``MongoClient`` is
+     declared
+
+   If your application uses a framework to manage the ``MongoClient``
+   such as Spring Boot, check the documentation of the framework to locate the
+   best practices for managing the connection behavior.
+
+   To learn more about accessing MongoDB from Spring Boot, see
+   `Spring Boot and MongoDB <https://www.mongodb.com/compatibility/spring-boot>`__.

source/connection/mongoclientsettings.txt

@@ -591,4 +591,4 @@ to MongoDB:
    :end-before: end SslSettings
    :language: java
    :emphasize-lines: 3-4
-   :dedent:
+   :dedent:

source/data-formats/document-data-format-bson.txt

@@ -89,3 +89,53 @@ for that tool:
 If you are not using one of the preceding tools, you can include it in
 your project by downloading the JAR file directly from the
 `sonatype repository <https://repo1.maven.org/maven2/org/mongodb/bson/>`__.
+
+Frequently Asked Questions
+--------------------------
+
+This section answers questions that may arise about
+the BSON data format.
+
+How do I prevent the "IllegalArgumentException: Invalid BSON field name" error?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Your application might throw this exception if you pass an incorrectly formatted
+document to an operation and you are using a driver version v4.7 or earlier.
+
+.. note::
+
+   In driver versions v4.8 and later, this error message was replaced by one
+   that includes more specific details on what was incorrectly formatted.
+
+For example, the driver throws this error when you call an update operation
+and incorrectly omit the update operator as shown in the following code
+example:
+
+.. code-block:: java
+   :emphasize-lines: 4
+   :copyable: false
+
+   // incorrectly formatted update document
+   collection.updateOne(
+       new Document().append("name", "fizz"),
+       new Document().append("name", "buzz")
+   );
+
+To avoid this error, use the builder class for the appropriate operation.
+The driver offers builder classes to create syntactically correct BSON for
+MongoDB operations. The prior example can be correctly expressed using
+the builder classes as shown in the following code example:
+
+.. code-block:: java
+   :emphasize-lines: 7
+   :copyable: false
+
+   // Builder class imports
+   import static com.mongodb.client.model.Filters.*;
+   import static com.mongodb.client.model.Updates.*;
+
+   // ...
+
+   collection.updateOne(eq("name", "fizz"), set("name", "buzz"));
+
+To learn more about the available builders classes, see the :ref:`<java-builders>` documentation.

source/data-formats/pojo-customization.txt

@@ -749,7 +749,7 @@ see the following API Documentation:
 
 For more information about generics and type parameters, see the
 `Java language guide on Invoking and Instantiating a Generic Type <https://docs.oracle.com/javase/tutorial/java/generics/types.html#instantiation>`__.
-
+ 
 Enum Type Support
 ^^^^^^^^^^^^^^^^^
 
@@ -760,3 +760,90 @@ codec registry.
 
 See the documentation on the :ref:`default codec registry <codecs-default-codec-registry>`
 For more information about how to register the codecs it includes.
+
+Frequently Asked Questions
+--------------------------
+
+This section answers questions that may arise when defining
+data conversion logic.
+
+Do I have to specify an ID field value myself?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+No, the ``PojoCodecProvider`` automatically generates an ObjectId.
+
+Can the ID field be a compound key?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Yes. For an example of this, see `our implementation <https://github.com/niccottrell/mongo-java-tests/blob/master/src/test/PojoCompoundIdTest.java>`_
+
+Can I use polymorphism in a POJO accessor?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Yes, by using a discriminator. For more information, see the :ref:`Discriminators
+<pojo-discriminators>` section.
+
+Can I control serialization of ``LocalDate``?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Yes, the 3.7 Java driver adds native support for ``JSR-310 Instant``,
+``LocalDate`` & ``LocalDateTime``.
+
+Can I serialize a ``java.util.Date`` as a string in format **yyyy-mm-dd**?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Yes, you can build your own codec for this class and add it to the registry.
+
+Add the codec to the first in the list of providers, before the default codec
+registry and before the ``PojoCodecProvider``:
+
+.. literalinclude:: /includes/faq/code-snippets/FaqExample.java
+   :language: java
+   :emphasize-lines: 3
+   :dedent:
+   :start-after: start myDateAsStringCodec
+   :end-before: end myDateAsStringCodec
+
+Can I make POJOs read/write directly to the field and not use the getters/setters at all?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can configure the ``PojoCodecProvider`` to use the
+``SET_PRIVATE_FIELDS_CONVENTION``, which sets a private field through
+reflection if no public setter is available.
+
+Can I mix private, protected, and public setters and getters?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+No. The native POJO codec assumes that getters/setters have the same
+modifiers for each field.
+
+For example, the following methods throws an exception during encoding:
+
+.. code-block:: java
+
+   private String getField();
+   public String setField(String x);
+
+How do I fix: "org.bson.codecs.configuration.CodecConfigurationException: Can't find a codec for class X."?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This exception means you must register a codec for the class since
+there is none at the moment.
+
+How do I specify the collection name for a particular POJO class? Is there an annotation?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+There is no annotation. We recommend adding a static string in your class as shown:
+
+.. code-block:: java
+
+   public class Person {
+      public static final String COLLECTION_NAME = "people";
+   }
+
+The following snippet specifies the collection name for a particular
+POJO class:
+
+.. code-block:: java
+
+   database.getCollection(Person.COLLECTION_NAME, Person.class);