org.springframework.data.redis.connection

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

Constructors

Constructor and Description
RedisStandaloneConfiguration() Create a new default RedisStandaloneConfiguration.
RedisStandaloneConfiguration(String hostName) Create a new RedisStandaloneConfiguration given hostName.
RedisStandaloneConfiguration(String hostName, int port) Create a new RedisStandaloneConfiguration given hostName and port.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getDatabase() Get the database index to use.
String	getHostName()
RedisPassword	getPassword() Get the RedisPassword to use when connecting.
int	getPort() Get the Redis server port.
String	getUsername() 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 hostname
void	setPassword(RedisPassword password) Create and set a RedisPassword for given String.
void	setPort(int port) Set the Redis server port.
void	setUsername(String username) Create and set a username with the given String.

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, getDatabaseOrElse, getHostOrElse, getPasswordOrElse, getPasswordOrElse, getPortOrElse, getUsernameOrElse, isAuthenticationAware, isClusterConfiguration, isDatabaseIndexAware, isDomainSocketConfiguration, isHostAndPortAware, isSentinelConfiguration, isStaticMasterReplicaConfiguration

Methods inherited from interface org.springframework.data.redis.connection.RedisConfiguration.WithAuthentication

setPassword, setPassword

Constructor Detail

RedisStandaloneConfiguration

public RedisStandaloneConfiguration()

Create a new default RedisStandaloneConfiguration.

RedisStandaloneConfiguration

public RedisStandaloneConfiguration(String hostName)

Create a new RedisStandaloneConfiguration given hostName.

Parameters:

hostName - must not be null or empty.

RedisStandaloneConfiguration

public RedisStandaloneConfiguration(String hostName,
                                    int port)

Create a new RedisStandaloneConfiguration given hostName and port.

Parameters:

hostName - must not be null or empty.

port - a valid TCP port (1-65535).

Method Detail

getHostName

public String getHostName()

Specified by:

getHostName in interface RedisConfiguration.WithHostAndPort

Returns:

never null.

getPort

public int getPort()

Description copied from interface: RedisConfiguration.WithHostAndPort

Get the Redis server port.

Specified by:

getPort in interface RedisConfiguration.WithHostAndPort

Returns:

setHostName

public void setHostName(String hostName)

Description copied from interface: RedisConfiguration.WithHostAndPort

Set the Redis server hostname

Specified by:

setHostName in interface RedisConfiguration.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 interface RedisConfiguration.WithHostAndPort

getDatabase

public int getDatabase()

Description copied from interface: RedisConfiguration.WithDatabaseIndex

Get the database index to use.

Specified by:

getDatabase in interface RedisConfiguration.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 interface RedisConfiguration.WithDatabaseIndex

setUsername

public void setUsername(@Nullable
                        String username)

Description copied from interface: RedisConfiguration.WithAuthentication

Create and set a username with the given String. Requires Redis 6 or newer.

Specified by:

setUsername in interface RedisConfiguration.WithAuthentication

Parameters:

username - the username.

getUsername

@Nullable
public String getUsername()

Description copied from interface: RedisConfiguration.WithAuthentication

Get the username to use when connecting.

Specified by:

getUsername in interface RedisConfiguration.WithAuthentication

Returns:

null if none set.

getPassword

public RedisPassword getPassword()

Description copied from interface: RedisConfiguration.WithAuthentication

Get the RedisPassword to use when connecting.

Specified by:

getPassword in interface RedisConfiguration.WithAuthentication

Returns:

RedisPassword.none() if none set.

setPassword

public void setPassword(RedisPassword password)

Description copied from interface: RedisConfiguration.WithAuthentication

Create and set a RedisPassword for given String.

Specified by:

setPassword in interface RedisConfiguration.WithAuthentication

Parameters:

password - must not be null use RedisPassword.none() instead.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object