LettuceConnectionFactory (Spring Data Redis 2.0.0.M1 API)

java.lang.Object
- org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory

All Implemented Interfaces:

DisposableBean, InitializingBean, PersistenceExceptionTranslator, RedisConnectionFactory
```
public class LettuceConnectionFactory
extends Object
implements InitializingBean, DisposableBean, RedisConnectionFactory
```
Connection factory creating Lettuce-based connections.
This factory creates a new LettuceConnection on each call to getConnection(). Multiple LettuceConnections share a single thread-safe native connection by default.
The shared native connection is never closed by LettuceConnection, therefore it is not validated by default on getConnection(). Use setValidateConnection(boolean) to change this behavior if necessary. Inject a Pool to pool dedicated connections. If shareNativeConnection is true, the pool will be used to select a connection for blocking and tx operations only, which should not share a connection. If native connection sharing is disabled, the selected connection will be used for all operations.

Author:

Costin Leau, Jennifer Hickey, Thomas Darimont, Christoph Strobl, Mark Paluch, Balázs Németh

Field Summary

Fields
Modifier and Type Field and Description

static String PING_REPLY

Fields
Modifier and Type	Field and Description
`static String`	`PING_REPLY`

Constructor Summary

Constructors
Constructor and Description
`LettuceConnectionFactory()` Constructs a new `LettuceConnectionFactory` instance with default settings.
`LettuceConnectionFactory(LettucePool pool)`
`LettuceConnectionFactory(RedisClusterConfiguration clusterConfig)` Constructs a new `LettuceConnectionFactory` instance using the given `RedisClusterConfiguration` applied to create a `RedisClusterClient`.
`LettuceConnectionFactory(RedisSentinelConfiguration sentinelConfiguration)` Constructs a new `LettuceConnectionFactory` instance using the given `RedisSentinelConfiguration`
`LettuceConnectionFactory(String host, int port)` Constructs a new `LettuceConnectionFactory` instance with default settings.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`protected com.lambdaworks.redis.api.StatefulRedisConnection<byte[],byte[]>`	`createLettuceConnector()`
`void`	`destroy()`
`com.lambdaworks.redis.resource.ClientResources`	`getClientResources()` Get the `ClientResources` to reuse infrastructure.
`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 current host.
`String`	`getPassword()` Returns the password used for authenticating with the Redis server.
`int`	`getPort()` Returns the current port.
`LettuceReactiveRedisClusterConnection`	`getReactiveClusterConnection()`
`LettuceReactiveRedisConnection`	`getReactiveConnection()`
`RedisSentinelConnection`	`getSentinelConnection()` Provides a suitable connection for interacting with Redis Sentinel.
`protected com.lambdaworks.redis.api.StatefulRedisConnection<byte[],byte[]>`	`getSharedConnection()`
`boolean`	`getShareNativeConnection()` Indicates if multiple `LettuceConnection`s should share a single native connection.
`long`	`getShutdownTimeout()` Returns the shutdown timeout for shutting down the RedisClient (in milliseconds).
`long`	`getTimeout()` Returns the connection timeout (in milliseconds).
`boolean`	`getValidateConnection()` Indicates if validation of the native Lettuce connection is enabled.
`void`	`initConnection()`
`boolean`	`isClusterAware()`
`boolean`	`isRedisSentinelAware()`
`boolean`	`isStartTls()` Returns whether to issue a StartTLS.
`boolean`	`isUseSsl()` Returns whether to use SSL.
`boolean`	`isVerifyPeer()` Returns whether to verify certificate validity/hostname check when SSL is used.
`void`	`resetConnection()` Reset the underlying shared Connection, to be reinitialized on next access.
`void`	`setClientResources(com.lambdaworks.redis.resource.ClientResources clientResources)` Sets the `ClientResources` to reuse the client infrastructure.
`void`	`setConvertPipelineAndTxResults(boolean convertPipelineAndTxResults)` Specifies if pipelined and transaction 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 host)` Sets the host.
`void`	`setPassword(String password)` Sets the password used for authenticating with the Redis server.
`void`	`setPort(int port)` Sets the port.
`void`	`setShareNativeConnection(boolean shareNativeConnection)` Enables multiple `LettuceConnection`s to share a single native connection.
`void`	`setShutdownTimeout(long shutdownTimeout)` Sets the shutdown timeout for shutting down the RedisClient (in milliseconds).
`void`	`setStartTls(boolean startTls)` Sets to issue StartTLS.
`void`	`setTimeout(long timeout)` Sets the connection timeout (in milliseconds).
`void`	`setUseSsl(boolean useSsl)` Sets to use SSL connection
`void`	`setValidateConnection(boolean validateConnection)` Enables validation of the shared native Lettuce connection on calls to `getConnection()`.
`void`	`setVerifyPeer(boolean verifyPeer)` Sets to use verify certificate validity/hostname check when SSL is used.
`DataAccessException`	`translateExceptionIfPossible(RuntimeException ex)`
`void`	`validateConnection()` Validate the shared Connection and reinitialize if invalid

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

- Field Detail
  - PING_REPLY
```
public static final String PING_REPLY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LettuceConnectionFactory
```
public LettuceConnectionFactory()
```
    Constructs a new LettuceConnectionFactory instance with default settings.
  - LettuceConnectionFactory
```
public LettuceConnectionFactory(String host,
                                int port)
```
    Constructs a new LettuceConnectionFactory instance with default settings.
  - LettuceConnectionFactory
```
public LettuceConnectionFactory(RedisSentinelConfiguration sentinelConfiguration)
```
    Constructs a new LettuceConnectionFactory instance using the given RedisSentinelConfiguration
    
    Parameters:
    
    sentinelConfiguration -
    
    Since:
    
    1.6
  - LettuceConnectionFactory
```
public LettuceConnectionFactory(RedisClusterConfiguration clusterConfig)
```
    Constructs a new LettuceConnectionFactory instance using the given RedisClusterConfiguration applied to create a RedisClusterClient.
    
    Parameters:
    
    clusterConfig -
    
    Since:
    
    1.7
  - LettuceConnectionFactory
```
public LettuceConnectionFactory(LettucePool pool)
```
- Method Detail
  - afterPropertiesSet
```
public void afterPropertiesSet()
```
    Specified by:
    
    afterPropertiesSet in interface InitializingBean
  - 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 LettuceReactiveRedisConnection getReactiveConnection()
```
    Specified by:
    
    getReactiveConnection in interface RedisConnectionFactory
    
    Returns:
  - getReactiveClusterConnection
```
public LettuceReactiveRedisClusterConnection getReactiveClusterConnection()
```
    Specified by:
    
    getReactiveClusterConnection in interface RedisConnectionFactory
    
    Returns:
  - initConnection
```
public void initConnection()
```
  - resetConnection
```
public void resetConnection()
```
    Reset the underlying shared Connection, to be reinitialized on next access.
  - validateConnection
```
public void validateConnection()
```
    Validate the shared Connection and reinitialize if invalid
  - translateExceptionIfPossible
```
public DataAccessException translateExceptionIfPossible(RuntimeException ex)
```
    Specified by:
    
    translateExceptionIfPossible in interface PersistenceExceptionTranslator
  - getHostName
```
public String getHostName()
```
    Returns the current host.
    
    Returns:
    
    the host
  - setHostName
```
public void setHostName(String host)
```
    Sets the host.
    
    Parameters:
    
    host - the host to set
  - getPort
```
public int getPort()
```
    Returns the current port.
    
    Returns:
    
    the port
  - setPort
```
public void setPort(int port)
```
    Sets the port.
    
    Parameters:
    
    port - the port to set
  - getTimeout
```
public long getTimeout()
```
    Returns the connection timeout (in milliseconds).
    
    Returns:
    
    connection timeout
  - setTimeout
```
public void setTimeout(long timeout)
```
    Sets the connection timeout (in milliseconds).
    
    Parameters:
    
    timeout - connection timeout
  - setUseSsl
```
public void setUseSsl(boolean useSsl)
```
    Sets to use SSL connection
    
    Parameters:
    
    useSsl - true to use SSL.
  - isUseSsl
```
public boolean isUseSsl()
```
    Returns whether to use SSL.
    
    Returns:
    
    use of SSL
  - setVerifyPeer
```
public void setVerifyPeer(boolean verifyPeer)
```
    Sets to use verify certificate validity/hostname check when SSL is used.
    
    Parameters:
    
    verifyPeer - false not to verify hostname.
  - isVerifyPeer
```
public boolean isVerifyPeer()
```
    Returns whether to verify certificate validity/hostname check when SSL is used.
    
    Returns:
    
    verify peers when using SSL
  - isStartTls
```
public boolean isStartTls()
```
    Returns whether to issue a StartTLS.
    
    Returns:
    
    use of StartTLS
  - setStartTls
```
public void setStartTls(boolean startTls)
```
    Sets to issue StartTLS.
    
    Parameters:
    
    startTls - true to issue StartTLS.
  - getValidateConnection
```
public boolean getValidateConnection()
```
    Indicates if validation of the native Lettuce connection is enabled.
    
    Returns:
    
    connection validation enabled
  - setValidateConnection
```
public void setValidateConnection(boolean validateConnection)
```
    Enables validation of the shared native Lettuce connection on calls to getConnection(). A new connection will be created and used if validation fails.
    Lettuce will automatically reconnect until close is called, which should never happen through LettuceConnection if a shared native connection is used, therefore the default is false.
    Setting this to true will result in a round-trip call to the server on each new connection, so this setting should only be used if connection sharing is enabled and there is code that is actively closing the native Lettuce connection.
    
    Parameters:
    
    validateConnection - enable connection validation
  - getShareNativeConnection
```
public boolean getShareNativeConnection()
```
    Indicates if multiple LettuceConnections should share a single native connection.
    
    Returns:
    
    native connection shared
  - setShareNativeConnection
```
public void setShareNativeConnection(boolean shareNativeConnection)
```
    Enables multiple LettuceConnections to share a single native connection. If set to false, every operation on LettuceConnection will open and close a socket.
    
    Parameters:
    
    shareNativeConnection - enable connection sharing
  - 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
  - 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
  - getShutdownTimeout
```
public long getShutdownTimeout()
```
    Returns the shutdown timeout for shutting down the RedisClient (in milliseconds).
    
    Returns:
    
    shutdown timeout
    
    Since:
    
    1.6
  - setShutdownTimeout
```
public void setShutdownTimeout(long shutdownTimeout)
```
    Sets the shutdown timeout for shutting down the RedisClient (in milliseconds).
    
    Parameters:
    
    shutdownTimeout - the shutdown timeout
    
    Since:
    
    1.6
  - getClientResources
```
public com.lambdaworks.redis.resource.ClientResources getClientResources()
```
    Get the ClientResources to reuse infrastructure.
    
    Returns:
    
    null if not set.
    
    Since:
    
    1.7
  - setClientResources
```
public void setClientResources(com.lambdaworks.redis.resource.ClientResources clientResources)
```
    Sets the ClientResources to reuse the client infrastructure.
    Set to null to not share resources.
    
    Parameters:
    
    clientResources - can be null.
    
    Since:
    
    1.7
  - getConvertPipelineAndTxResults
```
public boolean getConvertPipelineAndTxResults()
```
    Specifies if pipelined results should be converted to the expected data type. If false, results of LettuceConnection.closePipeline() and {LettuceConnection#exec()} will be of the type returned by the Lettuce 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 and transaction results should be converted to the expected data type. If false, results of LettuceConnection.closePipeline() and {LettuceConnection#exec()} will be of the type returned by the Lettuce driver
    
    Parameters:
    
    convertPipelineAndTxResults - Whether or not to convert pipeline and tx results
  - getSharedConnection
```
protected com.lambdaworks.redis.api.StatefulRedisConnection<byte[],byte[]> getSharedConnection()
```
  - createLettuceConnector
```
protected com.lambdaworks.redis.api.StatefulRedisConnection<byte[],byte[]> createLettuceConnector()
```
  - isRedisSentinelAware
```
public boolean isRedisSentinelAware()
```
    Returns:
    
    true when RedisSentinelConfiguration is present.
    
    Since:
    
    1.5
  - isClusterAware
```
public boolean isClusterAware()
```
    Returns:
    
    since 1.7
  - 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 LettuceConnectionFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PING_REPLY

Constructor Detail

LettuceConnectionFactory

LettuceConnectionFactory

LettuceConnectionFactory

LettuceConnectionFactory

LettuceConnectionFactory

Method Detail

afterPropertiesSet

destroy

getConnection

getClusterConnection

getReactiveConnection

getReactiveClusterConnection

initConnection

resetConnection

validateConnection

translateExceptionIfPossible

getHostName

setHostName

getPort

setPort

getTimeout

setTimeout

setUseSsl

isUseSsl

setVerifyPeer

isVerifyPeer

isStartTls

setStartTls

getValidateConnection

setValidateConnection

getShareNativeConnection

setShareNativeConnection

getDatabase

setDatabase

getPassword

setPassword

getShutdownTimeout

setShutdownTimeout

getClientResources

setClientResources

getConvertPipelineAndTxResults

setConvertPipelineAndTxResults

getSharedConnection

createLettuceConnector

isRedisSentinelAware

isClusterAware

getSentinelConnection