Polishing #1774

Document implication of the credential retrieval duration on connection creation timeouts.
redis · Aug 24, 2022 · ea4e1eb · ea4e1eb
1 parent a60560e
commit ea4e1eb
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/src/main/java/io/lettuce/core/RedisCredentials.java b/src/main/java/io/lettuce/core/RedisCredentials.java
@@ -65,7 +65,7 @@ public interface RedisCredentials {
      * @return the static {@link RedisCredentials} object from {@code username} and {@code password}
      */
     static RedisCredentials just(String username, CharSequence password) {
-        return new StaticRedisCredentials(username, password == null ? new char[0] : LettuceStrings.toCharArray(password));
+        return new StaticRedisCredentials(username, password == null ? null : LettuceStrings.toCharArray(password));
     }
 
     /**

diff --git a/src/main/java/io/lettuce/core/RedisCredentialsProvider.java b/src/main/java/io/lettuce/core/RedisCredentialsProvider.java
@@ -23,6 +23,9 @@
 /**
  * Interface for loading {@link RedisCredentials} that are used for authentication. A commonly-used implementation is
  * {@link StaticCredentialsProvider} for a fixed set of credentials.
+ * <p>
+ * Credentials are requested by the driver after connecting to the server. Therefore, credential retrieval is subject to
+ * complete within the connection creation timeout to avoid connection failures.
  *
  * @author Mark Paluch
  * @since 6.2