Update reference documentation for 3.10 release

jyemin · jyemin · commit f3abdd3c0add · 2019-02-01T10:07:38.000-05:00
diff --git a/docs/landing/data/releases.toml b/docs/landing/data/releases.toml
@@ -1,8 +1,13 @@
-current = "3.9.0"
+current = "3.10.0"
 
 [[versions]]
-  version = "3.9.0"
+  version = "3.10.0"
   status = "current"
+  docs = "./3.10"
+  api = "./3.10/javadoc"
+
+[[versions]]
+  version = "3.9.0"
   docs = "./3.9"
   api = "./3.9/javadoc"
 
@@ -64,15 +69,15 @@ current = "3.9.0"
 [[drivers]]
   name = "mongodb-driver-sync"
   description = "The synchronous driver, new in 3.7."
-  versions = "3.9.0,3.8.2,3.7.1"
+  versions = "3.10.0,3.9.0,3.8.2,3.7.1"
 
 [[drivers]]
   name = "mongodb-driver-legacy"
   description = "The legacy API for the synchronous driver.<br/>Prefer mongodb-driver-sync for new applications"
-  versions = "3.9.0"
+  versions = "3.10.0,3.9.0"
 
 [[drivers]]
   name = "mongodb-driver-async"
   description = "The callback-based asynchronous driver.<br/>Prefer the Reactive Streams driver for new applications."
-  versions = "3.9.0,3.8.2,3.7.1,3.6.4,3.5.0,3.4.3,3.3.0,3.2.2,3.1.1,3.0.4"
+  versions = "3.10.0,3.9.0,3.8.2,3.7.1,3.6.4,3.5.0,3.4.3,3.3.0,3.2.2,3.1.1,3.0.4"
 
diff --git a/docs/landing/static/versions.json b/docs/landing/static/versions.json
@@ -1,4 +1,5 @@
 [
+  {"version": "3.10"},
   {"version": "3.9"},
   {"version": "3.8"},
   {"version": "3.7"},
diff --git a/docs/reference/config.toml b/docs/reference/config.toml
@@ -1,4 +1,4 @@
-baseURL = "/mongo-java-driver/3.9"
+baseURL = "/mongo-java-driver/3.10"
 languageCode = "en-us"
 title = "MongoDB Java Driver"
 theme = "mongodb"
diff --git a/docs/reference/content/bson/installation-guide.md b/docs/reference/content/bson/installation-guide.md
@@ -22,4 +22,4 @@ This library comprehensively supports [BSON](http://www.bsonspec.org),
 the data storage and network transfer format that MongoDB uses for "documents".
 BSON is short for Binary [JSON](http://json.org/), is a binary-encoded serialization of JSON-like documents.
 
-{{< install artifactId="bson" version="3.9.0" >}}
+{{< install artifactId="bson" version="3.10.0" >}}
diff --git a/docs/reference/content/driver-async/getting-started/installation.md b/docs/reference/content/driver-async/getting-started/installation.md
@@ -14,7 +14,8 @@ title = "Installation"
 The recommended way to get started using one of the drivers in your project is with a dependency management system.
 
 {{% note class="important" %}}
-The MongoDB Async Driver requires either [Netty](http://netty.io/) or Java 7.
+When TLS/SSL is disabled, the MongoDB Async Driver requires either [Netty](http://netty.io/) or Java 7+.
+When TLS/SSL is enabled, the MongoDB Async Driver requires either [Netty](http://netty.io/) or Java 8+. 
 {{% /note %}}
 
 {{< distroPicker >}}
@@ -23,4 +24,4 @@ The MongoDB Async Driver requires either [Netty](http://netty.io/) or Java 7.
 
 The MongoDB Async Driver provides asynchronous API that can leverage either Netty or Java 7's AsynchronousSocketChannel for fast and non-blocking I/O.
 
-{{< install artifactId="mongodb-driver-async" version="3.9.0" dependencies="true">}}
+{{< install artifactId="mongodb-driver-async" version="3.10.0" dependencies="true">}}
diff --git a/docs/reference/content/driver-async/index.md b/docs/reference/content/driver-async/index.md
@@ -9,13 +9,17 @@ title = "MongoDB Async Driver"
 
 ## MongoDB Async Java Driver Documentation
 
-The following guide provides information on using the callback-based MongoDB Async Java Driver 3.9.
+The following guide provides information on using the callback-based MongoDB Async Java Driver 3.10.
 
 {{% note %}}
 The callback-based Async Java Driver has been deprecated in favor of the 
 [MongoDB Reactive Streams Java Driver](http://mongodb.github.io/mongo-java-driver-reactivestreams/).
 {{% /note %}}
 
+### What's New in 3.19
+
+The driver now natively supports TLS/SSL when used with Java 8+.  
+
 ### What's New in 3.9
 
 The callback-based MongoDB Async Java driver has been deprecated in the 3.9 release.  
diff --git a/docs/reference/content/driver-async/tutorials/connect-to-mongodb.md b/docs/reference/content/driver-async/tutorials/connect-to-mongodb.md
@@ -47,7 +47,6 @@ documentation for more information.
     import com.mongodb.ServerAddress;
     import com.mongodb.async.client.*;
     import com.mongodb.connection.ClusterSettings;
-    import com.mongodb.connection.netty.NettyStreamFactoryFactory;
     import java.util.Arrays;
     import static java.util.Arrays.asList;
     ```
@@ -227,16 +226,11 @@ connection string (or `ConnectionString` object) or the `MongoClientSettings` or
 
 {{% note %}}
 Netty is an optional dependency of the asynchronous driver. If your application requires Netty, it must explicitly add a dependency to
-Netty artifacts.  The driver is currently tested against Netty 4.0.
+Netty artifacts.  The driver is currently tested against Netty 4.1.
 {{% /note %}}
 
-By default, the async driver relies on the
-[`AsynchronousSocketChannel`](http://docs.oracle.com/javase/7/docs/api/java/nio/channels/AsynchronousSocketChannel.html) class, introduced
-in Java 7.  However, an application must use [Netty](http://netty.io/) instead if:
-
-* The application is configured to use SSL to communicate with the MongoDB server, or
-
-* The application runs on Java 6.
+In its default configuration, the async driver is supported on Java 7+ when TLS/SSL is disabled, and on Java 8+ when TLS/SSL is enabled.  
+Otherwise, applications must use [Netty](http://netty.io/).
 
 To configure the driver to use Netty,  
 
diff --git a/docs/reference/content/driver/getting-started/installation.md b/docs/reference/content/driver/getting-started/installation.md
@@ -31,7 +31,7 @@ The `mongodb-driver-sync` artifact is a valid OSGi bundle whose symbolic name is
 
 {{% /note %}}
 
-{{< install artifactId="mongodb-driver-sync" version="3.9.0" dependencies="true">}}
+{{< install artifactId="mongodb-driver-sync" version="3.10.0" dependencies="true">}}
 
 ## MongoDB Driver Legacy 
 
@@ -44,7 +44,7 @@ While not deprecated, we recommend that new applications depend on the `mongodb-
 
 {{% /note %}}
 
-{{< install artifactId="mongodb-driver-legacy" version="3.9.0" dependencies="true">}}
+{{< install artifactId="mongodb-driver-legacy" version="3.10.0" dependencies="true">}}
 
 ## MongoDB Driver  
 
@@ -61,7 +61,7 @@ This module is deprecated and will no longer be published in the next major rele
 
 {{% /note %}}
 
-{{< install artifactId="mongodb-driver" version="3.9.0" dependencies="true">}}
+{{< install artifactId="mongodb-driver" version="3.10.0" dependencies="true">}}
 
 
 ## Uber Jar (Legacy)
@@ -81,4 +81,4 @@ This module is deprecated and will no longer be published in the next major rele
 
 {{% /note %}}
 
-{{< install artifactId="mongo-java-driver" version="3.9.0">}}
+{{< install artifactId="mongo-java-driver" version="3.10.0">}}
diff --git a/docs/reference/content/driver/index.md b/docs/reference/content/driver/index.md
@@ -7,12 +7,12 @@ title = "MongoDB Driver"
   pre = "<i class='fa fa-arrows-h'></i>"
 +++
 
-## MongoDB Driver 3.9 Documentation
+## MongoDB Driver 3.10 Documentation
 
 The following guide provides information on using the synchronous
-MongoDB Java Driver 3.9.
+MongoDB Java Driver 3.10.
 
-### What's New in 3.9
+### What's New in 3.10
 
 The [What's New]({{< relref "whats-new.md" >}}) guide explains
 the major new features of the driver.
diff --git a/docs/reference/content/driver/tutorials/jndi.md b/docs/reference/content/driver/tutorials/jndi.md
@@ -28,7 +28,7 @@ The configuration of the `MongoClientFactory` differs depending on the applicati
 
         <module xmlns="urn:jboss:module:1.3" name="org.mongodb">
            <resources>
-               <resource-root path="mongo-java-driver-3.9.0.jar"/>
+               <resource-root path="mongo-java-driver-3.10.0.jar"/>
            </resources>
            <dependencies>
                <module name="javax.api"/>
diff --git a/docs/reference/content/index.md b/docs/reference/content/index.md
@@ -6,12 +6,12 @@ type = "index"
 
 ## MongoDB Java Driver Documentation
 
-Welcome to the MongoDB Java driver documentation hub for the 3.9 driver release.
+Welcome to the MongoDB Java driver documentation hub for the 3.10 driver release.
 
 
-### What's New in 3.9
+### What's New in 3.10
 
-For key new features of 3.9, see [What's New]({{< relref "whats-new.md" >}}).
+For key new features of 3.10, see [What's New]({{< relref "whats-new.md" >}}).
 
 ### Upgrade
 
diff --git a/docs/reference/content/upgrading.md b/docs/reference/content/upgrading.md
@@ -7,23 +7,22 @@ title = "Upgrade Considerations"
   pre = "<i class='fa fa-level-up'></i>"
 +++
 
-## Upgrading from 3.8.x
+## Upgrading from 3.9.x
 
-Numerous classes and methods have been deprecated in the 3.9 release in preparation for a major 4.0 release, in which all deprecated
-API elements except those documented as "not currently scheduled for removal" will be removed. Currently the only API elements _not_ 
-scheduled for removal are:
+In the upcoming 4.0 release, all deprecated API elements except those documented as "not currently scheduled for removal" will be removed. 
+Currently the only API elements _not_ scheduled for removal are:
 
 * [`Mongo.getDB`]({{<apiref "com/mongodb/Mongo.html#getDB-java.lang.String-">}})
 * [`JsonMode.STRICT`]({{<apiref "org/bson/json/JsonMode.html#STRICT">}}) 
 
 To prepare for the 4.0 release, please compile with deprecation warnings enabled and replace all usage of deprecated API elements with their
 recommended replacements.
 
-Also, note that the 3.10 release (which will include support for MongoDB 4.2) will be the last release that is compatible with *Java 6
-or Java 7*.  The 4.0 Java driver will require a minimum of Java 8. The 3.10 release will also be the last non-patch release in the 3.x 
+Also, note that the 3.11 release (which will include support for MongoDB 4.2) will be the last release that is compatible with *Java 6
+or Java 7*.  The 4.0 Java driver will require a minimum of Java 8. The 3.11 release will also be the last non-patch release in the 3.x 
 line. In particular, support for MongoDB 4.4 will only be made available via a 4.x driver release.
 
-The 3.9 release is binary and source compatible with the 3.8 release, except for methods that have been added to interfaces that
+The 3.10 release is binary and source compatible with the 3.9 release, except for methods that have been added to interfaces that
 have been marked as unstable, and changes to classes or interfaces that have been marked as internal or annotated as Beta.
 
 ## Upgrading from 2.x
@@ -38,10 +37,12 @@ The minimum JVM is Java 6. However, specific features require more recent versio
 its reliance on TLS Server Name Indication (SNI).
 - SSL support requires Java 7 or greater in order to perform host name verification, which is enabled by default.  See
 [SSL]({{< relref "driver/tutorials/ssl.md" >}}) for details on how to disable host name verification.
-- The asynchronous API requires Java 7, as by default it relies on
+- The asynchronous API requires Java 7 when TLS/SSL is disabled, as by default it relies on
 [`AsynchronousSocketChannel`](http://docs.oracle.com/javase/7/docs/api/java/nio/channels/AsynchronousSocketChannel.html) for
 its implementation.  See [Async]({{< ref "driver-async/index.md" >}}) for details on configuring the driver to use 
 [Netty](http://netty.io/) instead.
+- The asynchronous API requires Java 8 when TLS/SSL is enabled. See [Async]({{< ref "driver-async/index.md" >}}) for details on configuring 
+the driver to use [Netty](http://netty.io/) instead.
 
 ## Compatibility
 
diff --git a/docs/reference/content/whats-new.md b/docs/reference/content/whats-new.md
@@ -7,6 +7,42 @@ title = "What's New"
   pre = "<i class='fa fa-level-up'></i>"
 +++
 
+## What's new in 3.10
+
+Key new features of the 3.10 Java driver release:
+
+### Native asynchronous TLS/SSL support
+
+Previously, any use of our asynchronous drivers with TLS/SSl required the use of Netty.  In 3.10, the driver supports asynchronous
+TLS/SSL natively, so no third-party dependency is required. To accomplish this, the driver contains code vendored from
+[https://github.com/marianobarrios/tls-channel](https://github.com/marianobarrios/tls-channel).
+
+### Operational improvements
+
+When connecting with the `mongodb+srv` protocol, the driver now polls DNS for changes to the SRV records when connected to a sharded 
+cluster.  See 
+[Polling SRV Records for Mongos Discovery](https://github.com/mongodb/specifications/blob/master/source/polling-srv-records-for-mongos-discovery/polling-srv-records-for-mongos-discovery.rst) 
+for more details.
+
+When retryable writes are enabled, the driver now outputs log messages at DEBUG level when a retryable write is attempted.  See
+[JAVA-2964](https://jira.mongodb.org/browse/JAVA-2964) for more details.
+
+### Codec Improvements
+
+The driver now mutates the id property of a POJO, when inserting a document via a POJO with a `null` id property of type `ObjectId`. See
+[JAVA-2674](https://jira.mongodb.org/browse/JAVA-2674) for more details.
+
+### JNDI
+
+The driver now offers a JNDI `ObjectFactory` implementation for creating instances of `com.mongodb.client.MongoClient`, the interface
+introduced in version 3.7 of the driver. See [JAVA-2883](https://jira.mongodb.org/browse/JAVA-2883) for more details.
+
+### Full list of changes
+
+* [New Features](https://jira.mongodb.org/issues/?jql=project%20%3D%20JAVA%20AND%20issuetype%20%3D%20%22New%20Feature%22%20AND%20fixVersion%20%3D%203.10.0%20ORDER%20BY%20component%20DESC%2C%20key%20ASC)
+* [Improvements](https://jira.mongodb.org/issues/?jql=project%20%3D%20JAVA%20AND%20issuetype%20%3D%20Improvement%20AND%20fixVersion%20%3D%203.10.0%20ORDER%20BY%20component%20DESC%2C%20key%20ASC)
+* [Bug Fixes](https://jira.mongodb.org/issues/?jql=project%20%3D%20JAVA%20AND%20issuetype%20%3D%20Bug%20AND%20fixVersion%20%3D%203.10.0%20ORDER%20BY%20component%20DESC%2C%20key%20ASC)
+
 ## What's new in 3.9
 
 Key new features of the 3.9 Java driver release:
diff --git a/docs/reference/data/mongodb.toml b/docs/reference/data/mongodb.toml
@@ -1,6 +1,6 @@
 # Update versions in config.toml as well
 githubRepo = "mongo-java-driver"
 githubBranch = "master"
-currentVersion = "3.9"
+currentVersion = "3.10"
 highlightTheme = "idea.css"
 apiUrl = "/javadoc"

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`[`
	`2`	`+ {"version": "3.10"},`
`2`	`3`	`{"version": "3.9"},`
`3`	`4`	`{"version": "3.8"},`
`4`	`5`	`{"version": "3.7"},`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-baseURL = "/mongo-java-driver/3.9"`
	`1`	`+baseURL = "/mongo-java-driver/3.10"`
`2`	`2`	`languageCode = "en-us"`
`3`	`3`	`title = "MongoDB Java Driver"`
`4`	`4`	`theme = "mongodb"`