Merge pull request #568 from mcmorisi/DOCSP-42372-username-password

mcmorisi · mcmorisi · commit bfec287a4f2b · 2024-08-12T15:50:53.000-04:00
DOCSP-42372: Change username and password placeholders
diff --git a/source/connection-troubleshooting.txt b/source/connection-troubleshooting.txt
@@ -88,7 +88,7 @@ Connection Troubleshooting
       .. code-block:: java
          :copyable: false
 
-         String uri = "mongodb://<username>:<password>@<hostname>:<port>/?authSource=users&authMechanism=SCRAM-SHA-256";
+         String uri = "mongodb://<db_username>:<db_password>@<hostname>:<port>/?authSource=users&authMechanism=SCRAM-SHA-256";
          MongoClient mongoClient = MongoClients.create(uri);
 
    .. replacement:: credentials-provider-alternative-method-description
@@ -100,7 +100,7 @@ Connection Troubleshooting
       .. code-block:: java
          :copyable: false
 
-         MongoCredential credential = MongoCredential.createScramSha256Credential("<username>", "<authenticationDb>", "<password>");
+         MongoCredential credential = MongoCredential.createScramSha256Credential("<db_username>", "<authenticationDb>", "<dbpassword>");
 
 
    .. replacement:: authentication-guide-reference
@@ -117,7 +117,7 @@ Connection Troubleshooting
       .. code-block:: java
          :copyable: false
 
-         MongoClient mongoClient = MongoClients.create("mongodb://<username>:<password>@<hostname>:<port>/?authSource=users");
+         MongoClient mongoClient = MongoClients.create("mongodb://<db_username>:<db_password>@<hostname>:<port>/?authSource=users");
 
    .. replacement:: dns-resolution-anchor
 
diff --git a/source/fundamentals/auth.txt b/source/fundamentals/auth.txt
@@ -95,7 +95,7 @@ mechanism:
 
       .. code-block:: java
 
-         MongoClient mongoClient = MongoClients.create("mongodb://<username>:<password>@<hostname>:<port>/?authSource=<authenticationDb>");
+         MongoClient mongoClient = MongoClients.create("mongodb://<db_username>:<db_password>@<hostname>:<port>/?authSource=<authenticationDb>");
 
    .. tab::
       :tabid: MongoCredential
@@ -157,7 +157,7 @@ mechanism:
 
       .. code-block:: java
 
-         MongoClient mongoClient = MongoClients.create("mongodb://<username>:<password>@<hostname>:<port>/?authSource=<authenticationDb>&authMechanism=SCRAM-SHA-256");
+         MongoClient mongoClient = MongoClients.create("mongodb://<db_username>:<db_password>@<hostname>:<port>/?authSource=<authenticationDb>&authMechanism=SCRAM-SHA-256");
 
    .. tab::
       :tabid: MongoCredential
@@ -215,7 +215,7 @@ mechanism:
 
       .. code-block:: java
 
-         MongoClient mongoClient = MongoClients.create("mongodb://<username>:<password>@<hostname>:<port>/?authSource=<authenticationDb>&authMechanism=SCRAM-SHA-1");
+         MongoClient mongoClient = MongoClients.create("mongodb://<db_username>:<db_password>@<hostname>:<port>/?authSource=<authenticationDb>&authMechanism=SCRAM-SHA-1");
 
    .. tab::
       :tabid: MongoCredential
diff --git a/source/fundamentals/connection/mongoclientsettings.txt b/source/fundamentals/connection/mongoclientsettings.txt
@@ -187,7 +187,7 @@ This example demonstrates specifying a ``ConnectionString``:
       :emphasize-lines: 2,4
 
       MongoClient mongoClient = MongoClients.create(
-         MongoClientSettings.builder().applyConnectionString(new ConnectionString("mongodb+srv://<username>:<password>@<hostname>:<port>/<auth db>?connectTimeoutMS=2000"))
+         MongoClientSettings.builder().applyConnectionString(new ConnectionString("mongodb+srv://<db_username>:<db_password>@<hostname>:<port>/<auth db>?connectTimeoutMS=2000"))
             .applyToSocketSettings(builder ->
             builder.connectTimeout(5L, SECONDS))
             .build());
diff --git a/source/fundamentals/connection/network-compression.txt b/source/fundamentals/connection/network-compression.txt
@@ -53,7 +53,7 @@ connection string using ``ConnectionString`` or by calling the method in the
 
       .. code-block:: java
 
-         ConnectionString connectionString = new ConnectionString("mongodb+srv://<user>:<password>@<cluster-url>/?compressors=snappy,zlib,zstd");
+         ConnectionString connectionString = new ConnectionString("mongodb+srv://<db_username>:<db_password>@<cluster-url>/?compressors=snappy,zlib,zstd");
          MongoClient mongoClient = MongoClients.create(connectionString);
 
       Specify compression algorithms using the following strings:
diff --git a/source/fundamentals/connection/tls.txt b/source/fundamentals/connection/tls.txt
@@ -67,7 +67,7 @@ using a method in the ``MongoClientSettings.Builder`` class.
 
       .. code-block:: java
 
-         MongoClient mongoClient = MongoClients.create("mongodb+srv://<user>:<password>@<cluster-url>?tls=true");
+         MongoClient mongoClient = MongoClients.create("mongodb+srv://<db_username>:<db_password>@<cluster-url>?tls=true");
 
    .. tab:: MongoClientSettings
       :tabid: mongoclientsettings
diff --git a/source/fundamentals/enterprise-auth.txt b/source/fundamentals/enterprise-auth.txt
@@ -92,7 +92,7 @@ mechanism:
 
       .. code-block:: java
 
-         MongoClient mongoClient = MongoClients.create("<username>@<hostname>:<port>/?authSource=$external&authMechanism=GSSAPI");
+         MongoClient mongoClient = MongoClients.create("<db_username>@<hostname>:<port>/?authSource=$external&authMechanism=GSSAPI");
 
    .. tab::
       :tabid: MongoCredential
@@ -151,7 +151,7 @@ You might need to specify one or more of the following additional
 
       .. code-block:: java
 
-         MongoClient mongoClient = MongoClients.create("<username>@<hostname>:<port>/?authSource=$external&authMechanism=GSSAPI&authMechanismProperties=SERVICE_NAME:myService");
+         MongoClient mongoClient = MongoClients.create("<db_username>@<hostname>:<port>/?authSource=$external&authMechanism=GSSAPI&authMechanismProperties=SERVICE_NAME:myService");
 
    .. tab::
       :tabid: MongoCredential
@@ -277,7 +277,7 @@ mechanism:
 
       .. code-block:: java
 
-         MongoClient mongoClient = MongoClients.create("<username>:<password>@<hostname>:<port>/?authSource=$external&authMechanism=PLAIN");
+         MongoClient mongoClient = MongoClients.create("<db_username>:<db_password>@<hostname>:<port>/?authSource=$external&authMechanism=PLAIN");
 
    .. tab::
       :tabid: MongoCredential
@@ -340,21 +340,21 @@ see the corresponding syntax.
       .. code-block:: java
          
          MongoClient mongoClient = MongoClients.create(
-            "mongodb://<username>@<hostname>:<port>/?" + 
+            "mongodb://<db_username>@<hostname>:<port>/?" + 
             "?authMechanism=MONGODB-OIDC" +
             "&authMechanismProperties=ENVIRONMENT:azure,TOKEN_RESOURCE:<percent-encoded audience>");
 
    .. tab:: MongoCredential
       :tabid: mongodb-azure-mongo-credential
 
-      Replace the ``<username>`` placeholder with the client ID or application ID of the
+      Replace the ``<db_username>`` placeholder with the client ID or application ID of the
       Azure managed identity or enterprise application. Replace the ``<audience>``
       placeholder with the value of the
       ``audience`` server parameter configured on your MongoDB deployment.
       
       .. code-block:: java
 
-         MongoCredential credential = MongoCredential.createOidcCredential("<username>")
+         MongoCredential credential = MongoCredential.createOidcCredential("<db_username>")
             .withMechanismProperty("ENVIRONMENT", "azure")  
             .withMechanismProperty("TOKEN_RESOURCE", "<audience>");
    
diff --git a/source/fundamentals/indexes.txt b/source/fundamentals/indexes.txt
@@ -595,4 +595,4 @@ For prior versions of MongoDB, pass "*" as a parameter to your call to
 For more information about the methods in this section, see the following API Documentation:
 
 - `dropIndex() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#dropIndex(java.lang.String)>`__
-- `dropIndexes() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#dropIndexes()>`__
+- `dropIndexes() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#dropIndexes()>`__
diff --git a/source/includes/faq/code-snippets/FaqExample.java b/source/includes/faq/code-snippets/FaqExample.java
@@ -34,7 +34,7 @@ public static void main(String[] args) {
                 fromProviders(pojoCodecProvider));
         // end myDateAsStringCodec
 
-        String uri = "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
+        String uri = "mongodb+srv://<db_username>:<db_password>@<cluster-url>?retryWrites=true&w=majority";
 
         try (MongoClient mongoClient = MongoClients.create(uri)) {
 
diff --git a/source/includes/fundamentals/code-snippets/auth-credentials-default.rst b/source/includes/fundamentals/code-snippets/auth-credentials-default.rst
@@ -1,6 +1,6 @@
 .. code-block:: java
 
-   MongoCredential credential = MongoCredential.createCredential("<username>", "<authenticationDb>", "<password>");
+   MongoCredential credential = MongoCredential.createCredential("<db_username>", "<authenticationDb>", "<db_password>");
 
    MongoClient mongoClient = MongoClients.create(
        MongoClientSettings.builder()
diff --git a/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-properties.rst b/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-properties.rst
@@ -1,5 +1,5 @@
 .. code-block:: java
 
-   MongoCredential credential = MongoCredential.createGSSAPICredential(<username>);
+   MongoCredential credential = MongoCredential.createGSSAPICredential(<db_username>);
    credential = credential.withMechanismProperty(MongoCredential.SERVICE_NAME_KEY, "myService");
 
diff --git a/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-subject-key.rst b/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-subject-key.rst
@@ -4,6 +4,6 @@
    loginContext.login();
    Subject subject = loginContext.getSubject();
 
-   MongoCredential credential = MongoCredential.createGSSAPICredential(<username>);
+   MongoCredential credential = MongoCredential.createGSSAPICredential(<db_username>);
    credential = credential.withMechanismProperty(MongoCredential.JAVA_SUBJECT_KEY, subject);
 
diff --git a/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-ticket-cache.rst b/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-ticket-cache.rst
@@ -3,7 +3,7 @@
    /* all MongoClient instances sharing this instance of KerberosSubjectProvider
    will share a Kerberos ticket cache */
    String myLoginContext = "myContext";
-   MongoCredential credential = MongoCredential.createGSSAPICredential(<username>);
+   MongoCredential credential = MongoCredential.createGSSAPICredential(<db_username>);
    /* login context defaults to "com.sun.security.jgss.krb5.initiate"
    if unspecified in KerberosSubjectProvider */
    credential = credential.withMechanismProperty(MongoCredential.JAVA_SUBJECT_PROVIDER_KEY,
diff --git a/source/includes/fundamentals/code-snippets/auth-credentials-gssapi.rst b/source/includes/fundamentals/code-snippets/auth-credentials-gssapi.rst
@@ -1,6 +1,6 @@
 .. code-block:: java
 
-   MongoCredential credential = MongoCredential.createGSSAPICredential(<username>);
+   MongoCredential credential = MongoCredential.createGSSAPICredential(<db_username>);
 
    MongoClient mongoClient = MongoClients.create(
        MongoClientSettings.builder()
diff --git a/source/includes/fundamentals/code-snippets/auth-credentials-ldap.rst b/source/includes/fundamentals/code-snippets/auth-credentials-ldap.rst
@@ -1,6 +1,6 @@
 .. code-block:: java
 
-   MongoCredential credential = MongoCredential.createPlainCredential(<username>, "$external", <password>);
+   MongoCredential credential = MongoCredential.createPlainCredential(<db_username>, "$external", <db_password>);
 
    MongoClient mongoClient = MongoClients.create(
        MongoClientSettings.builder()
diff --git a/source/includes/fundamentals/code-snippets/auth-credentials-sha1.rst b/source/includes/fundamentals/code-snippets/auth-credentials-sha1.rst
@@ -1,6 +1,6 @@
 .. code-block:: java
 
-   MongoCredential credential = MongoCredential.createScramSha1Credential("<username>", "<authenticationDb>", "<password>");
+   MongoCredential credential = MongoCredential.createScramSha1Credential("<db_username>", "<authenticationDb>", "<db_password>");
 
    MongoClient mongoClient = MongoClients.create(
        MongoClientSettings.builder()
diff --git a/source/includes/fundamentals/code-snippets/auth-credentials-sha256.rst b/source/includes/fundamentals/code-snippets/auth-credentials-sha256.rst
@@ -1,6 +1,6 @@
 .. code-block:: java
 
-   MongoCredential credential = MongoCredential.createScramSha256Credential("<username>", "<authenticationDb>", "<password>");
+   MongoCredential credential = MongoCredential.createScramSha256Credential("<db_username>", "<authenticationDb>", "<db_password>");
 
    MongoClient mongoClient = MongoClients.create(
        MongoClientSettings.builder()
diff --git a/source/includes/quick-reference/QuickReferenceSnippets.java b/source/includes/quick-reference/QuickReferenceSnippets.java
@@ -171,7 +171,7 @@ private static void searchTextExample(MongoCollection<Document> coll) {
     
     public static void main(String[] args) {
         // Replace the uri string with your MongoDB deployment's connection string
-        String uri = "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
+        String uri = "mongodb+srv://<db_username>:<db_password>@<cluster-url>?retryWrites=true&w=majority";
         try (MongoClient mongoClient = MongoClients.create(uri)) {
 
             MongoDatabase database = mongoClient.getDatabase("movies");
diff --git a/source/quick-start.txt b/source/quick-start.txt
@@ -113,7 +113,7 @@ Create a new file ``QuickStartPojoExample.java`` in the same package
 directory as your ``Movie`` file in your project. Use the following sample
 code to run a query on your sample dataset in MongoDB Atlas, replacing the
 value of the ``uri`` variable with your MongoDB Atlas connection string.
-Ensure you replace the "<password>" section of the connection string with
+Ensure you replace the "<db_password>" section of the connection string with
 the password you created for your user that has **atlasAdmin** permissions:
 
 .. literalinclude:: /includes/quick-start/code-snippets/QuickStartPojoExample.java
diff --git a/source/usage-examples.txt b/source/usage-examples.txt
@@ -66,7 +66,7 @@ to learn how to allow connections to your instance of Atlas and to find the
 :manual:`connection string </reference/connection-string/>` you use to replace the
 ``uri`` variable in usage examples. If your instance uses
 :manual:`SCRAM authentication </core/security-scram/>`, you can replace
-``<user>`` with your username, ``<password>`` with your password, and
+``<db_username>`` with your database username, ``<db_password>`` with your database password, and
 ``<cluster-url>`` with the IP address or URL of your instance.
 
 For more information about connecting to your MongoDB instance, see our
