org.glassfish.grizzly.memcached

Class GrizzlyMemcachedCache<K,V>

java.lang.Object

org.glassfish.grizzly.memcached.GrizzlyMemcachedCache<K,V>

All Implemented Interfaces:

Cache<K,V>, CacheLifecycle, Commands<K,V>, MemcachedCache<K,V>, ZooKeeperSupportCache

public class GrizzlyMemcachedCache<K,V>
extends Object
implements MemcachedCache<K,V>, ZooKeeperSupportCache

The implementation of the MemcachedCache based on Grizzly

Basically, this class use BaseObjectPool for pooling connections of the memcached server and ConsistentHashStore for selecting the memcached server corresponding to the given key.

When a Cache operation is called, 1. finding the correct server by consistent hashing 2. borrowing the connection from the connection pool 3. queueing request and sending packets to the memcached server and waiting for notification 4. being waken by Grizzly filter when the response is arrived 5. returning the connection to the pool

For the failback of the memcached server, HealthMonitorTask will be scheduled by healthMonitorIntervalInSecs. If connecting and writing are failed, this cache retries failure operations by retryCount. If retrials also failed, the server will be regarded as not valid and removed in ConsistentHashStore. Sometimes, automatical changes of the server list can cause stale cache data at runtime. So this cache provides failover flag which can turn off the failover/failback.

This cache also supports bulk operations such as setMulti(java.util.Map<K, V>, int) as well as getMulti(java.util.Set<K>).

Example of use: // creates a CacheManager final GrizzlyMemcachedCacheManager manager = new GrizzlyMemcachedCacheManager.Builder().build(); // creates a CacheBuilder final GrizzlyMemcachedCache.Builder<String, String> builder = manager.createCacheBuilder("USER"); // sets initial servers builder.servers(initServerSet); // creates the specific Cache final MemcachedCache<String, String> userCache = builder.build(); // if you need to add another server userCache.addServer(anotherServerAddress); // cache operations boolean result = userCache.set("name", "foo", expirationTimeoutInSec, false); String value = userCache.get("name", false); // ... // shuts down manager.shutdown();

Author:

Bongjae Chang

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GrizzlyMemcachedCache.Builder<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECTION_POOL_ATTRIBUTE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(K key, V value, int expirationInSecs, boolean noReply)
boolean	add(K key, V value, int expirationInSecs, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	addServer(SocketAddress serverAddress) Add a specific server in this cache
void	addZooKeeperListener(BarrierListener listener) Add the custom BarrierListener The given listener will be called after cache's default listener will be completed.
boolean	append(K key, V value, boolean noReply)
boolean	append(K key, V value, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	cas(K key, V value, int expirationInSecs, long cas, boolean noReply)
boolean	cas(K key, V value, int expirationInSecs, long cas, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
Map<K,Boolean>	casMulti(Map<K,ValueWithCas<V>> map, int expirationInSecs)
Map<K,Boolean>	casMulti(Map<K,ValueWithCas<V>> map, int expirationInSecs, long writeTimeoutInMillis, long responseTimeoutInMillis)
long	decr(K key, long delta, long initial, int expirationInSecs, boolean noReply)
long	decr(K key, long delta, long initial, int expirationInSecs, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	delete(K key, boolean noReply)
boolean	delete(K key, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis) delete the item with the given key in memcached
Map<K,Boolean>	deleteMulti(Set<K> keys)
Map<K,Boolean>	deleteMulti(Set<K> keys, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	flushAll(SocketAddress address, int expirationInSecs, boolean noReply)
boolean	flushAll(SocketAddress address, int expirationInSecs, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
V	gat(K key, int expirationInSecs, boolean noReply)
V	gat(K key, int expirationInSecs, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
V	get(K key, boolean noReply)
V	get(K key, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
List<SocketAddress>	getCurrentServerList() Get current server list
String	getCurrentServerListFromZooKeeper() Return the current cache server list string from the ZooKeeper server
ValueWithKey<K,V>	getKey(K key, boolean noReply)
ValueWithKey<K,V>	getKey(K key, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
Map<K,V>	getMulti(Set<K> keys)
Map<K,V>	getMulti(Set<K> keys, long writeTimeoutInMillis, long responseTimeoutInMillis)
String	getName() Return the name of the cache.
ValueWithCas<V>	gets(K key, boolean noReply)
ValueWithCas<V>	gets(K key, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
Map<K,ValueWithCas<V>>	getsMulti(Set<K> keys)
Map<K,ValueWithCas<V>>	getsMulti(Set<K> keys, long writeTimeoutInMillis, long responseTimeoutInMillis)
String	getZooKeeperServerListPath() Return the path of the cache server list which has been registered in the ZooKeeper server
long	incr(K key, long delta, long initial, int expirationInSecs, boolean noReply)
long	incr(K key, long delta, long initial, int expirationInSecs, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	isInServerList(SocketAddress serverAddress) Check if this cache contains the given server
boolean	isZooKeeperSupported() Check if this cache supports the ZooKeeper for synchronizing the cache server list
boolean	noop(SocketAddress address)
boolean	noop(SocketAddress address, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	prepend(K key, V value, boolean noReply)
boolean	prepend(K key, V value, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	quit(SocketAddress address, boolean noReply)
boolean	quit(SocketAddress address, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
void	removeServer(SocketAddress serverAddress) Remove the given server in this cache
void	removeZooKeeperListener(BarrierListener listener) Remove the custom BarrierListener The given listener will be called after cache's default listener will be completed.
boolean	replace(K key, V value, int expirationInSecs, boolean noReply)
boolean	replace(K key, V value, int expirationInSecs, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
String	saslAuth(SocketAddress address, String mechanism, byte[] data)
String	saslAuth(SocketAddress address, String mechanism, byte[] data, long writeTimeoutInMillis, long responseTimeoutInMillis)
String	saslList(SocketAddress address)
String	saslList(SocketAddress address, long writeTimeoutInMillis, long responseTimeoutInMillis)
String	saslStep(SocketAddress address, String mechanism, byte[] data)
String	saslStep(SocketAddress address, String mechanism, byte[] data, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	set(K key, V value, int expirationInSecs, boolean noReply)
boolean	set(K key, V value, int expirationInSecs, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	setCurrentServerListOfZooKeeper(String cacheServerList) Set the current cache server list string with the given cacheServerList cacheServerList could be comma separated host:port pairs, each corresponding to a memcached server.
Map<K,Boolean>	setMulti(Map<K,V> map, int expirationInSecs)
Map<K,Boolean>	setMulti(Map<K,V> map, int expirationInSecs, long writeTimeoutInMillis, long responseTimeoutInMillis)
void	start() Notifies providers to start themselves.
Map<String,String>	stats(SocketAddress address)
Map<String,String>	stats(SocketAddress address, long writeTimeoutInMillis, long responseTimeoutInMillis)
Map<String,String>	statsItems(SocketAddress address, String item)
Map<String,String>	statsItems(SocketAddress address, String item, long writeTimeoutInMillis, long responseTimeoutInMillis)
void	stop() Providers may be doing all sorts of exotic things and need to be able to clean up on stop.
String	toString()
boolean	touch(K key, int expirationInSecs)
boolean	touch(K key, int expirationInSecs, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	verbosity(SocketAddress address, int verbosity)
boolean	verbosity(SocketAddress address, int verbosity, long writeTimeoutInMillis, long responseTimeoutInMillis)
String	version(SocketAddress address)
String	version(SocketAddress address, long writeTimeoutInMillis, long responseTimeoutInMillis)

Methods inherited from class java.lang.Object

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

Field Detail

CONNECTION_POOL_ATTRIBUTE_NAME

public static final String CONNECTION_POOL_ATTRIBUTE_NAME

See Also:

Constant Field Values

Method Detail

start

public void start()

Notifies providers to start themselves.

Specified by:

start in interface CacheLifecycle

stop

public void stop()

Providers may be doing all sorts of exotic things and need to be able to clean up on stop.

Specified by:

stop in interface CacheLifecycle

addServer

public boolean addServer(SocketAddress serverAddress)

Add a specific server in this cache

Specified by:

addServer in interface MemcachedCache<K,V>

Parameters:

serverAddress - a specific server's SocketAddress to be added

Returns:

true if the given serverAddress is added successfully

removeServer

public void removeServer(SocketAddress serverAddress)

Remove the given server in this cache

Specified by:

removeServer in interface MemcachedCache<K,V>

Parameters:

serverAddress - the specific server's SocketAddress to be removed in this cache

isInServerList

public boolean isInServerList(SocketAddress serverAddress)

Check if this cache contains the given server

Specified by:

isInServerList in interface MemcachedCache<K,V>

Parameters:

serverAddress - the specific server's SocketAddress to be checked

Returns:

true if this cache already contains the given serverAddress

getCurrentServerList

public List<SocketAddress> getCurrentServerList()

Get current server list

Specified by:

getCurrentServerList in interface MemcachedCache<K,V>

Returns:

current server list or empty list if there are no alive servers

isZooKeeperSupported

public boolean isZooKeeperSupported()

Check if this cache supports the ZooKeeper for synchronizing the cache server list

Specified by:

isZooKeeperSupported in interface ZooKeeperSupportCache

Returns:

true if this cache supports it

getZooKeeperServerListPath

public String getZooKeeperServerListPath()

Return the path of the cache server list which has been registered in the ZooKeeper server

Specified by:

getZooKeeperServerListPath in interface ZooKeeperSupportCache

Returns:

the path of the cache server list in the ZooKeeper server. "null" means this cache doesn't support the ZooKeeper or this cache is not started yet

getCurrentServerListFromZooKeeper

public String getCurrentServerListFromZooKeeper()

Return the current cache server list string from the ZooKeeper server

Specified by:

getCurrentServerListFromZooKeeper in interface ZooKeeperSupportCache

Returns:

the current server list string

setCurrentServerListOfZooKeeper

public boolean setCurrentServerListOfZooKeeper(String cacheServerList)

Set the current cache server list string with the given cacheServerList

cacheServerList could be comma separated host:port pairs, each corresponding to a memcached server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002" Be careful that this operation will propagate cacheServerList to caches which has joinned the same cache name(scope) because the cache list of ZooKeeper server will be changed.

Specified by:

setCurrentServerListOfZooKeeper in interface ZooKeeperSupportCache

Parameters:

cacheServerList - the cache server list string

Returns:

true if this cache server list is set successfully

addZooKeeperListener

public void addZooKeeperListener(BarrierListener listener)

Add the custom BarrierListener The given listener will be called after cache's default listener will be completed. BarrierListener.onInit(java.lang.String, java.lang.String, byte[]) will be called when this cache will be registered in the ZooKeeper. BarrierListener.onCommit(java.lang.String, java.lang.String, byte[]) will be called when this cache's server list will be changed in the ZooKeeper. BarrierListener.onDestroy(java.lang.String) will be called when this cache will be unregistered in the ZooKeeper.

Specified by:

addZooKeeperListener in interface ZooKeeperSupportCache

Parameters:

listener - the custom listener

removeZooKeeperListener

public void removeZooKeeperListener(BarrierListener listener)

Remove the custom BarrierListener The given listener will be called after cache's default listener will be completed. BarrierListener.onInit(java.lang.String, java.lang.String, byte[]) will be called when this cache will be registered in the ZooKeeper. BarrierListener.onCommit(java.lang.String, java.lang.String, byte[]) will be called when this cache's server list will be changed in the ZooKeeper. BarrierListener.onDestroy(java.lang.String) will be called when this cache will be unregistered in the ZooKeeper.

Specified by:

removeZooKeeperListener in interface ZooKeeperSupportCache

Parameters:

listener - the custom listener which was given by ZooKeeperSupportCache.addZooKeeperListener(org.glassfish.grizzly.memcached.zookeeper.BarrierListener)

getName

public String getName()

Return the name of the cache.

Specified by:

getName in interface Cache<K,V>

Returns:

the name of the cache.

set

public boolean set(K key,
          V value,
          int expirationInSecs,
          boolean noReply)

Specified by:

set in interface Commands<K,V>

set

public boolean set(K key,
          V value,
          int expirationInSecs,
          boolean noReply,
          long writeTimeoutInMillis,
          long responseTimeoutInMillis)

Specified by:

set in interface MemcachedCache<K,V>

setMulti

public Map<K,Boolean> setMulti(Map<K,V> map,
                      int expirationInSecs)

Specified by:

setMulti in interface MemcachedCache<K,V>

setMulti

public Map<K,Boolean> setMulti(Map<K,V> map,
                      int expirationInSecs,
                      long writeTimeoutInMillis,
                      long responseTimeoutInMillis)

Specified by:

setMulti in interface MemcachedCache<K,V>

add

public boolean add(K key,
          V value,
          int expirationInSecs,
          boolean noReply)

Specified by:

add in interface Commands<K,V>

add

public boolean add(K key,
          V value,
          int expirationInSecs,
          boolean noReply,
          long writeTimeoutInMillis,
          long responseTimeoutInMillis)

Specified by:

add in interface MemcachedCache<K,V>

replace

public boolean replace(K key,
              V value,
              int expirationInSecs,
              boolean noReply)

Specified by:

replace in interface Commands<K,V>

replace

public boolean replace(K key,
              V value,
              int expirationInSecs,
              boolean noReply,
              long writeTimeoutInMillis,
              long responseTimeoutInMillis)

Specified by:

replace in interface MemcachedCache<K,V>

cas

public boolean cas(K key,
          V value,
          int expirationInSecs,
          long cas,
          boolean noReply)

Specified by:

cas in interface Commands<K,V>

cas

public boolean cas(K key,
          V value,
          int expirationInSecs,
          long cas,
          boolean noReply,
          long writeTimeoutInMillis,
          long responseTimeoutInMillis)

Specified by:

cas in interface MemcachedCache<K,V>

casMulti

public Map<K,Boolean> casMulti(Map<K,ValueWithCas<V>> map,
                      int expirationInSecs)

Specified by:

casMulti in interface MemcachedCache<K,V>

casMulti

public Map<K,Boolean> casMulti(Map<K,ValueWithCas<V>> map,
                      int expirationInSecs,
                      long writeTimeoutInMillis,
                      long responseTimeoutInMillis)

Specified by:

casMulti in interface MemcachedCache<K,V>

append

public boolean append(K key,
             V value,
             boolean noReply)

Specified by:

append in interface Commands<K,V>

append

public boolean append(K key,
             V value,
             boolean noReply,
             long writeTimeoutInMillis,
             long responseTimeoutInMillis)

Specified by:

append in interface MemcachedCache<K,V>

prepend

public boolean prepend(K key,
              V value,
              boolean noReply)

Specified by:

prepend in interface Commands<K,V>

prepend

public boolean prepend(K key,
              V value,
              boolean noReply,
              long writeTimeoutInMillis,
              long responseTimeoutInMillis)

Specified by:

prepend in interface MemcachedCache<K,V>

getMulti

public Map<K,V> getMulti(Set<K> keys)

Specified by:

getMulti in interface MemcachedCache<K,V>

getMulti

public Map<K,V> getMulti(Set<K> keys,
                long writeTimeoutInMillis,
                long responseTimeoutInMillis)

Specified by:

getMulti in interface MemcachedCache<K,V>

get

public V get(K key,
    boolean noReply)

Specified by:

get in interface Commands<K,V>

get

public V get(K key,
    boolean noReply,
    long writeTimeoutInMillis,
    long responseTimeoutInMillis)

Specified by:

get in interface MemcachedCache<K,V>

getKey

public ValueWithKey<K,V> getKey(K key,
                       boolean noReply)

Specified by:

getKey in interface Commands<K,V>

getKey

public ValueWithKey<K,V> getKey(K key,
                       boolean noReply,
                       long writeTimeoutInMillis,
                       long responseTimeoutInMillis)

Specified by:

getKey in interface MemcachedCache<K,V>

gets

public ValueWithCas<V> gets(K key,
                   boolean noReply)

Specified by:

gets in interface Commands<K,V>

gets

public ValueWithCas<V> gets(K key,
                   boolean noReply,
                   long writeTimeoutInMillis,
                   long responseTimeoutInMillis)

Specified by:

gets in interface MemcachedCache<K,V>

getsMulti

public Map<K,ValueWithCas<V>> getsMulti(Set<K> keys)

Specified by:

getsMulti in interface MemcachedCache<K,V>

getsMulti

public Map<K,ValueWithCas<V>> getsMulti(Set<K> keys,
                               long writeTimeoutInMillis,
                               long responseTimeoutInMillis)

Specified by:

getsMulti in interface MemcachedCache<K,V>

gat

public V gat(K key,
    int expirationInSecs,
    boolean noReply)

Specified by:

gat in interface Commands<K,V>

gat

public V gat(K key,
    int expirationInSecs,
    boolean noReply,
    long writeTimeoutInMillis,
    long responseTimeoutInMillis)

Specified by:

gat in interface MemcachedCache<K,V>

delete

public boolean delete(K key,
             boolean noReply)

Specified by:

delete in interface Commands<K,V>

delete

public boolean delete(K key,
             boolean noReply,
             long writeTimeoutInMillis,
             long responseTimeoutInMillis)

Description copied from interface: MemcachedCache

delete the item with the given key in memcached

Specified by:

delete in interface MemcachedCache<K,V>

Parameters:

key - item's key

noReply - whether you need to receive a reply or not. true means the quiet operation(no reply).

writeTimeoutInMillis - write timeout

responseTimeoutInMillis - response timeout

Returns:

true if the key and the corresponding item is deleted successfully in memcached. false if the deletion is failed(ex. timeout, io failures, ...). Note) true will be returned when the key doesn't exist in memcached(since v1.3.2)

deleteMulti

public Map<K,Boolean> deleteMulti(Set<K> keys)

Specified by:

deleteMulti in interface MemcachedCache<K,V>

deleteMulti

public Map<K,Boolean> deleteMulti(Set<K> keys,
                         long writeTimeoutInMillis,
                         long responseTimeoutInMillis)

Specified by:

deleteMulti in interface MemcachedCache<K,V>

incr

public long incr(K key,
        long delta,
        long initial,
        int expirationInSecs,
        boolean noReply)

Specified by:

incr in interface Commands<K,V>

incr

public long incr(K key,
        long delta,
        long initial,
        int expirationInSecs,
        boolean noReply,
        long writeTimeoutInMillis,
        long responseTimeoutInMillis)

Specified by:

incr in interface MemcachedCache<K,V>

decr

public long decr(K key,
        long delta,
        long initial,
        int expirationInSecs,
        boolean noReply)

Specified by:

decr in interface Commands<K,V>

decr

public long decr(K key,
        long delta,
        long initial,
        int expirationInSecs,
        boolean noReply,
        long writeTimeoutInMillis,
        long responseTimeoutInMillis)

Specified by:

decr in interface MemcachedCache<K,V>

saslAuth

public String saslAuth(SocketAddress address,
              String mechanism,
              byte[] data)

Specified by:

saslAuth in interface Commands<K,V>

saslAuth

public String saslAuth(SocketAddress address,
              String mechanism,
              byte[] data,
              long writeTimeoutInMillis,
              long responseTimeoutInMillis)

Specified by:

saslAuth in interface MemcachedCache<K,V>

saslStep

public String saslStep(SocketAddress address,
              String mechanism,
              byte[] data)

Specified by:

saslStep in interface Commands<K,V>

saslStep

public String saslStep(SocketAddress address,
              String mechanism,
              byte[] data,
              long writeTimeoutInMillis,
              long responseTimeoutInMillis)

Specified by:

saslStep in interface MemcachedCache<K,V>

saslList

public String saslList(SocketAddress address)

Specified by:

saslList in interface Commands<K,V>

saslList

public String saslList(SocketAddress address,
              long writeTimeoutInMillis,
              long responseTimeoutInMillis)

Specified by:

saslList in interface MemcachedCache<K,V>

stats

public Map<String,String> stats(SocketAddress address)

Specified by:

stats in interface Commands<K,V>

stats

public Map<String,String> stats(SocketAddress address,
                       long writeTimeoutInMillis,
                       long responseTimeoutInMillis)

Specified by:

stats in interface MemcachedCache<K,V>

statsItems

public Map<String,String> statsItems(SocketAddress address,
                            String item)

Specified by:

statsItems in interface Commands<K,V>

statsItems

public Map<String,String> statsItems(SocketAddress address,
                            String item,
                            long writeTimeoutInMillis,
                            long responseTimeoutInMillis)

Specified by:

statsItems in interface MemcachedCache<K,V>

quit

public boolean quit(SocketAddress address,
           boolean noReply)

Specified by:

quit in interface Commands<K,V>

quit

public boolean quit(SocketAddress address,
           boolean noReply,
           long writeTimeoutInMillis,
           long responseTimeoutInMillis)

Specified by:

quit in interface MemcachedCache<K,V>

flushAll

public boolean flushAll(SocketAddress address,
               int expirationInSecs,
               boolean noReply)

Specified by:

flushAll in interface Commands<K,V>

flushAll

public boolean flushAll(SocketAddress address,
               int expirationInSecs,
               boolean noReply,
               long writeTimeoutInMillis,
               long responseTimeoutInMillis)

Specified by:

flushAll in interface MemcachedCache<K,V>

touch

public boolean touch(K key,
            int expirationInSecs)

Specified by:

touch in interface Commands<K,V>

touch

public boolean touch(K key,
            int expirationInSecs,
            long writeTimeoutInMillis,
            long responseTimeoutInMillis)

Specified by:

touch in interface MemcachedCache<K,V>

noop

public boolean noop(SocketAddress address)

Specified by:

noop in interface Commands<K,V>

noop

public boolean noop(SocketAddress address,
           long writeTimeoutInMillis,
           long responseTimeoutInMillis)

Specified by:

noop in interface MemcachedCache<K,V>

verbosity

public boolean verbosity(SocketAddress address,
                int verbosity)

Specified by:

verbosity in interface Commands<K,V>

verbosity

public boolean verbosity(SocketAddress address,
                int verbosity,
                long writeTimeoutInMillis,
                long responseTimeoutInMillis)

Specified by:

verbosity in interface MemcachedCache<K,V>

version

public String version(SocketAddress address)

Specified by:

version in interface Commands<K,V>

version

public String version(SocketAddress address,
             long writeTimeoutInMillis,
             long responseTimeoutInMillis)

Specified by:

version in interface MemcachedCache<K,V>

toString

public String toString()

Overrides:

toString in class Object