Class RedisSocketConfiguration
java.lang.Object
org.springframework.data.redis.connection.RedisSocketConfiguration
- All Implemented Interfaces:
RedisConfiguration
,RedisConfiguration.DomainSocketConfiguration
,RedisConfiguration.WithAuthentication
,RedisConfiguration.WithDatabaseIndex
,RedisConfiguration.WithDomainSocket
,RedisConfiguration.WithPassword
public class RedisSocketConfiguration
extends Object
implements RedisConfiguration, RedisConfiguration.DomainSocketConfiguration
Configuration class used for setting up
RedisConnection
via RedisConnectionFactory
connecting to
single Redis using a local unix domain socket.- Since:
- 2.1
- Author:
- Mark Paluch, Christoph Strobl
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisConfiguration
RedisConfiguration.ClusterConfiguration, RedisConfiguration.DomainSocketConfiguration, RedisConfiguration.SentinelConfiguration, RedisConfiguration.StaticMasterReplicaConfiguration, RedisConfiguration.WithAuthentication, RedisConfiguration.WithDatabaseIndex, RedisConfiguration.WithDomainSocket, RedisConfiguration.WithHostAndPort, RedisConfiguration.WithPassword
-
Constructor Summary
ConstructorDescriptionCreate a new defaultRedisSocketConfiguration
.RedisSocketConfiguration
(String socket) Create a newRedisSocketConfiguration
givensocket
. -
Method Summary
Modifier and TypeMethodDescriptionboolean
int
Get the database index to use.Get the RedisPassword to use when connecting.Get the domain socket.Get the username to use when connecting.int
hashCode()
void
setDatabase
(int index) Set the database index to use.void
setPassword
(RedisPassword password) Create and set aRedisPassword
for givenString
.void
Set the socket.void
setUsername
(String username) Create and set a username with the givenString
.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.data.redis.connection.RedisConfiguration
getDatabaseOrElse, getPasswordOrElse
Methods inherited from interface org.springframework.data.redis.connection.RedisConfiguration.WithAuthentication
setPassword, setPassword
-
Constructor Details
-
RedisSocketConfiguration
public RedisSocketConfiguration()Create a new defaultRedisSocketConfiguration
. -
RedisSocketConfiguration
Create a newRedisSocketConfiguration
givensocket
.- Parameters:
socket
- must not be null or empty.
-
-
Method Details
-
getSocket
Description copied from interface:RedisConfiguration.WithDomainSocket
Get the domain socket.- Specified by:
getSocket
in interfaceRedisConfiguration.WithDomainSocket
- Returns:
- path to the Redis socket.
-
setSocket
Description copied from interface:RedisConfiguration.WithDomainSocket
Set the socket.- Specified by:
setSocket
in interfaceRedisConfiguration.WithDomainSocket
- Parameters:
socket
- path to the Redis socket. Must not be null.
-
getDatabase
public int getDatabase()Description copied from interface:RedisConfiguration.WithDatabaseIndex
Get the database index to use.- Specified by:
getDatabase
in interfaceRedisConfiguration.WithDatabaseIndex
- Returns:
zero
by default.
-
setDatabase
public void setDatabase(int index) Description copied from interface:RedisConfiguration.WithDatabaseIndex
Set the database index to use.- Specified by:
setDatabase
in interfaceRedisConfiguration.WithDatabaseIndex
-
setUsername
Description copied from interface:RedisConfiguration.WithAuthentication
Create and set a username with the givenString
. Requires Redis 6 or newer.- Specified by:
setUsername
in interfaceRedisConfiguration.WithAuthentication
- Parameters:
username
- the username.
-
getUsername
Description copied from interface:RedisConfiguration.WithAuthentication
Get the username to use when connecting.- Specified by:
getUsername
in interfaceRedisConfiguration.WithAuthentication
- Returns:
- null if none set.
-
getPassword
Description copied from interface:RedisConfiguration.WithAuthentication
Get the RedisPassword to use when connecting.- Specified by:
getPassword
in interfaceRedisConfiguration.WithAuthentication
- Returns:
RedisPassword.none()
if none set.
-
setPassword
Description copied from interface:RedisConfiguration.WithAuthentication
Create and set aRedisPassword
for givenString
.- Specified by:
setPassword
in interfaceRedisConfiguration.WithAuthentication
- Parameters:
password
- must not be null useRedisPassword.none()
instead.
-
equals
-
hashCode
public int hashCode()
-