JedisConnectionFactory (Spring Data Redis 2.0.0.M1 API)

java.lang.Object
- org.springframework.data.redis.connection.jedis.JedisConnectionFactory

All Implemented Interfaces:

DisposableBean, InitializingBean, PersistenceExceptionTranslator, RedisConnectionFactory
```
public class JedisConnectionFactory
extends Object
implements InitializingBean, DisposableBean, RedisConnectionFactory
```
Connection factory creating Jedis based connections.

Author:

Costin Leau, Thomas Darimont, Christoph Strobl, Mark Paluch

Constructor Summary

Constructors
Constructor and Description
`JedisConnectionFactory()` Constructs a new `JedisConnectionFactory` instance with default settings (default connection pooling, no shard information).
`JedisConnectionFactory(redis.clients.jedis.JedisPoolConfig poolConfig)` Constructs a new `JedisConnectionFactory` instance using the given pool configuration.
`JedisConnectionFactory(redis.clients.jedis.JedisShardInfo shardInfo)` Constructs a new `JedisConnectionFactory` instance.
`JedisConnectionFactory(RedisClusterConfiguration clusterConfig)` Constructs a new `JedisConnectionFactory` instance using the given `RedisClusterConfiguration` applied to create a `JedisCluster`.
`JedisConnectionFactory(RedisClusterConfiguration clusterConfig, redis.clients.jedis.JedisPoolConfig poolConfig)` Constructs a new `JedisConnectionFactory` instance using the given `RedisClusterConfiguration` applied to create a `JedisCluster`.
`JedisConnectionFactory(RedisSentinelConfiguration sentinelConfig)` Constructs a new `JedisConnectionFactory` instance using the given `JedisPoolConfig` applied to `JedisSentinelPool`.
`JedisConnectionFactory(RedisSentinelConfiguration sentinelConfig, redis.clients.jedis.JedisPoolConfig poolConfig)` Constructs a new `JedisConnectionFactory` instance using the given `JedisPoolConfig` applied to `JedisSentinelPool`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`protected redis.clients.jedis.JedisCluster`	`createCluster(RedisClusterConfiguration clusterConfig, org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig)` Creates `JedisCluster` for given `RedisClusterConfiguration` and `GenericObjectPoolConfig`.
`protected redis.clients.util.Pool<redis.clients.jedis.Jedis>`	`createRedisPool()` Creates `JedisPool`.
`protected redis.clients.util.Pool<redis.clients.jedis.Jedis>`	`createRedisSentinelPool(RedisSentinelConfiguration config)` Creates `JedisSentinelPool`.
`void`	`destroy()`
`protected redis.clients.jedis.Jedis`	`fetchJedisConnector()` Returns a Jedis instance to be used as a Redis connection.
`RedisClusterConnection`	`getClusterConnection()` Provides a suitable connection for interacting with Redis Cluster.
`RedisConnection`	`getConnection()` Provides 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.
`redis.clients.jedis.JedisPoolConfig`	`getPoolConfig()` Returns the poolConfig.
`int`	`getPort()` Returns the port used to connect to the Redis instance.
`ReactiveRedisClusterConnection`	`getReactiveClusterConnection()`
`ReactiveRedisConnection`	`getReactiveConnection()`
`RedisSentinelConnection`	`getSentinelConnection()` Provides a suitable connection for interacting with Redis Sentinel.
`redis.clients.jedis.JedisShardInfo`	`getShardInfo()` Returns the shardInfo.
`int`	`getTimeout()` Returns the timeout.
`boolean`	`getUsePool()` Indicates the use of a connection pool.
`boolean`	`isRedisSentinelAware()`
`boolean`	`isUseSsl()` Returns whether to use SSL.
`protected JedisConnection`	`postProcessConnection(JedisConnection connection)` Post process a newly retrieved connection.
`void`	`setConvertPipelineAndTxResults(boolean convertPipelineAndTxResults)` Specifies if pipelined results should be converted to the expected data type.
`void`	`setDatabase(int index)` Sets the index of the database used by this connection factory.
`void`	`setHostName(String hostName)` Sets the Redis hostName.
`void`	`setPassword(String password)` Sets the password used for authenticating with the Redis server.
`void`	`setPoolConfig(redis.clients.jedis.JedisPoolConfig poolConfig)` Sets the pool configuration for this factory.
`void`	`setPort(int port)` Sets the port used to connect to the Redis instance.
`void`	`setShardInfo(redis.clients.jedis.JedisShardInfo shardInfo)` Sets the shard info for this factory.
`void`	`setTimeout(int timeout)`
`void`	`setUsePool(boolean usePool)` Turns on or off the use of connection pooling.
`void`	`setUseSsl(boolean useSsl)` Sets whether to use SSL.
`DataAccessException`	`translateExceptionIfPossible(RuntimeException ex)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JedisConnectionFactory
```
public JedisConnectionFactory()
```
    Constructs a new JedisConnectionFactory instance with default settings (default connection pooling, no shard information).
  - JedisConnectionFactory
```
public JedisConnectionFactory(redis.clients.jedis.JedisShardInfo shardInfo)
```
    Constructs a new JedisConnectionFactory instance. Will override the other connection parameters passed to the factory.
    
    Parameters:
    
    shardInfo - shard information
  - 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(RedisSentinelConfiguration sentinelConfig)
```
    Constructs a new JedisConnectionFactory instance using the given JedisPoolConfig applied to JedisSentinelPool.
    
    Parameters:
    
    sentinelConfig -
    
    Since:
    
    1.4
  - JedisConnectionFactory
```
public JedisConnectionFactory(RedisSentinelConfiguration sentinelConfig,
                              redis.clients.jedis.JedisPoolConfig poolConfig)
```
    Constructs a new JedisConnectionFactory instance using the given JedisPoolConfig applied to JedisSentinelPool.
    
    Parameters:
    
    sentinelConfig -
    
    poolConfig - pool configuration. Defaulted to new instance if null.
    
    Since:
    
    1.4
  - JedisConnectionFactory
```
public JedisConnectionFactory(RedisClusterConfiguration clusterConfig)
```
    Constructs a new JedisConnectionFactory instance using the given RedisClusterConfiguration applied to create a JedisCluster.
    
    Parameters:
    
    clusterConfig -
    
    Since:
    
    1.7
  - JedisConnectionFactory
```
public JedisConnectionFactory(RedisClusterConfiguration clusterConfig,
                              redis.clients.jedis.JedisPoolConfig poolConfig)
```
    Constructs a new JedisConnectionFactory instance using the given RedisClusterConfiguration applied to create a JedisCluster.
    
    Parameters:
    
    clusterConfig -
    
    Since:
    
    1.7
- Method Detail
  - 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 -
    
    Returns:
    
    processed connection
  - afterPropertiesSet
```
public void afterPropertiesSet()
```
    Specified by:
    
    afterPropertiesSet in interface InitializingBean
  - createRedisSentinelPool
```
protected redis.clients.util.Pool<redis.clients.jedis.Jedis> createRedisSentinelPool(RedisSentinelConfiguration config)
```
    Creates JedisSentinelPool.
    
    Parameters:
    
    config -
    
    Returns:
    
    Since:
    
    1.4
  - createRedisPool
```
protected redis.clients.util.Pool<redis.clients.jedis.Jedis> createRedisPool()
```
    Creates JedisPool.
    
    Returns:
    
    Since:
    
    1.4
  - createCluster
```
protected redis.clients.jedis.JedisCluster createCluster(RedisClusterConfiguration clusterConfig,
                                                         org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig)
```
    Creates JedisCluster for given RedisClusterConfiguration and GenericObjectPoolConfig.
    
    Parameters:
    
    clusterConfig - must not be null.
    
    poolConfig - can be null.
    
    Returns:
    
    Since:
    
    1.7
  - destroy
```
public void destroy()
```
    Specified by:
    
    destroy in interface DisposableBean
  - getConnection
```
public RedisConnection getConnection()
```
    Description copied from interface: RedisConnectionFactory
    
    Provides a suitable connection for interacting with Redis.
    
    Specified by:
    
    getConnection in interface RedisConnectionFactory
    
    Returns:
    
    connection for interacting with Redis.
  - getClusterConnection
```
public RedisClusterConnection getClusterConnection()
```
    Description copied from interface: RedisConnectionFactory
    
    Provides a suitable connection for interacting with Redis Cluster.
    
    Specified by:
    
    getClusterConnection in interface RedisConnectionFactory
    
    Returns:
  - getReactiveConnection
```
public ReactiveRedisConnection getReactiveConnection()
```
    Specified by:
    
    getReactiveConnection in interface RedisConnectionFactory
    
    Returns:
  - getReactiveClusterConnection
```
public ReactiveRedisClusterConnection getReactiveClusterConnection()
```
    Specified by:
    
    getReactiveClusterConnection in interface RedisConnectionFactory
    
    Returns:
  - translateExceptionIfPossible
```
public DataAccessException translateExceptionIfPossible(RuntimeException ex)
```
    Specified by:
    
    translateExceptionIfPossible in interface PersistenceExceptionTranslator
  - getHostName
```
public String getHostName()
```
    Returns the Redis hostName.
    
    Returns:
    
    Returns the hostName
  - setHostName
```
public void setHostName(String hostName)
```
    Sets the Redis hostName.
    
    Parameters:
    
    hostName - The hostName to set.
  - setUseSsl
```
public void setUseSsl(boolean useSsl)
```
    Sets whether to use SSL.
    
    Parameters:
    
    useSsl - true to use SSL.
    
    Since:
    
    1.8
  - isUseSsl
```
public boolean isUseSsl()
```
    Returns whether to use SSL.
    
    Returns:
    
    use of SSL
    
    Since:
    
    1.8
  - getPassword
```
public String getPassword()
```
    Returns the password used for authenticating with the Redis server.
    
    Returns:
    
    password for authentication
  - setPassword
```
public void setPassword(String password)
```
    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:
    
    Redis port.
  - setPort
```
public void setPort(int port)
```
    Sets the port used to connect to the Redis instance.
    
    Parameters:
    
    port - Redis port
  - getShardInfo
```
public redis.clients.jedis.JedisShardInfo getShardInfo()
```
    Returns the shardInfo.
    
    Returns:
    
    Returns the shardInfo
  - setShardInfo
```
public void setShardInfo(redis.clients.jedis.JedisShardInfo shardInfo)
```
    Sets the shard info for this factory.
    
    Parameters:
    
    shardInfo - The shardInfo to set.
  - getTimeout
```
public int getTimeout()
```
    Returns the timeout.
    
    Returns:
    
    Returns the timeout
  - setTimeout
```
public void setTimeout(int timeout)
```
    Parameters:
    
    timeout - The timeout to set.
  - getUsePool
```
public boolean getUsePool()
```
    Indicates the use of a connection pool.
    
    Returns:
    
    Returns the use of connection pooling.
  - setUsePool
```
public void setUsePool(boolean usePool)
```
    Turns on or off the use of connection pooling.
    
    Parameters:
    
    usePool - The usePool to set.
  - getPoolConfig
```
public redis.clients.jedis.JedisPoolConfig getPoolConfig()
```
    Returns the poolConfig.
    
    Returns:
    
    Returns the poolConfig
  - setPoolConfig
```
public void setPoolConfig(redis.clients.jedis.JedisPoolConfig poolConfig)
```
    Sets the pool configuration for this factory.
    
    Parameters:
    
    poolConfig - The poolConfig to set.
  - getDatabase
```
public int getDatabase()
```
    Returns the index of the database.
    
    Returns:
    
    Returns the database index
  - setDatabase
```
public void setDatabase(int index)
```
    Sets the index of the database used by this connection factory. Default is 0.
    
    Parameters:
    
    index - database index
  - 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:
    
    Whether or not to convert pipeline and tx results
  - 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 - Whether or not to convert pipeline and tx results
  - isRedisSentinelAware
```
public boolean isRedisSentinelAware()
```
    Returns:
    
    true when RedisSentinelConfiguration is present.
    
    Since:
    
    1.4
  - getSentinelConnection
```
public RedisSentinelConnection getSentinelConnection()
```
    Description copied from interface: RedisConnectionFactory
    
    Provides a suitable connection for interacting with Redis Sentinel.
    
    Specified by:
    
    getSentinelConnection in interface RedisConnectionFactory
    
    Returns:
    
    connection for interacting with Redis Sentinel.

Class JedisConnectionFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JedisConnectionFactory

JedisConnectionFactory

JedisConnectionFactory

JedisConnectionFactory

JedisConnectionFactory

JedisConnectionFactory

JedisConnectionFactory

Method Detail

fetchJedisConnector

postProcessConnection

afterPropertiesSet

createRedisSentinelPool

createRedisPool

createCluster

destroy

getConnection

getClusterConnection

getReactiveConnection

getReactiveClusterConnection

translateExceptionIfPossible

getHostName

setHostName

setUseSsl

isUseSsl

getPassword

setPassword

getPort

setPort

getShardInfo

setShardInfo

getTimeout

setTimeout

getUsePool

setUsePool

getPoolConfig

setPoolConfig

getDatabase

setDatabase

getConvertPipelineAndTxResults

setConvertPipelineAndTxResults

isRedisSentinelAware

getSentinelConnection