net.greghaines.jesque.utils

Class PoolUtils

java.lang.Object

net.greghaines.jesque.utils.PoolUtils

public final class PoolUtils
extends Object

Convenience methods for doing work with pooled Jedis connections.

Author:

Greg Haines

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PoolUtils.PoolWork<T,V> A unit of work that utilizes a pooled resource.

Method Summary

Modifier and Type	Method and Description
static redis.clients.util.Pool<redis.clients.jedis.Jedis>	createJedisPool(Config jesqueConfig) A simple helper method that creates a pool of connections to Redis using the supplied Config and the default pool config.
static redis.clients.util.Pool<redis.clients.jedis.Jedis>	createJedisPool(Config jesqueConfig, org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig) A simple helper method that creates a pool of connections to Redis using the supplied configurations.
static <V> V	doWorkInPool(redis.clients.util.Pool<redis.clients.jedis.Jedis> pool, PoolUtils.PoolWork<redis.clients.jedis.Jedis,V> work) Perform the given work with a Jedis connection from the given pool.
static <V> V	doWorkInPoolNicely(redis.clients.util.Pool<redis.clients.jedis.Jedis> pool, PoolUtils.PoolWork<redis.clients.jedis.Jedis,V> work) Perform the given work with a Jedis connection from the given pool.
static org.apache.commons.pool2.impl.GenericObjectPoolConfig	getDefaultPoolConfig()

Methods inherited from class java.lang.Object

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

Method Detail

doWorkInPool

public static <V> V doWorkInPool(redis.clients.util.Pool<redis.clients.jedis.Jedis> pool,
                                 PoolUtils.PoolWork<redis.clients.jedis.Jedis,V> work)
                          throws Exception

Perform the given work with a Jedis connection from the given pool.

Type Parameters:

V - the result type

Parameters:

pool - the resource pool

work - the work to perform

Returns:

the result of the given work

Throws:

Exception - if something went wrong

doWorkInPoolNicely

public static <V> V doWorkInPoolNicely(redis.clients.util.Pool<redis.clients.jedis.Jedis> pool,
                                       PoolUtils.PoolWork<redis.clients.jedis.Jedis,V> work)

Perform the given work with a Jedis connection from the given pool. Wraps any thrown checked exceptions in a RuntimeException.

Type Parameters:

V - the result type

Parameters:

pool - the resource pool

work - the work to perform

Returns:

the result of the given work

getDefaultPoolConfig

public static org.apache.commons.pool2.impl.GenericObjectPoolConfig getDefaultPoolConfig()

Returns:

a GenericObjectPoolConfig configured with: maxActive=-1, maxIdle=10, minIdle=1, testOnBorrow=true, blockWhenExhausted=false

createJedisPool

public static redis.clients.util.Pool<redis.clients.jedis.Jedis> createJedisPool(Config jesqueConfig)

A simple helper method that creates a pool of connections to Redis using the supplied Config and the default pool config.

Parameters:

jesqueConfig - the config used to create the pooled Jedis connection

Returns:

a configured Pool of Jedis connections

createJedisPool

public static redis.clients.util.Pool<redis.clients.jedis.Jedis> createJedisPool(Config jesqueConfig,
                                                                                 org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig)

A simple helper method that creates a pool of connections to Redis using the supplied configurations.

Parameters:

jesqueConfig - the config used to create the pooled Jedis connections

poolConfig - the config used to create the pool

Returns:

a configured Pool of Jedis connections