Package org.springframework.data.redis.connection.jedis

Class JedisConnectionFactory

java.lang.Object

org.springframework.data.redis.connection.jedis.JedisConnectionFactory

All Implemented Interfaces:

DisposableBean, InitializingBean, Lifecycle, Phased, SmartLifecycle, PersistenceExceptionTranslator, RedisConnectionFactory

public class JedisConnectionFactory
extends Object
implements RedisConnectionFactory, InitializingBean, DisposableBean, SmartLifecycle

Connection factory creating Jedis based connections.

JedisConnectionFactory should be configured using an environmental configuration and the client configuration. Jedis supports the following environmental configurations:

• RedisStandaloneConfiguration
• RedisSentinelConfiguration
• RedisClusterConfiguration

This connection factory implements InitializingBean and SmartLifecycle for flexible lifecycle control. It must be initialized and started before you can obtain a connection. Initialization starts this bean early by default. You can Lifecycle.stop() and restart this connection factory if needed. Disabling early startup leaves lifecycle management to the container refresh if auto-startup is enabled.

Note that JedisConnection and its clustered variant are not Thread-safe and instances should not be shared across threads. Refer to the Jedis documentation for guidance on configuring Jedis in a multithreaded environment.

Author:

Costin Leau, Thomas Darimont, Christoph Strobl, Mark Paluch, Fu Jian, Ajith Kumar

See Also:

• JedisClientConfiguration
• Jedis

Field Summary

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
JedisConnectionFactory()	Constructs a new JedisConnectionFactory instance with default settings (default connection pooling).
JedisConnectionFactory(RedisClusterConfiguration clusterConfiguration)	Constructs a new JedisConnectionFactory instance using the given RedisClusterConfiguration applied to create a JedisCluster.
JedisConnectionFactory(RedisClusterConfiguration clusterConfiguration, JedisClientConfiguration clientConfiguration)	Constructs a new JedisConnectionFactory instance using the given RedisClusterConfiguration and JedisClientConfiguration.
JedisConnectionFactory(RedisClusterConfiguration clusterConfiguration, redis.clients.jedis.JedisPoolConfig poolConfig)	Constructs a new JedisConnectionFactory instance using the given RedisClusterConfiguration applied to create a JedisCluster.
JedisConnectionFactory(RedisSentinelConfiguration sentinelConfiguration)	Constructs a new JedisConnectionFactory instance using the given JedisPoolConfig applied to JedisSentinelPool.
JedisConnectionFactory(RedisSentinelConfiguration sentinelConfiguration, JedisClientConfiguration clientConfiguration)	Constructs a new JedisConnectionFactory instance using the given RedisSentinelConfiguration and JedisClientConfiguration.
JedisConnectionFactory(RedisSentinelConfiguration sentinelConfiguration, redis.clients.jedis.JedisPoolConfig poolConfig)	Constructs a new JedisConnectionFactory instance using the given JedisPoolConfig applied to JedisSentinelPool.
JedisConnectionFactory(RedisStandaloneConfiguration standaloneConfiguration)	Constructs a new JedisConnectionFactory instance using the given RedisStandaloneConfiguration.
JedisConnectionFactory(RedisStandaloneConfiguration standaloneConfiguration, JedisClientConfiguration clientConfiguration)	Constructs a new JedisConnectionFactory instance using the given RedisStandaloneConfiguration and JedisClientConfiguration.
JedisConnectionFactory(redis.clients.jedis.JedisPoolConfig poolConfig)	Constructs a new JedisConnectionFactory instance using the given pool configuration.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected redis.clients.jedis.JedisCluster	createCluster(RedisClusterConfiguration clusterConfig, org.apache.commons.pool2.impl.GenericObjectPoolConfig<redis.clients.jedis.Connection> poolConfig)	Creates JedisCluster for given RedisClusterConfiguration and GenericObjectPoolConfig.
protected redis.clients.jedis.util.Pool<redis.clients.jedis.Jedis>	createRedisPool()	Creates JedisPool.
protected redis.clients.jedis.util.Pool<redis.clients.jedis.Jedis>	createRedisSentinelPool(RedisSentinelConfiguration config)	Creates JedisSentinelPool.
protected ClusterTopologyProvider	createTopologyProvider(redis.clients.jedis.JedisCluster cluster)	Template method to create a ClusterTopologyProvider given JedisCluster.
void	destroy()
protected redis.clients.jedis.Jedis	fetchJedisConnector()	Returns a Jedis instance to be used as a Redis connection.
JedisClientConfiguration	getClientConfiguration()
String	getClientName()	Returns the client name.
RedisClusterConfiguration	getClusterConfiguration()
RedisClusterConnection	getClusterConnection()	Returns a suitable connection for interacting with Redis Cluster.
RedisConnection	getConnection()	Returns a suitable connection for interacting with Redis.
boolean	getConvertPipelineAndTxResults()	Specifies if pipelined results should be converted to the expected data type.
int	getDatabase()	Returns the index of the database.
String	getHostName()	Returns the Redis hostname.
String	getPassword()	Returns the password used for authenticating with the Redis server.
int	getPhase()
<T> org.apache.commons.pool2.impl.GenericObjectPoolConfig<T>	getPoolConfig()	Returns the poolConfig.
int	getPort()	Returns the port used to connect to the Redis instance.
RedisSentinelConfiguration	getSentinelConfiguration()
RedisSentinelConnection	getSentinelConnection()	Returns a suitable connection for interacting with Redis Sentinel.
RedisStandaloneConfiguration	getStandaloneConfiguration()
int	getTimeout()	Returns the timeout.
boolean	getUsePool()	Indicates the use of a connection pool.
boolean	isAutoStartup()
boolean	isEarlyStartup()
boolean	isRedisClusterAware()
boolean	isRedisSentinelAware()
boolean	isRunning()
boolean	isUseSsl()	Returns whether to use SSL.
protected JedisClusterConnection	postProcessConnection(JedisClusterConnection connection)	Post process a newly retrieved connection.
protected JedisConnection	postProcessConnection(JedisConnection connection)	Post process a newly retrieved connection.
void	setAutoStartup(boolean autoStartup)	Configure if this Lifecycle connection factory should get started automatically by the container at the time that the containing ApplicationContext gets refreshed.
void	setClientName(String clientName)	Deprecated. since 2.0, configure the client name using JedisClientConfiguration.
void	setConvertPipelineAndTxResults(boolean convertPipelineAndTxResults)	Specifies if pipelined results should be converted to the expected data type.
void	setDatabase(int index)	Deprecated. since 2.0, configure the database index using RedisStandaloneConfiguration or RedisSentinelConfiguration.
void	setEarlyStartup(boolean earlyStartup)	Configure if this InitializingBean's component Lifecycle should get started early by afterPropertiesSet() at the time that the bean is initialized.
void	setExecutor(AsyncTaskExecutor executor)	Configures the executor used to execute commands asynchronously across the cluster.
void	setHostName(String hostName)	Deprecated. since 2.0, configure the hostname using RedisStandaloneConfiguration.
void	setPassword(String password)	Deprecated. since 2.0, configure the password using RedisStandaloneConfiguration, RedisSentinelConfiguration or RedisClusterConfiguration.
void	setPhase(int phase)	Specify the lifecycle phase for pausing and resuming this executor.
void	setPoolConfig(redis.clients.jedis.JedisPoolConfig poolConfig)	Deprecated. since 2.0, configure JedisPoolConfig using JedisClientConfiguration.
void	setPort(int port)	Deprecated. since 2.0, configure the port using RedisStandaloneConfiguration.
void	setTimeout(int timeout)	Deprecated. since 2.0, configure the timeout using JedisClientConfiguration.
void	setUsePool(boolean usePool)	Deprecated. since 2.0, configure pooling usage with JedisClientConfiguration.
void	setUseSsl(boolean useSsl)	Deprecated. since 2.0, configure the SSL usage with JedisClientConfiguration.
void	start()
void	stop()
DataAccessException	translateExceptionIfPossible(RuntimeException ex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.context.SmartLifecycle

stop

Constructor Details

JedisConnectionFactory

public JedisConnectionFactory()

Constructs a new JedisConnectionFactory instance with default settings (default connection pooling).

JedisConnectionFactory

public JedisConnectionFactory(redis.clients.jedis.JedisPoolConfig poolConfig)

Constructs a new JedisConnectionFactory instance using the given pool configuration.

Parameters:

poolConfig - pool configuration

JedisConnectionFactory

public JedisConnectionFactory(RedisClusterConfiguration clusterConfiguration)

Constructs a new JedisConnectionFactory instance using the given RedisClusterConfiguration applied to create a JedisCluster.

Parameters:

clusterConfiguration - must not be null.

Since:

1.7

JedisConnectionFactory

public JedisConnectionFactory(RedisClusterConfiguration clusterConfiguration,
 JedisClientConfiguration clientConfiguration)

Constructs a new JedisConnectionFactory instance using the given RedisClusterConfiguration and JedisClientConfiguration.

Parameters:

clusterConfiguration - must not be null.

clientConfiguration - must not be null.

Since:

2.0

JedisConnectionFactory

public JedisConnectionFactory(RedisClusterConfiguration clusterConfiguration,
 redis.clients.jedis.JedisPoolConfig poolConfig)

Constructs a new JedisConnectionFactory instance using the given RedisClusterConfiguration applied to create a JedisCluster.

Parameters:

clusterConfiguration - must not be null.

Since:

1.7

JedisConnectionFactory

public JedisConnectionFactory(RedisSentinelConfiguration sentinelConfiguration)

Constructs a new JedisConnectionFactory instance using the given JedisPoolConfig applied to JedisSentinelPool.

Parameters:

sentinelConfiguration - must not be null.

Since:

1.4

JedisConnectionFactory

public JedisConnectionFactory(RedisSentinelConfiguration sentinelConfiguration,
 JedisClientConfiguration clientConfiguration)

Constructs a new JedisConnectionFactory instance using the given RedisSentinelConfiguration and JedisClientConfiguration.

Parameters:

sentinelConfiguration - must not be null.

clientConfiguration - must not be null.

Since:

2.0

JedisConnectionFactory

public JedisConnectionFactory(RedisSentinelConfiguration sentinelConfiguration,
 @Nullable
 redis.clients.jedis.JedisPoolConfig poolConfig)

Constructs a new JedisConnectionFactory instance using the given JedisPoolConfig applied to JedisSentinelPool.

Parameters:

sentinelConfiguration - the sentinel configuration to use.

poolConfig - pool configuration. Defaulted to new instance if null.

Since:

1.4

JedisConnectionFactory

public JedisConnectionFactory(RedisStandaloneConfiguration standaloneConfiguration)

Constructs a new JedisConnectionFactory instance using the given RedisStandaloneConfiguration.

Parameters:

standaloneConfiguration - must not be null.

Since:

2.0

JedisConnectionFactory

public JedisConnectionFactory(RedisStandaloneConfiguration standaloneConfiguration,
 JedisClientConfiguration clientConfiguration)

Constructs a new JedisConnectionFactory instance using the given RedisStandaloneConfiguration and JedisClientConfiguration.

Parameters:

standaloneConfiguration - must not be null.

clientConfiguration - must not be null.

Since:

2.0

Method Details

setExecutor

public void setExecutor(AsyncTaskExecutor executor)

Configures the executor used to execute commands asynchronously across the cluster.

Parameters:

executor - executor used to execute commands asynchronously across the cluster.

Since:

3.2

getHostName

public String getHostName()

Returns the Redis hostname.

Returns:

the hostName.

setHostName

@Deprecated
public void setHostName(String hostName)

Deprecated.

since 2.0, configure the hostname using RedisStandaloneConfiguration.

Sets the Redis hostname.

Parameters:

hostName - the hostname to set.

isUseSsl

public boolean isUseSsl()

Returns whether to use SSL.

Returns:

use of SSL.

Since:

1.8

setUseSsl

@Deprecated
public void setUseSsl(boolean useSsl)

Deprecated.

since 2.0, configure the SSL usage with JedisClientConfiguration.

Sets whether to use SSL.

Parameters:

useSsl - true to use SSL.

Throws:

IllegalStateException - if JedisClientConfiguration is immutable.

Since:

1.8

getPassword

@Nullable
public String getPassword()

Returns the password used for authenticating with the Redis server.

Returns:

password for authentication.

setPassword

@Deprecated
public void setPassword(String password)

Deprecated.

since 2.0, configure the password using RedisStandaloneConfiguration, RedisSentinelConfiguration or RedisClusterConfiguration.

Sets the password used for authenticating with the Redis server.

Parameters:

password - the password to set.

getPort

public int getPort()

Returns the port used to connect to the Redis instance.

Returns:

the Redis port.

setPort

@Deprecated
public void setPort(int port)

Deprecated.

since 2.0, configure the port using RedisStandaloneConfiguration.

Sets the port used to connect to the Redis instance.

Parameters:

port - the Redis port.

getTimeout

public int getTimeout()

Returns the timeout.

Returns:

the timeout.

setTimeout

@Deprecated
public void setTimeout(int timeout)

Deprecated.

since 2.0, configure the timeout using JedisClientConfiguration.

Sets the timeout.

Parameters:

timeout - the timeout to set.

Throws:

IllegalStateException - if JedisClientConfiguration is immutable.

getUsePool

public boolean getUsePool()

Indicates the use of a connection pool.

Applies only to single node Redis. Sentinel and Cluster modes use always connection-pooling regardless of the pooling setting.

Returns:

the use of connection pooling.

setUsePool

@Deprecated
public void setUsePool(boolean usePool)

Deprecated.

since 2.0, configure pooling usage with JedisClientConfiguration.

Turns on or off the use of connection pooling.

Parameters:

usePool - the usePool to set.

Throws:

IllegalStateException - if JedisClientConfiguration is immutable.

IllegalStateException - if configured to use sentinel and usePool is false as Jedis requires pooling for Redis sentinel use.

getPoolConfig

@Nullable
public <T>
org.apache.commons.pool2.impl.GenericObjectPoolConfig<T> getPoolConfig()

Returns the poolConfig.

Returns:

the poolConfig

setPoolConfig

@Deprecated
public void setPoolConfig(redis.clients.jedis.JedisPoolConfig poolConfig)

Deprecated.

since 2.0, configure JedisPoolConfig using JedisClientConfiguration.

Sets the pool configuration for this factory.

Parameters:

poolConfig - the poolConfig to set.

Throws:

IllegalStateException - if JedisClientConfiguration is immutable.

getDatabase

public int getDatabase()

Returns the index of the database.

Returns:

the database index.

setDatabase

@Deprecated
public void setDatabase(int index)

Deprecated.

since 2.0, configure the database index using RedisStandaloneConfiguration or RedisSentinelConfiguration.

Sets the index of the database used by this connection factory. Default is 0.

Parameters:

index - database index.

getClientName

@Nullable
public String getClientName()

Returns the client name.

Returns:

the client name.

Since:

1.8

setClientName

@Deprecated
public void setClientName(String clientName)

Deprecated.

since 2.0, configure the client name using JedisClientConfiguration.

Sets the client name used by this connection factory. Defaults to none which does not set a client name.

Parameters:

clientName - the client name.

Throws:

IllegalStateException - if JedisClientConfiguration is immutable.

Since:

1.8

getClientConfiguration

public JedisClientConfiguration getClientConfiguration()

Returns:

the JedisClientConfiguration.

Since:

2.0

getStandaloneConfiguration

@Nullable
public RedisStandaloneConfiguration getStandaloneConfiguration()

Returns:

the RedisStandaloneConfiguration.

Since:

2.0

getSentinelConfiguration

@Nullable
public RedisSentinelConfiguration getSentinelConfiguration()

Returns:

the RedisStandaloneConfiguration, may be null.

Since:

2.0

getClusterConfiguration

@Nullable
public RedisClusterConfiguration getClusterConfiguration()

Returns:

the RedisClusterConfiguration, may be null.

Since:

2.0

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

setPhase

public void setPhase(int phase)

Specify the lifecycle phase for pausing and resuming this executor. The default is 0.

Since:

3.2

See Also:

• SmartLifecycle.getPhase()

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

Since:

3.3

setAutoStartup

public void setAutoStartup(boolean autoStartup)

Configure if this Lifecycle connection factory should get started automatically by the container at the time that the containing ApplicationContext gets refreshed.

This connection factory defaults to early auto-startup during afterPropertiesSet() and can potentially create Redis connections early on in the lifecycle. See setEarlyStartup(boolean) for delaying connection creation to the ApplicationContext refresh if auto-startup is enabled.

Parameters:

autoStartup - true to automatically start() the connection factory; false otherwise.

Since:

3.3

See Also:

• setEarlyStartup(boolean)
• start()

isEarlyStartup

public boolean isEarlyStartup()

Returns:

whether to start() the component during afterPropertiesSet().

Since:

3.3

setEarlyStartup

public void setEarlyStartup(boolean earlyStartup)

Configure if this InitializingBean's component Lifecycle should get started early by afterPropertiesSet() at the time that the bean is initialized. The component defaults to auto-startup.

This method is related to auto-startup and can be used to delay Redis client startup until the ApplicationContext refresh. Disabling early startup does not disable auto-startup.

Parameters:

earlyStartup - true to early start() the component; false otherwise.

Since:

3.3

See Also:

• setAutoStartup(boolean)

getConvertPipelineAndTxResults

public boolean getConvertPipelineAndTxResults()

Specifies if pipelined results should be converted to the expected data type. If false, results of JedisConnection.closePipeline() and JedisConnection.exec() will be of the type returned by the Jedis driver.

Specified by:

getConvertPipelineAndTxResults in interface RedisConnectionFactory

Returns:

true to convert pipeline and transaction results; false otherwise.

setConvertPipelineAndTxResults

public void setConvertPipelineAndTxResults(boolean convertPipelineAndTxResults)

Specifies if pipelined results should be converted to the expected data type. If false, results of JedisConnection.closePipeline() and JedisConnection.exec() will be of the type returned by the Jedis driver.

Parameters:

convertPipelineAndTxResults - true to convert pipeline and transaction results; false otherwise.

isRedisSentinelAware

public boolean isRedisSentinelAware()

Returns:

true when RedisSentinelConfiguration is present.

Since:

1.4

isRedisClusterAware

public boolean isRedisClusterAware()

Returns:

true when RedisClusterConfiguration is present.

Since:

2.0

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

createRedisSentinelPool

protected redis.clients.jedis.util.Pool<redis.clients.jedis.Jedis> createRedisSentinelPool(RedisSentinelConfiguration config)

Creates JedisSentinelPool.

Parameters:

config - the actual RedisSentinelConfiguration. Never null.

Returns:

the Pool to use. Never null.

Since:

1.4

createRedisPool

protected redis.clients.jedis.util.Pool<redis.clients.jedis.Jedis> createRedisPool()

Creates JedisPool.

Returns:

the Pool to use. Never null.

Since:

1.4

createTopologyProvider

protected ClusterTopologyProvider createTopologyProvider(redis.clients.jedis.JedisCluster cluster)

Template method to create a ClusterTopologyProvider given JedisCluster. Creates JedisClusterConnection.JedisClusterTopologyProvider by default.

Parameters:

cluster - the JedisCluster, must not be null.

Returns:

the ClusterTopologyProvider.

See Also:

• JedisClusterConnection.JedisClusterTopologyProvider

createCluster

protected redis.clients.jedis.JedisCluster createCluster(RedisClusterConfiguration clusterConfig,
 org.apache.commons.pool2.impl.GenericObjectPoolConfig<redis.clients.jedis.Connection> poolConfig)

Creates JedisCluster for given RedisClusterConfiguration and GenericObjectPoolConfig.

Parameters:

clusterConfig - must not be null.

poolConfig - can be null.

Returns:

the actual JedisCluster.

Since:

1.7

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

getConnection

public RedisConnection getConnection()

Description copied from interface: RedisConnectionFactory

Returns a suitable connection for interacting with Redis.

Specified by:

getConnection in interface RedisConnectionFactory

Returns:

connection for interacting with Redis.

fetchJedisConnector

protected redis.clients.jedis.Jedis fetchJedisConnector()

Returns a Jedis instance to be used as a Redis connection. The instance can be newly created or retrieved from a pool.

Returns:

Jedis instance ready for wrapping into a RedisConnection.

postProcessConnection

protected JedisConnection postProcessConnection(JedisConnection connection)

Post process a newly retrieved connection. Useful for decorating or executing initialization commands on a new connection. This implementation simply returns the connection.

Parameters:

connection - the jedis connection.

Returns:

processed connection

getClusterConnection

public RedisClusterConnection getClusterConnection()

Description copied from interface: RedisConnectionFactory

Returns a suitable connection for interacting with Redis Cluster.

Specified by:

getClusterConnection in interface RedisConnectionFactory

Returns:

a connection for interacting with Redis Cluster.

postProcessConnection

protected JedisClusterConnection postProcessConnection(JedisClusterConnection connection)

Post process a newly retrieved connection. Useful for decorating or executing initialization commands on a new connection. This implementation simply returns the connection.

Parameters:

connection - the jedis connection.

Returns:

processed connection.

Since:

3.2

translateExceptionIfPossible

public DataAccessException translateExceptionIfPossible(RuntimeException ex)

Specified by:

translateExceptionIfPossible in interface PersistenceExceptionTranslator

getSentinelConnection

public RedisSentinelConnection getSentinelConnection()

Description copied from interface: RedisConnectionFactory

Returns a suitable connection for interacting with Redis Sentinel.

Specified by:

getSentinelConnection in interface RedisConnectionFactory

Returns:

a connection for interacting with Redis Sentinel.