Package org.springframework.data.redis.connection

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

Constructors

Constructor	Description
RedisSocketConfiguration()	Create a new default RedisSocketConfiguration.
RedisSocketConfiguration(String socket)	Create a new RedisSocketConfiguration given socket.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
int	getDatabase()	Get the database index to use.
RedisPassword	getPassword()	Get the RedisPassword to use when connecting.
String	getSocket()	Get the domain socket.
@Nullable String	getUsername()	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 a RedisPassword for given String.
void	setSocket(String socket)	Set the socket.
void	setUsername(@Nullable 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, getPasswordOrElse

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

setPassword, setPassword

Constructor Details

RedisSocketConfiguration

public RedisSocketConfiguration()

Create a new default RedisSocketConfiguration.

RedisSocketConfiguration

public RedisSocketConfiguration(String socket)

Create a new RedisSocketConfiguration given socket.

Parameters:

socket - must not be null or empty.

Method Details

getSocket

public String getSocket()

Description copied from interface: RedisConfiguration.WithDomainSocket

Get the domain socket.

Specified by:

getSocket in interface RedisConfiguration.WithDomainSocket

Returns:

path to the Redis socket.

setSocket

public void setSocket(String socket)

Description copied from interface: RedisConfiguration.WithDomainSocket

Set the socket.

Specified by:

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

public @Nullable 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(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object