From 59990334ee42619ec247a8ad306658edaf348db4 Mon Sep 17 00:00:00 2001
From: Nathan Xu <nathan.xu@mongodb.com>
Date: Fri, 8 Nov 2024 21:38:44 -0500
Subject: [PATCH] update MongoConnectionProvider as per code review comments

---
 .../jdbc/MongoConnectionProvider.java         | 32 ++++++++++++++++---
 1 file changed, 27 insertions(+), 5 deletions(-)

diff --git a/src/main/java/com/mongodb/hibernate/jdbc/MongoConnectionProvider.java b/src/main/java/com/mongodb/hibernate/jdbc/MongoConnectionProvider.java
index 90b9c5dc..cff93c51 100644
--- a/src/main/java/com/mongodb/hibernate/jdbc/MongoConnectionProvider.java
+++ b/src/main/java/com/mongodb/hibernate/jdbc/MongoConnectionProvider.java
@@ -16,7 +16,9 @@
 
 package com.mongodb.hibernate.jdbc;
 
-import static org.hibernate.cfg.JdbcSettings.*;
+import static org.hibernate.cfg.JdbcSettings.JAKARTA_JDBC_PASSWORD;
+import static org.hibernate.cfg.JdbcSettings.JAKARTA_JDBC_URL;
+import static org.hibernate.cfg.JdbcSettings.JAKARTA_JDBC_USER;
 
 import com.mongodb.ConnectionString;
 import com.mongodb.MongoClientSettings;
@@ -42,15 +44,35 @@
  * <p>{@link MongoConnectionProvider} uses the following Hibernate properties:
  *
  * <ul>
- *   <li>{@linkplain org.hibernate.cfg.JdbcSettings#JAKARTA_JDBC_URL jakarta.persistence.jdbc.url}
- *   <li>{@linkplain org.hibernate.cfg.JdbcSettings#JAKARTA_JDBC_USER jakarta.persistence.jdbc.user}
- *   <li>{@linkplain org.hibernate.cfg.JdbcSettings#JAKARTA_JDBC_PASSWORD jakarta.persistence.jdbc.password}
+ *   <li>{@linkplain JdbcSettings#JAKARTA_JDBC_URL jakarta.persistence.jdbc.url}
+ *   <li>{@linkplain JdbcSettings#JAKARTA_JDBC_USER jakarta.persistence.jdbc.user}
+ *   <li>{@linkplain JdbcSettings#JAKARTA_JDBC_PASSWORD jakarta.persistence.jdbc.password}
  * </ul>
  *
- * <p>{@value org.hibernate.cfg.JdbcSettings#JAKARTA_JDBC_URL} property is mandatory and it maps to MongoDB's <a
+ * <p>{@value JdbcSettings#JAKARTA_JDBC_URL} property is mandatory and it maps to MongoDB's <a
  * href="https://www.mongodb.com/docs/manual/reference/connection-string/">connection string</a>, in which database name
  * must be provided to align with JDBC URL's convention. The other two JDBC properties are optional.
  *
+ * <table>
+ *     <tr><th>Property</th><th>Description</th><th>Required</th></tr>
+ *     <tr>
+ *         <td>{@linkplain JdbcSettings#JAKARTA_JDBC_URL jakarta.persistence.jdbc.url}</td>
+ *         <td>MongoDB
+ *         <a href="https://www.mongodb.com/docs/manual/reference/connection-string/">connection string</a></td>
+ *         <td>✓</td>
+ *     </tr>
+ *     <tr>
+ *         <td>{@linkplain JdbcSettings#JAKARTA_JDBC_USER jakarta.persistence.jdbc.user}</td>
+ *         <td>{@code userName} for {@link com.mongodb.MongoCredential#createCredential(String, String, char[])}</td>
+ *         <td></td>
+ *     </tr>
+ *     <tr>
+ *         <td>{@linkplain JdbcSettings#JAKARTA_JDBC_PASSWORD jakarta.persistence.jdbc.password}</td>
+ *         <td>{@code password} for {@link com.mongodb.MongoCredential#createCredential(String, String, char[])}</td>
+ *         <td></td>
+ *     </tr>
+ * </table>
+ *
  * @see ConnectionProvider
  * @see JdbcSettings#JAKARTA_JDBC_URL
  * @see JdbcSettings#JAKARTA_JDBC_USER