com.cloudant.client.cache.redis

Class RedisCache<K,V>

java.lang.Object

com.cloudant.client.cache.redis.RedisCache<K,V>

All Implemented Interfaces:

Cache<K,V>, CacheWithLifetimes<K,V>

public class RedisCache<K,V>
extends java.lang.Object
implements CacheWithLifetimes<K,V>

Constructor Summary

Constructors

Constructor and Description
RedisCache(redis.clients.jedis.Jedis jedisCache, long defaultLifespan) Constructor in which already-created Jedis instance is passed in to be used as underlying cache.
RedisCache(java.lang.String host, int port, int timeout, long defaultLifespan) Create a cache with the specified lifetime connected to Redis at the specified host & port.
RedisCache(java.lang.String host, int port, long defaultLifespan) Create a cache with the specified lifetime connected to Redis at the specified host & port.
RedisCache(java.lang.String host, long defaultLifespan) Create a cache with the specified lifetime connected to Redis at the specified host.

Method Summary

Modifier and Type	Method and Description
void	clear() Delete all entries from the cache.
void	close() Close the Redis connection.
void	delete(K key) Delete a key-value pair from the cache.
void	deleteAll(java.util.List<K> keys) Delete one or more key-value pairs from the cache.
java.lang.String	flushAll() Delete all key-value pairs from all databases
V	get(K key) Look up a value in the cache.
java.util.Map<K,V>	getAll(java.util.List<K> keys) Look up one or more values in the cache.
CacheEntry<V>	getCacheEntry(K key) Look up a CacheEntry in the cache.
RedisCacheStats	getStatistics() Get cache statistics.
java.lang.String	printCacheEntry(K key) Return string representing a cache entry corresponding to a key (or indicate if the key is not in the cache).
void	put(K key, V value) Cache a key-value pair.
void	put(K key, V value, long lifetime) Cache a key-value pair.
void	putAll(java.util.Map<K,V> map) Cache one or more key-value pairs.
void	putAll(java.util.Map<K,V> map, long lifetime) Cache one or more key-value pairs.
long	size()
java.lang.String	toString() Output contents of current database to a string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RedisCache

public RedisCache(java.lang.String host,
                  long defaultLifespan)

Create a cache with the specified lifetime connected to Redis at the specified host.

Parameters:

host - host where Redis is running

defaultLifespan - default life time in milliseconds for cached objects

RedisCache

public RedisCache(java.lang.String host,
                  int port,
                  long defaultLifespan)

Create a cache with the specified lifetime connected to Redis at the specified host & port.

Parameters:

host - host where Redis is running

port - port number

defaultLifespan - default life time in milliseconds for cached objects

RedisCache

public RedisCache(java.lang.String host,
                  int port,
                  int timeout,
                  long defaultLifespan)

Create a cache with the specified lifetime connected to Redis at the specified host & port.

Configure Jedis to close idle connections after the specified time.

Parameters:

host - host where Redis is running

port - port number

timeout - number of seconds before Jedis closes an idle connection

defaultLifespan - default life time in milliseconds for cached objects

RedisCache

public RedisCache(redis.clients.jedis.Jedis jedisCache,
                  long defaultLifespan)

Constructor in which already-created Jedis instance is passed in to be used as underlying cache. This constructor is for situations in which application wants access to Jedis instance so that it can directly make Jedis method calls on the Jedis instance.

Parameters:

jedisCache - Existing Jedis instance to be used as underlying cache

defaultLifespan - Default life time in milliseconds for cached objects

Method Detail

clear

public void clear()

Delete all entries from the cache.

Specified by:

clear in interface Cache<K,V>

close

public void close()

Close the Redis connection.

delete

public void delete(K key)

Delete a key-value pair from the cache.

Specified by:

delete in interface Cache<K,V>

Parameters:

key - key corresponding to value

deleteAll

public void deleteAll(java.util.List<K> keys)

Delete one or more key-value pairs from the cache.

Specified by:

deleteAll in interface Cache<K,V>

Parameters:

keys - List containing the keys to delete

flushAll

public java.lang.String flushAll()

Delete all key-value pairs from all databases

Returns:

status code reply

get

public V get(K key)

Look up a value in the cache.

Specified by:

get in interface Cache<K,V>

Parameters:

key - key corresponding to value

Returns:

value corresponding to key, null if key is not in cache or if value is expired

getAll

public java.util.Map<K,V> getAll(java.util.List<K> keys)

Look up one or more values in the cache. Don't return expired values.

Specified by:

getAll in interface Cache<K,V>

Parameters:

keys - List containing the keys to look up

Returns:

map containing key-value pairs corresponding to unexpired data in the cache

getCacheEntry

public CacheEntry<V> getCacheEntry(K key)

Look up a CacheEntry in the cache. The CacheEntry may correspond to expired data. This method can be used to revalidate cached objects whose expiration times have passed.

Specified by:

getCacheEntry in interface CacheWithLifetimes<K,V>

Parameters:

key - key corresponding to value

Returns:

value corresponding to key (may be expired), null if key is not in cache

getStatistics

public RedisCacheStats getStatistics()

Get cache statistics.

For Redis, cache statistics are contained in a string. The string is returned by RedisCacheStats.getStats().

Specified by:

getStatistics in interface Cache<K,V>

Returns:

data structure containing statistics

printCacheEntry

public java.lang.String printCacheEntry(K key)

Return string representing a cache entry corresponding to a key (or indicate if the key is not in the cache).

Parameters:

key - key corresponding to value

Returns:

string containing output

put

public void put(K key,
                V value)

Cache a key-value pair.

Specified by:

put in interface Cache<K,V>

Parameters:

key - key associated with value

value - value associated with key

put

public void put(K key,
                V value,
                long lifetime)

Cache a key-value pair.

Specified by:

put in interface CacheWithLifetimes<K,V>

Parameters:

key - key associated with value

value - value associated with key

lifetime - lifetime in milliseconds associated with data

putAll

public void putAll(java.util.Map<K,V> map)

Cache one or more key-value pairs.

Specified by:

putAll in interface Cache<K,V>

Parameters:

map - map containing key-value pairs to cache

putAll

public void putAll(java.util.Map<K,V> map,
                   long lifetime)

Cache one or more key-value pairs.

Specified by:

putAll in interface CacheWithLifetimes<K,V>

Parameters:

map - map containing key-value pairs to cache

lifetime - lifetime in milliseconds associated with each key-value pair. If the system supports revalidation of expired cache entries to determine if expired entries are really obsolete, a value <= 0 indicates cached entry should always be revalidated before being returned to client

size

public long size()

Specified by:

size in interface Cache<K,V>

Returns:

the number of objects in cache

toString

public java.lang.String toString()

Output contents of current database to a string.

Overrides:

toString in class java.lang.Object

Returns:

string containing output