Merge pull request #2559 from uglide/im/fix-jedis-code-examples

Fix Jedis code examples after the final changes to the RedisClient class

Author: andy-stark-redis

content/develop/clients/jedis/amr.md

@@ -159,10 +159,10 @@ JedisClientConfig config = DefaultJedisClientConfig.builder()
         .ssl(true).sslSocketFactory(sslFactory)
         .build();
 
-RedisClient jedis = new RedisClient(
-    new HostAndPort("<host>", <port>),
-    config
-);
+RedisClient jedis = RedisClient.builder()
+        .hostAndPort(new HostAndPort("<host>", <port>))
+        .clientConfig(config)
+        .build();
 
 // Test the connection.
 System.out.println(String.format("Database size is %d", jedis.dbSize()));

content/develop/clients/jedis/connect.md

@@ -36,7 +36,7 @@ import redis.clients.jedis.RedisClient;
 
 public class Main {
     public static void main(String[] args) {
-        RedisClient jedis = new RedisClient("redis://localhost:6379");
+        RedisClient jedis = RedisClient.create("redis://localhost:6379");
 
         // Code that interacts with Redis...
 
@@ -73,7 +73,7 @@ import redis.clients.jedis.HostAndPort;
 Set<HostAndPort> jedisClusterNodes = new HashSet<HostAndPort>();
 jedisClusterNodes.add(new HostAndPort("127.0.0.1", 7379));
 jedisClusterNodes.add(new HostAndPort("127.0.0.1", 7380));
-RedisClusterClient jedis = new RedisClusterClient(jedisClusterNodes);
+RedisClusterClient jedis = RedisClusterClient.create(jedisClusterNodes);
 ```
 
 ### Connect to your production Redis with TLS
@@ -129,7 +129,10 @@ public class Main {
                 .password("secret!") // use your Redis password
                 .build();
 
-        RedisClient jedis = new RedisClient(address, config);
+        RedisClient jedis = RedisClient.builder()
+              .hostAndPort(address)
+              .clientConfig(config)
+              .build();
         jedis.set("foo", "bar");
         System.out.println(jedis.get("foo")); // prints bar
     }
@@ -195,7 +198,11 @@ DefaultJedisClientConfig config = DefaultJedisClientConfig
 
 CacheConfig cacheConfig = CacheConfig.builder().maxSize(1000).build();
 
-RedisClient client = new RedisClient(endpoint, config, cacheConfig);
+RedisClient client = RedisClient.builder()
+        .hostAndPort(endpoint)
+        .clientConfig(config)
+        .cacheConfig(cacheConfig)
+        .build();
 ```
 
 Once you have connected, the usual Redis commands will work transparently
@@ -308,7 +315,7 @@ Here is a simplified connection lifecycle in a pool:
 7. The connection becomes evictable if the number of connections is greater than `minIdle`. 
 8. The connection is ready to be closed.
 
-Pass a `ConnectionPoolConfig` object to the `RedisClient` constructor to configure the pool. 
+Pass a `ConnectionPoolConfig` object to the `RedisClient` builder to configure the pool. 
 (`ConnectionPoolConfig` is a wrapper around `GenericObjectPoolConfig` from [Apache Commons Pool2](https://commons.apache.org/proper/commons-pool/apidocs/org/apache/commons/pool2/impl/GenericObjectPoolConfig.html)).
 
 ```java
@@ -333,7 +340,10 @@ poolConfig.setTestWhileIdle(true);
 // controls the period between checks for idle connections in the pool
 poolConfig.setTimeBetweenEvictionRuns(Duration.ofSeconds(1));
 
-RedisClient jedis = new RedisClient(poolConfig, "localhost", 6379);
+RedisClient jedis = RedisClient.builder()
+        .hostAndPort("localhost", 6379)
+        .poolConfig(poolConfig)
+        .build();
 ```
 
 ### Retrying a command after a connection failure
@@ -347,11 +357,11 @@ shows a retry loop that uses a simple
 strategy:
 
 ```java
-RedisClient jedis = new RedisClient(
-    new HostAndPort("localhost", 6379),
-    clientConfig,
-    poolConfig
-);
+RedisClient jedis = RedisClient.builder()
+        .hostAndPort("localhost", 6379)
+        .poolConfig(poolConfig)
+        .clientConfig(config)
+        .build();
 
 // Set max retry attempts
 final int MAX_RETRIES = 5;

content/develop/clients/jedis/error-handling.md

@@ -67,7 +67,7 @@ Catch specific exceptions that represent unrecoverable errors and re-throw them
 for a full description):
 
 ```java
-try (RedisClient jedis = new RedisClient()) {
+try (RedisClient jedis = RedisClient.create()) {
     String result = jedis.get(key);
 } catch (JedisDataException e) {
     // This indicates a bug in our code
@@ -82,7 +82,7 @@ Catch specific errors and fall back to an alternative, where possible (see
 for a full description):
 
 ```java
-try (RedisClient jedis = new RedisClient()) {
+try (RedisClient jedis = RedisClient.create()) {
     String cachedValue = jedis.get(key);
     if (cachedValue != null) {
         return cachedValue;
@@ -107,7 +107,7 @@ int maxRetries = 3;
 int retryDelay = 100;
 
 for (int attempt = 0; attempt < maxRetries; attempt++) {
-    try (RedisClient jedis = new RedisClient()) {
+    try (RedisClient jedis = RedisClient.create()) {
         return jedis.get(key);
     } catch (JedisConnectionException e) {
         if (attempt < maxRetries - 1) {
@@ -132,7 +132,7 @@ Log non-critical errors and continue (see
 for a full description):
 
 ```java
-try (RedisClient jedis = new RedisClient()) {
+try (RedisClient jedis = RedisClient.create()) {
     jedis.setex(key, 3600, value);
 } catch (JedisConnectionException e) {
     logger.warn("Failed to cache " + key + ", continuing without cache");

content/develop/clients/jedis/produsage.md

@@ -76,20 +76,19 @@ connection or issuing a command, it can end up hanging indefinitely.
 You can prevent this from happening by setting timeouts for socket
 reads and writes and for opening connections.
 
-To set a timeout for a connection, use the `RedisClient` constructor with the `timeout` parameter, or use `JedisClientConfig` with the `socketTimeout` and `connectionTimeout` parameters.
+To set a timeout for a connection, use `JedisClientConfig` with the `socketTimeout` and `connectionTimeout` parameters.
 (The socket timeout is the maximum time allowed for reading or writing data while executing a
 command. The connection timeout is the maximum time allowed for establishing a new connection.)
 
 ```java
-HostAndPort hostAndPort = new HostAndPort("localhost", 6379);
-
-RedisClient jedisWithTimeout = new RedisClient(hostAndPort,
-    DefaultJedisClientConfig.builder()
-        .socketTimeoutMillis(5000)  // set timeout to 5 seconds
-        .connectionTimeoutMillis(5000) // set connection timeout to 5 seconds
-        .build(),
-    poolConfig
-);
+RedisClient jedisWithTimeout = RedisClient.builder()
+    .hostAndPort("localhost", 6379)
+    .clientConfig(
+        DefaultJedisClientConfig.builder()
+            .socketTimeoutMillis(5000)  // set timeout to 5 seconds
+            .connectionTimeoutMillis(5000) // set connection timeout to 5 seconds
+            .build())
+    .build();
 ```
 
 ### Health checks
@@ -100,11 +99,21 @@ every few seconds). You can do this using a simple
 [`PING`]({{< relref "/commands/ping" >}}) command:
 
 ```java
-try (RedisClient jedis = new RedisClient()) {
-  if (! "PONG".equals(jedis.ping())) {
-    // Report problem.
-  }
-}
+ConnectionPoolConfig poolConfig = new ConnectionPoolConfig();
+poolConfig.setMaxTotal(8);
+poolConfig.setMaxIdle(8);
+poolConfig.setMinIdle(0);
+poolConfig.setBlockWhenExhausted(true);
+poolConfig.setMaxWait(Duration.ofSeconds(1));
+
+// Enables sending a PING command once every second while the connection is idle.
+poolConfig.setTestWhileIdle(true);
+poolConfig.setTimeBetweenEvictionRuns(Duration.ofSeconds(1));
+
+RedisClient jedis = RedisClient.builder()
+        .hostAndPort("localhost", 6379)
+        .poolConfig(poolConfig)
+        .build();
 ```
 
 Health checks help to detect problems as soon as possible without