Class RedisStandaloneConfiguration
java.lang.Object
org.springframework.data.redis.connection.RedisStandaloneConfiguration
- All Implemented Interfaces:
RedisConfiguration
,RedisConfiguration.WithAuthentication
,RedisConfiguration.WithDatabaseIndex
,RedisConfiguration.WithHostAndPort
,RedisConfiguration.WithPassword
public class RedisStandaloneConfiguration
extends Object
implements RedisConfiguration, RedisConfiguration.WithHostAndPort, RedisConfiguration.WithPassword, RedisConfiguration.WithDatabaseIndex
Configuration class used for setting up
RedisConnection
via RedisConnectionFactory
using connecting
to a single node Redis installation.- Since:
- 2.0
- 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 defaultRedisStandaloneConfiguration
.RedisStandaloneConfiguration
(String hostName) Create a newRedisStandaloneConfiguration
givenhostName
.RedisStandaloneConfiguration
(String hostName, int port) -
Method Summary
Modifier and TypeMethodDescriptionboolean
int
Get the database index to use.Get the RedisPassword to use when connecting.int
getPort()
Get the Redis server port.Get the username to use when connecting.int
hashCode()
void
setDatabase
(int index) Set the database index to use.void
setHostName
(String hostName) Set the Redis server hostnamevoid
setPassword
(RedisPassword password) Create and set aRedisPassword
for givenString
.void
setPort
(int port) Set the Redis server port.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
-
RedisStandaloneConfiguration
public RedisStandaloneConfiguration()Create a new defaultRedisStandaloneConfiguration
. -
RedisStandaloneConfiguration
Create a newRedisStandaloneConfiguration
givenhostName
.- Parameters:
hostName
- must not be null or empty.
-
RedisStandaloneConfiguration
- Parameters:
hostName
- must not be null or empty.port
- a valid TCP port (1-65535).
-
-
Method Details
-
getHostName
- Specified by:
getHostName
in interfaceRedisConfiguration.WithHostAndPort
- Returns:
- never null.
-
getPort
public int getPort()Description copied from interface:RedisConfiguration.WithHostAndPort
Get the Redis server port.- Specified by:
getPort
in interfaceRedisConfiguration.WithHostAndPort
- Returns:
-
setHostName
Description copied from interface:RedisConfiguration.WithHostAndPort
Set the Redis server hostname- Specified by:
setHostName
in interfaceRedisConfiguration.WithHostAndPort
- Parameters:
hostName
- must not be null.
-
setPort
public void setPort(int port) Description copied from interface:RedisConfiguration.WithHostAndPort
Set the Redis server port.- Specified by:
setPort
in interfaceRedisConfiguration.WithHostAndPort
-
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()
-