Replaced deprecated JedisShardInfo with RedisStandaloneConfiguration

Author: sbglasius

src/docs/asciidoc/configuration.adoc

@@ -29,6 +29,10 @@ All configuration values are prefixed with `grails.cache.redis`
 |`integer`
 |Server port to connect to
 
+|`username`
+|(not set)
+|`String`
+|Server username (only if required)
 
 |`password`
 |(not set)
@@ -74,3 +78,12 @@ All configuration values are prefixed with `grails.cache.redis`
 |===
 
 *Note:* There is currently no way of setting each cache configuration individually. 
+
+=== Advanced configuration
+
+The standard configuration will use `org.springframework.data.redis.connection.RedisStandaloneConfiguration` and will connect to a single server. This configuration is instanticated as a the `grailsCacheRedisConfiguration` bean. If more advance configuration is needed, consider using `org.springframework.data.redis.connection.RedisClusterConfiguration` or `org.springframework.data.redis.connection.RedisSentinelConfiguration` instead.
+
+This should be archiveable by adding:
+
+----
+grailsCacheRedisConfiguration(RedisClusterConfiguration,)

src/docs/asciidoc/index.adoc

@@ -18,13 +18,13 @@ include::introduction/changeLog.adoc[]
 
 include::usage.adoc[]
 
-
 [[configuration]]
 == Configuration
+
 include::configuration.adoc[]
 
 [[dsl]]
-=== Cache DSL
+== Cache DSL
 
 include::usage/dsl.adoc[]
 

src/docs/asciidoc/introduction/changeLog.adoc

@@ -7,4 +7,6 @@
 === Version 6.0.0 - June 2, 2025
 
 * Upgraded to Grails 6.2.x
+* Removed `JedisShardInfo` in plugin descriptor in favor of `RedisStandaloneConfiguration`
+* Updated documentation
 

src/main/groovy/grails/plugin/cache/redis/CacheRedisGrailsPlugin.groovy

@@ -6,10 +6,10 @@ import grails.plugins.Plugin
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 import org.springframework.data.redis.cache.CacheKeyPrefix
+import org.springframework.data.redis.connection.RedisStandaloneConfiguration
 import org.springframework.data.redis.connection.jedis.JedisConnectionFactory
 import org.springframework.data.redis.core.RedisTemplate
 import redis.clients.jedis.JedisPoolConfig
-import redis.clients.jedis.JedisShardInfo
 import redis.clients.jedis.Protocol
 
 /**
@@ -62,29 +62,28 @@ class CacheRedisGrailsPlugin extends Plugin {
             String configHostName = config.getProperty('grails.cache.redis.hostName', 'localhost')
             int configPort = config.getProperty('grails.cache.redis.port', Integer, Protocol.DEFAULT_PORT)
             int configTimeout = config.getProperty('grails.cache.redis.timeout', Integer, Protocol.DEFAULT_TIMEOUT)
+            String configUsername = config.getProperty('grails.cache.redis.username')
             String configPassword = config.getProperty('grails.cache.redis.password')
             Long ttlInSeconds = config.getProperty('grails.cache.redis.ttl', Long, GrailsRedisCache.NEVER_EXPIRE)
             boolean isUsePrefix = config.getProperty('grails.cache.redis.usePrefix', Boolean, false)
 
             String keySerializerBean = config.getProperty('grails.cache.redis.keySerializer')
             String hashKeySerializerBean = config.getProperty('grails.cache.redis.hashKeySerializer')
 
-            grailsCacheJedisPoolConfig(JedisPoolConfig)
+            grailsCacheRedisPoolConfig(JedisPoolConfig)
 
-            grailsCacheJedisShardInfo(JedisShardInfo, configHostName, configPort) {
-                password = configPassword
-                connectionTimeout = configTimeout
+            grailsCacheRedisConfiguration(RedisStandaloneConfiguration, configHostName, configPort) {
+                username = configUsername
+                if(configPassword) {
+                    password = configPassword
+                }
+                database = configDatabase
             }
 
-            grailsCacheJedisConnectionFactory(JedisConnectionFactory) {
+            grailsCacheJedisConnectionFactory(JedisConnectionFactory, ref('grailsCacheRedisConfiguration')) {
                 usePool = configUsePool
-                database = configDatabase
-                hostName = configHostName
-                port = configPort
                 timeout = configTimeout
-                password = configPassword
-                poolConfig = ref('grailsCacheJedisPoolConfig')
-                shardInfo = ref('grailsCacheJedisShardInfo')
+                poolConfig = ref('grailsCacheRedisPoolConfig')
             }
 
             grailsRedisCacheSerializer(GrailsSerializer)
@@ -118,10 +117,10 @@ class CacheRedisGrailsPlugin extends Plugin {
             String delimiter = config.getProperty('grails.cache.redis.cachePrefixDelimiter', CacheKeyPrefix.SEPARATOR)
             String prefix = config.getProperty('grails.cache.redis.cachePrefix', '')
 
-            redisCachePrefix(DelimiterCacheKeyPrefix, delimiter, prefix)
+            grailsRedisCachePrefix(DelimiterCacheKeyPrefix, delimiter, prefix)
 
             grailsCacheManager(GrailsRedisCacheManager, ref('grailsCacheRedisTemplate')) {
-                cachePrefix = ref('redisCachePrefix', false)
+                cachePrefix = ref('grailsRedisCachePrefix', false)
                 timeToLive = ttlInSeconds
                 usePrefix = isUsePrefix
             }