org.springframework.data.redis.core

Class RedisConnectionUtils

java.lang.Object

org.springframework.data.redis.core.RedisConnectionUtils

public abstract class RedisConnectionUtils
extends Object

Helper class featuring RedisConnection handling, allowing for reuse of instances within 'transactions'/scopes.

Author:

Costin Leau, Christoph Strobl, Thomas Darimont, Mark Paluch

Constructor Summary

Constructors

Constructor and Description
RedisConnectionUtils()

Method Summary

Modifier and Type	Method and Description
static RedisConnection	bindConnection(RedisConnectionFactory factory) Binds a new Redis connection (from the given factory) to the current thread, if none is already bound.
static RedisConnection	bindConnection(RedisConnectionFactory factory, boolean transactionSupport) Binds a new Redis connection (from the given factory) to the current thread, if none is already bound and enables transaction support if transactionSupport is set to true.
static RedisConnection	doGetConnection(RedisConnectionFactory factory, boolean allowCreate, boolean bind, boolean transactionSupport) Gets a Redis connection.
static RedisConnection	getConnection(RedisConnectionFactory factory) Gets a Redis connection from the given factory.
static RedisConnection	getConnection(RedisConnectionFactory factory, boolean transactionSupport) Gets a Redis connection from the given factory.
static boolean	isConnectionTransactional(RedisConnection conn, RedisConnectionFactory connFactory) Return whether the given Redis connection is transactional, that is, bound to the current thread by Spring's transaction facilities.
static void	releaseConnection(RedisConnection conn, RedisConnectionFactory factory) Deprecated. since 2.1.10, use releaseConnection(RedisConnection, RedisConnectionFactory, boolean) instead.
static void	releaseConnection(RedisConnection conn, RedisConnectionFactory factory, boolean transactionSupport) Closes the given connection, created via the given factory if not managed externally (i.e. not bound to the thread).
static void	unbindConnection(RedisConnectionFactory factory) Unbinds and closes the connection (if any) associated with the given factory.

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisConnectionUtils

public RedisConnectionUtils()

Method Detail

bindConnection

public static RedisConnection bindConnection(RedisConnectionFactory factory)

Binds a new Redis connection (from the given factory) to the current thread, if none is already bound.

Parameters:

factory - connection factory

Returns:

a new Redis connection without transaction support.

bindConnection

public static RedisConnection bindConnection(RedisConnectionFactory factory,
                                             boolean transactionSupport)

Binds a new Redis connection (from the given factory) to the current thread, if none is already bound and enables transaction support if transactionSupport is set to true.

Parameters:

factory - connection factory.

transactionSupport - whether transaction support is enabled.

Returns:

a new Redis connection with transaction support if requested.

getConnection

public static RedisConnection getConnection(RedisConnectionFactory factory)

Gets a Redis connection from the given factory. Is aware of and will return any existing corresponding connections bound to the current thread, for example when using a transaction manager. Will always create a new connection otherwise.

Parameters:

factory - connection factory for creating the connection.

Returns:

an active Redis connection without transaction management.

getConnection

public static RedisConnection getConnection(RedisConnectionFactory factory,
                                            boolean transactionSupport)

Gets a Redis connection from the given factory. Is aware of and will return any existing corresponding connections bound to the current thread, for example when using a transaction manager. Will always create a new connection otherwise.

Parameters:

factory - connection factory for creating the connection.

transactionSupport - whether transaction support is enabled.

Returns:

an active Redis connection with transaction management if requested.

doGetConnection

public static RedisConnection doGetConnection(RedisConnectionFactory factory,
                                              boolean allowCreate,
                                              boolean bind,
                                              boolean transactionSupport)

Gets a Redis connection. Is aware of and will return any existing corresponding connections bound to the current thread, for example when using a transaction manager. Will create a new Connection otherwise, if allowCreate is true.

Parameters:

factory - connection factory for creating the connection.

allowCreate - whether a new (unbound) connection should be created when no connection can be found for the current thread.

bind - binds the connection to the thread, in case one was created-

transactionSupport - whether transaction support is enabled.

Returns:

an active Redis connection.

releaseConnection

@Deprecated
public static void releaseConnection(@Nullable
                                                 RedisConnection conn,
                                                 RedisConnectionFactory factory)

Deprecated. since 2.1.10, use releaseConnection(RedisConnection, RedisConnectionFactory, boolean) instead.

Closes the given connection, created via the given factory if not managed externally (i.e. not bound to the thread).

Parameters:

conn - the Redis connection to close.

factory - the Redis factory that the connection was created with.

releaseConnection

public static void releaseConnection(@Nullable
                                     RedisConnection conn,
                                     RedisConnectionFactory factory,
                                     boolean transactionSupport)

Closes the given connection, created via the given factory if not managed externally (i.e. not bound to the thread).

Parameters:

conn - the Redis connection to close.

factory - the Redis factory that the connection was created with.

transactionSupport - whether transaction support is enabled.

Since:

2.1.9

unbindConnection

public static void unbindConnection(RedisConnectionFactory factory)

Unbinds and closes the connection (if any) associated with the given factory.

Parameters:

factory - Redis factory

isConnectionTransactional

public static boolean isConnectionTransactional(RedisConnection conn,
                                                RedisConnectionFactory connFactory)

Return whether the given Redis connection is transactional, that is, bound to the current thread by Spring's transaction facilities.

Parameters:

conn - Redis connection to check

connFactory - Redis connection factory that the connection was created with

Returns:

whether the connection is transactional or not