org.aredis.cache

Class AsyncRedisFactory

java.lang.Object

org.aredis.cache.AsyncRedisFactory

public class AsyncRedisFactory
extends Object

This is the preferred class to use to get aredis Service Objects like AsyncRedisConnection, AsyncObjectPool and RedisSubscription. In a server environment it should be configured as a Singleton or as a Spring Bean. It returns the Same Service Object on Subsequent calls for the same server or comma separated list of servers. Currently the AsyncRedisConnection there is no way to free AsyncRedisConnection Objects that are no longer needed. But the connections close after the configured idle timeout.

Author:

Suresh

Constructor Summary

Constructors

Constructor and Description
AsyncRedisFactory(AsyncSocketTransportFactory ptransportFactory, Executor pexecutor) Creates an AsyncRedisFactory Object with a default pool size of 10 and Shutdown delay of 10 seconds.
AsyncRedisFactory(AsyncSocketTransportFactory ptransportFactory, Executor pexecutor, int ppoolSize, int pshutdownDelay) Creates an AsyncRedisFactory Object.
AsyncRedisFactory(Executor pexecutor) Creates an AsyncRedisFactory Object with the default Transport Factory, a default pool size of 10 and Shutdown delay of 10 seconds.

Method Summary

Methods

Modifier and Type	Method and Description
static String	getAuth(ServerInfo serverInfo) Gets the Configured Authentication for the given serverInfo.
static String	getAuth(String connectionString) Gets the Configured Authentication for the Redis Server with the given connectionString.
AsyncRedisClient	getClient(String connectionString) Returns an AsyncRedisClient from a connection string containing one or more redis servers.
AsyncRedisClient	getClient(String connectionString, Executor pexecutor) Returns an AsyncRedisClient from a connection string containing one or more redis servers.
AsyncRedisConnection	getConnection(RedisServerInfo redisServerInfo) Returns an AsycRedisConnection.
AsyncRedisConnection	getConnection(RedisServerInfo redisServerInfo, Executor pexecutor) Returns an AsycRedisConnection.
AsyncObjectPool<AsyncRedisConnection>	getConnectionPool(RedisServerInfo redisServerInfo) Returns a connection pool for use in Redis Transactions with WATCH-MULTI-EXEC commands.
AsyncObjectPool<AsyncRedisConnection>	getConnectionPool(RedisServerInfo redisServerInfo, Executor pexecutor) Returns a connection pool for use in Redis Transactions with WATCH-MULTI-EXEC commands.
AsyncObjectPool<AsyncRedisConnection>	getConnectionPool(String connectionString) Returns an AsyncObjectPool holding AsyncRedisConnection objects for WATCH-MULTI-EXEC redis transactions.
AsyncObjectPool<AsyncRedisConnection>	getConnectionPool(String connectionString, Executor pexecutor) Returns an AsyncObjectPool holding AsyncRedisConnection objects for WATCH-MULTI-EXEC redis transactions.
DataHandler	getDataHandler() Gets the Data Handler used by the factory.
Executor	getExecutor() Gets the configured Executor for this factory or null if none is configured.
int	getPoolSize() Gets the pool size used when creating a connection pool
RedisSubscription	getSubscription(RedisServerInfo redisServerInfo) Returns a RedisSubscription object for subscribing to messages and message patterns on the given Redis Server.
RedisSubscription	getSubscription(RedisServerInfo redisServerInfo, Executor pexecutor) Returns a RedisSubscription object for subscribing to messages and message patterns on the given Redis Server.
RedisSubscription	getSubscription(String connectionString) Returns a RedisSubscription object for subscribing to messages and message patterns on the given Redis Server.
RedisSubscription	getSubscription(String connectionString, Executor pexecutor) Returns a RedisSubscription object for subscribing to messages and message patterns on the given Redis Server.
AsyncSocketTransportFactory	getSubscriptionTransportFactory() Gets the Transport Factory used for RedisSuubscription service or null if none is set.
static RedisTimer	getTimer() Gets the static instance of RedisTimer in use for periodic tasks re-connects, Leak Checks etc.
AsyncSocketTransportFactory	getTransportFactory() Gets the default Transport Factory which is also used for AsyncRedisConnections.
AsyncSocketTransportFactory	pgetPoolTransportFactory() Gets the Transport Factory used when creating a connection pool.
static void	setAuth(ServerInfo serverInfo, String auth) Sets Password for authentication if the redis server is configured with a password via requirepass directive in redis.conf.
static void	setAuth(String connectionString, String auth) Sets Password for authentication if the redis server is configured with a password via requirepass directive in redis.conf.
void	setDataHandler(DataHandler pdataHandler) Sets the Data Handler used by the factory
void	setPoolSize(int ppoolSize) Sets the pool size to use when creating a connection pool
void	setPoolTransportFactory(AsyncSocketTransportFactory ppoolTransportFactory) Sets the Transport Factory to use when creating a connection pool.
void	setSubscriptionTransportFactory(AsyncSocketTransportFactory psubscriptionTransportFactory) Sets the Transport Factory to Use for RedisSuubscription service.
static void	setTimer(RedisTimer ptimer) Sets the RedisTimer to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncRedisFactory

public AsyncRedisFactory(AsyncSocketTransportFactory ptransportFactory,
                 Executor pexecutor,
                 int ppoolSize,
                 int pshutdownDelay)

Creates an AsyncRedisFactory Object.

Parameters:

ptransportFactory - Connection Factory to use to create AsyncSocketTransport

pexecutor - Common Executor to use for aredis services

ppoolSize - Pool Size when creating a connection pool

pshutdownDelay - Shutdown delay in seconds when shutting down. This is currently not used.

AsyncRedisFactory

public AsyncRedisFactory(AsyncSocketTransportFactory ptransportFactory,
                 Executor pexecutor)

Creates an AsyncRedisFactory Object with a default pool size of 10 and Shutdown delay of 10 seconds.

Parameters:

ptransportFactory - Connection Factory to use to create AsyncSocketTransport

pexecutor - Common Executor to use for aredis services

AsyncRedisFactory

public AsyncRedisFactory(Executor pexecutor)

Creates an AsyncRedisFactory Object with the default Transport Factory, a default pool size of 10 and Shutdown delay of 10 seconds.

Parameters:

pexecutor - Common Executor to use for aredis services

Method Detail

getConnection

public AsyncRedisConnection getConnection(RedisServerInfo redisServerInfo,
                                 Executor pexecutor)

Returns an AsycRedisConnection. However the preferred method is getClient.

Parameters:

redisServerInfo - Redis Server Info containing host, port and DB Index

pexecutor - Specific Executor to use for the connection returned or null to use the Factory's Executor.

Returns:

An AsyncRedisConnection for the given server

getConnection

public AsyncRedisConnection getConnection(RedisServerInfo redisServerInfo)

Returns an AsycRedisConnection. However the preferred method is getClient.

Parameters:

redisServerInfo - Redis Server Info containing host, port and DB Index

Returns:

An AsyncRedisConnection for the given server

getConnectionPool

public AsyncObjectPool<AsyncRedisConnection> getConnectionPool(RedisServerInfo redisServerInfo,
                                                      Executor pexecutor)

Returns a connection pool for use in Redis Transactions with WATCH-MULTI-EXEC commands.

Parameters:

redisServerInfo - Redis Server Info containing host, port and DB Index

pexecutor - Specific Executor to use for the connection pool returned or null to use the Factory's Executor.

Returns:

An AsyncObjectPool holding AsyncRedisConnection objects

getConnectionPool

public AsyncObjectPool<AsyncRedisConnection> getConnectionPool(RedisServerInfo redisServerInfo)

Returns a connection pool for use in Redis Transactions with WATCH-MULTI-EXEC commands.

Parameters:

redisServerInfo - Redis Server Info containing host, port and DB Index

Returns:

An AsyncObjectPool holding AsyncRedisConnection objects

getClient

public AsyncRedisClient getClient(String connectionString,
                         Executor pexecutor)

Returns an AsyncRedisClient from a connection string containing one or more redis servers. The connection string is a comma separated list of Servers with each Server containing the host, port followed by a : and redis db index followed by a /. The port (Defaults to 6379) and db index (Defaults to 0) are optional. Example connection Strings: "localhost", "10.12.33.44:6380", "server1/0,server2:6380,server3:6379/2". The returned client is an instance of AsyncRedisConnection with ConnectionType SHARED if the connection string contains only server else it is an instance of ShardedAsyncRedisConnection.

Parameters:

connectionString - Connection String

pexecutor - Specific Executor to use for the client returned or null to use the Factory's Executor.

Returns:

An AsyncRedisClient to submit redis commands

getClient

public AsyncRedisClient getClient(String connectionString)

Returns an AsyncRedisClient from a connection string containing one or more redis servers. The connection string is a comma separated list of Servers with each Server containing the host, port followed by a : and redis db index followed by a /. The port (Defaults to 6379) and db index (Defaults to 0) are optional. Example connection Strings: "localhost", "10.12.33.44:6380", "server1/0,server2:6380,server3:6379/2". The returned client is an instance of AsyncRedisConnection with ConnectionType SHARED if the connection string contains only server else it is an instance of ShardedAsyncRedisConnection.

Parameters:

connectionString - Connection String

Returns:

An AsyncRedisClient to submit redis commands

getConnectionPool

public AsyncObjectPool<AsyncRedisConnection> getConnectionPool(String connectionString,
                                                      Executor pexecutor)

Returns an AsyncObjectPool holding AsyncRedisConnection objects for WATCH-MULTI-EXEC redis transactions.

Parameters:

connectionString - Connection String specifying a single redis server

pexecutor - Specific Executor to use for the pool returned or null to use the Factory's Executor.

Returns:

An Object Pool of AsyncRedisConnection from which one can borrow a connection, run WATCH-MULTI-EXEC along with other commands and return the connection to the pool on completion of EXEC

getConnectionPool

public AsyncObjectPool<AsyncRedisConnection> getConnectionPool(String connectionString)

Returns an AsyncObjectPool holding AsyncRedisConnection objects for WATCH-MULTI-EXEC redis transactions.

Parameters:

connectionString - Connection String specifying a single redis server

Returns:

An Object Pool of AsyncRedisConnection

getSubscription

public RedisSubscription getSubscription(RedisServerInfo redisServerInfo,
                                Executor pexecutor)

Returns a RedisSubscription object for subscribing to messages and message patterns on the given Redis Server.

Parameters:

redisServerInfo - Redis Server Info containing host, port and DB Index

pexecutor - Specific Executor to use for the RedisSubscription returned or null to use the Factory's Executor.

Returns:

A RedisSubscription object using which one can Subscribe to messages on the Redis Server

getSubscription

public RedisSubscription getSubscription(RedisServerInfo redisServerInfo)

Returns a RedisSubscription object for subscribing to messages and message patterns on the given Redis Server.

Parameters:

redisServerInfo - Redis Server Info containing host, port and DB Index

Returns:

A RedisSubscription object using which one can Subscribe to messages on the Redis Server

getSubscription

public RedisSubscription getSubscription(String connectionString,
                                Executor pexecutor)

Returns a RedisSubscription object for subscribing to messages and message patterns on the given Redis Server.

Parameters:

connectionString - Connection String specifying a single redis server

pexecutor - Specific Executor to use for the RedisSubscription returned or null to use the Factory's Executor.

Returns:

A RedisSubscription object using which one can Subscribe to messages on the Redis Server

getSubscription

public RedisSubscription getSubscription(String connectionString)

Returns a RedisSubscription object for subscribing to messages and message patterns on the given Redis Server.

Parameters:

connectionString - Connection String specifying a single redis server

Returns:

A RedisSubscription object using which one can Subscribe to messages on the Redis Server

getTimer

public static RedisTimer getTimer()

Gets the static instance of RedisTimer in use for periodic tasks re-connects, Leak Checks etc. If none is set a new DefaultRedisTimer is created an returned.

Returns:

The RedisTimer in use

setTimer

public static void setTimer(RedisTimer ptimer)

Sets the RedisTimer to use. This is for overriding the default Timer if you already have a Timer.

Parameters:

ptimer - Timer to set

getDataHandler

public DataHandler getDataHandler()

Gets the Data Handler used by the factory.

Returns:

The Default Data Handler used when creating a redis service or null if none set

setDataHandler

public void setDataHandler(DataHandler pdataHandler)

Sets the Data Handler used by the factory

Parameters:

pdataHandler - The Default Data Handler to use when creating a redis service or null if none set

getPoolSize

public int getPoolSize()

Gets the pool size used when creating a connection pool

Returns:

pool size

setPoolSize

public void setPoolSize(int ppoolSize)

Sets the pool size to use when creating a connection pool

Parameters:

ppoolSize - pool size

pgetPoolTransportFactory

public AsyncSocketTransportFactory pgetPoolTransportFactory()

Gets the Transport Factory used when creating a connection pool.

Returns:

Transport factory for connection pools or null if none is set in which case the Factory's Transport Factory is used

setPoolTransportFactory

public void setPoolTransportFactory(AsyncSocketTransportFactory ppoolTransportFactory)

Sets the Transport Factory to use when creating a connection pool. This could be used to configure the transport factory with a different idleTimeout to be used only for connection pools for example.

Parameters:

ppoolTransportFactory - Transport factory for connection pools

getSubscriptionTransportFactory

public AsyncSocketTransportFactory getSubscriptionTransportFactory()

Gets the Transport Factory used for RedisSuubscription service or null if none is set.

Returns:

Transport Factory for RedisSubscription

setSubscriptionTransportFactory

public void setSubscriptionTransportFactory(AsyncSocketTransportFactory psubscriptionTransportFactory)

Sets the Transport Factory to Use for RedisSuubscription service.

Parameters:

psubscriptionTransportFactory - Transport Factory for RedisSubscription

getTransportFactory

public AsyncSocketTransportFactory getTransportFactory()

Gets the default Transport Factory which is also used for AsyncRedisConnections.

Returns:

Default Transport Factory used by this AsyncRedisFactory

getExecutor

public Executor getExecutor()

Gets the configured Executor for this factory or null if none is configured.

Returns:

Configured Executor

getAuth

public static String getAuth(ServerInfo serverInfo)

Gets the Configured Authentication for the given serverInfo.

Parameters:

serverInfo - Redis Server Info giving host and port

Returns:

Password set via setAuth call or null if no password is set

setAuth

public static void setAuth(ServerInfo serverInfo,
           String auth)

Sets Password for authentication if the redis server is configured with a password via requirepass directive in redis.conf. Once the authentication is set the same will be used by all AsyncRedisConnections and RedisSubscriptions.

Parameters:

serverInfo - Redis Server Info giving host and port. It can be got by getConnection call on AsyncRedisConnection or RedisSubscription or by constructing a RedisServerInfo

auth - Password to set or null if there is no password which is the default

getAuth

public static String getAuth(String connectionString)

Gets the Configured Authentication for the Redis Server with the given connectionString. Internally calls getAuth(ServerInfo) after creating a RedisServerInfo Object.

Parameters:

connectionString - Connection String for the Redis Server

Returns:

Password set via setAuth call or null if no password is set

setAuth

public static void setAuth(String connectionString,
           String auth)

Sets Password for authentication if the redis server is configured with a password via requirepass directive in redis.conf. Once the authentication is set the same will be used by all AsyncRedisConnections and RedisSubscriptions. Internally calls setAuth(ServerInfo, String) after creating a RedisServerInfo Object.

Parameters:

connectionString - Connection String for the Redis Server

auth - Password to set or null if there is no password which is the default