Documentation review for WL#14206 and WL#14274.

pranav0073 · Dec 16, 2020 · 7ddf0a7 · 7ddf0a7
1 parent aac65ff
commit 7ddf0a7
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/src/main/core-impl/java/com/mysql/cj/sasl/ScramSha1SaslClient.java b/src/main/core-impl/java/com/mysql/cj/sasl/ScramSha1SaslClient.java
@@ -47,8 +47,9 @@
 /**
  * A {@link SaslClient} implementation for SCRAM-SHA-1, as specified in <a href="https://tools.ietf.org/html/rfc5802">RFC 5802</a>.
  * 
- * The IANA-registered mechanism name was renamed to "MYSQLCJ-SCRAM-SHA-1" in order to avoid future conflicts with an officially supported one. If/when there is
- * a Java supported SCRAM-SHA-1 then it will have to be thoroughly tested and this code can be obsoleted.
+ * The IANA-registered mechanism was renamed to "MYSQLCJ-SCRAM-SHA-1" in order to avoid future conflicts with an officially supported implementation.
+ * When there is a Java-supported implementation for SCRAM-SHA-1, it will have to be thoroughly tested with Connector/J and if that works, this code can be
+ * obsoleted.
  */
 public class ScramSha1SaslClient extends ScramShaSaslClient {
     public static final String IANA_MECHANISM_NAME = "SCRAM-SHA-1";

diff --git a/src/main/core-impl/java/com/mysql/cj/sasl/ScramSha256SaslClient.java b/src/main/core-impl/java/com/mysql/cj/sasl/ScramSha256SaslClient.java
@@ -48,8 +48,9 @@
  * A {@link SaslClient} implementation for SCRAM-SHA-256, as specified in <a href="https://tools.ietf.org/html/rfc5802">RFC 5802</a> and <a
  * href="https://tools.ietf.org/html/rfc7677">RFC 7677</a>.
  * 
- * The IANA-registered mechanism name was renamed to "MYSQLCJ-SCRAM-SHA-256" in order to avoid future conflicts with an officially supported one. If/when there
- * is a Java supported SCRAM-SHA-256 then it will have to be thoroughly tested and this code can be obsoleted.
+ * The IANA-registered mechanism was renamed to "MYSQLCJ-SCRAM-SHA-256" in order to avoid future conflicts with an officially supported implementation.
+ * When there is a Java-supported implementation for SCRAM-SHA-256, it will have to be thoroughly tested with Connector/J and if that works, this code can be
+ * obsoleted.
  */
 public class ScramSha256SaslClient extends ScramShaSaslClient {
     public static final String IANA_MECHANISM_NAME = "SCRAM-SHA-256";

diff --git a/src/main/resources/com/mysql/cj/LocalizedErrorMessages.properties b/src/main/resources/com/mysql/cj/LocalizedErrorMessages.properties
@@ -827,7 +827,7 @@ ConnectionProperties.initialTimeout=If autoReconnect is enabled, the initial tim
 ConnectionProperties.interactiveClient=Set the CLIENT_INTERACTIVE flag, which tells MySQL to timeout connections based on INTERACTIVE_TIMEOUT instead of WAIT_TIMEOUT
 ConnectionProperties.jdbcCompliantTruncation=Should the driver throw java.sql.DataTruncation exceptions when data is truncated as is required by the JDBC specification when connected to a server that supports warnings (MySQL 4.1.0 and newer)? This property has no effect if the server sql-mode includes STRICT_TRANS_TABLES.
 ConnectionProperties.largeRowSizeThreshold=What size result set row should the JDBC driver consider "large", and thus use a more memory-efficient way of representing the row internally?
-ConnectionProperties.ldapServerHostname=When using MySQL''s LDAP pluggable authentication with GSSAPI/Kerberos authentication method, allows setting the LDAP Service Principal hostname as configured in the Kerberos KDC. If this property is not set, Connector/J takes the system property ''java.security.krb5.kdc'' and extracts the hostname (short name) from its value and uses it. If none are set, then the connection fails with an exception.
+ConnectionProperties.ldapServerHostname=When using MySQL''s LDAP pluggable authentication with GSSAPI/Kerberos authentication method, allows setting the LDAP service principal hostname as configured in the Kerberos KDC. If this property is not set, Connector/J takes the system property ''java.security.krb5.kdc'' and extracts the hostname (short name) from its value and uses it. If neither is set, the connection fails with an exception.
 ConnectionProperties.loadBalanceStrategy=If using a load-balanced connection to connect to SQL nodes in a MySQL Cluster/NDB configuration (by using the URL prefix "jdbc:mysql:loadbalance://"), which load balancing algorithm should the driver use: (1) "random" - the driver will pick a random host for each request. This tends to work better than round-robin, as the randomness will somewhat account for spreading loads where requests vary in response time, while round-robin can sometimes lead to overloaded nodes if there are variations in response times across the workload. (2) "bestResponseTime" - the driver will route the request to the host that had the best response time for the previous transaction. (3) "serverAffinity" - the driver initially attempts to enforce server affinity while still respecting and benefiting from the fault tolerance aspects of the load-balancing implementation. The server affinity ordered list is provided using the property ''serverAffinityOrder''. If none of the servers listed in the affinity list is responsive, the driver then refers to the "random" strategy to proceed with choosing the next server.
 ConnectionProperties.serverAffinityOrder=A comma separated list containing the host/port pairs that are to be used in load-balancing "serverAffinity" strategy. Only the sub-set of the hosts enumerated in the main hosts section in this URL will be used and they must be identical in case and type, i.e., can''t use an IP address in one place and the corresponding host name in the other. 
 ConnectionProperties.loadBalanceBlocklistTimeout=Time in milliseconds between checks of servers which are unavailable, by controlling how long a server lives in the global blocklist.