com.google.code.ssm.providers.spymemcached

Class MemcacheClientWrapper

java.lang.Object

com.google.code.ssm.providers.AbstractMemcacheClientWrapper

com.google.code.ssm.providers.spymemcached.MemcacheClientWrapper

All Implemented Interfaces:

CacheClient

class MemcacheClientWrapper
extends AbstractMemcacheClientWrapper

Since:

2.0.0

Author:

Jakub Białek

Constructor Summary

Constructors

Constructor and Description
MemcacheClientWrapper(net.spy.memcached.MemcachedClientIF memcachedClient)

Method Summary

Modifier and Type	Method and Description
boolean	add(String key, int exp, Object value)
<T> boolean	add(String key, int exp, T value, CacheTranscoder transcoder)
long	decr(String key, int by)
long	decr(String key, int by, long def)
boolean	delete(String key) Deletes value under given key.
void	flush() Flushes all data.
Object	get(String key) Get value by key.
<T> T	get(String key, CacheTranscoder transcoder) Get value by key.
<T> T	get(String key, CacheTranscoder transcoder, long timeout) Get value by key.
Collection<SocketAddress>	getAvailableServers() Gets available cache servers.
Map<String,Object>	getBulk(Collection<String> keys)
<T> Map<String,T>	getBulk(Collection<String> keys, CacheTranscoder transcoder)
Object	getNativeClient() Expose native memcached client.
CacheTranscoder	getTranscoder() Gets default transcoder.
long	incr(String key, int by)
long	incr(String key, int by, long def)
long	incr(String key, int by, long def, int expiration)
boolean	set(String key, int exp, Object value)
<T> boolean	set(String key, int exp, T value, CacheTranscoder transcoder) Store key-value item to memcached.
void	shutdown() Shutdowns memcached client.

Methods inherited from class com.google.code.ssm.providers.AbstractMemcacheClientWrapper

delete

Methods inherited from class java.lang.Object

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

Constructor Detail

MemcacheClientWrapper

MemcacheClientWrapper(net.spy.memcached.MemcachedClientIF memcachedClient)

Method Detail

add

public boolean add(String key,
                   int exp,
                   Object value)
            throws TimeoutException,
                   CacheException

Throws:

TimeoutException

CacheException

add

public <T> boolean add(String key,
                       int exp,
                       T value,
                       CacheTranscoder transcoder)
                throws TimeoutException,
                       CacheException

Throws:

TimeoutException

CacheException

decr

public long decr(String key,
                 int by)
          throws TimeoutException,
                 CacheException

Throws:

TimeoutException

CacheException

decr

public long decr(String key,
                 int by,
                 long def)
          throws TimeoutException,
                 CacheException

Throws:

TimeoutException

CacheException

delete

public boolean delete(String key)
               throws TimeoutException,
                      CacheException

Description copied from interface: CacheClient

Deletes value under given key.

Parameters:

key - the key

Throws:

TimeoutException

CacheException

flush

public void flush()
           throws CacheException

Description copied from interface: CacheClient

Flushes all data.

Throws:

CacheException

get

public Object get(String key)
           throws TimeoutException,
                  CacheException

Description copied from interface: CacheClient

Get value by key.

Parameters:

key - the key

Returns:

value associated with given key or null

Throws:

TimeoutException

CacheException

get

public <T> T get(String key,
                 CacheTranscoder transcoder)
          throws CacheException,
                 TimeoutException

Description copied from interface: CacheClient

Get value by key.

Parameters:

key - the key

transcoder - the transcoder to use

Returns:

value associated with given key or null

Throws:

CacheException

TimeoutException

get

public <T> T get(String key,
                 CacheTranscoder transcoder,
                 long timeout)
          throws TimeoutException,
                 CacheException

Description copied from interface: CacheClient

Get value by key.

Parameters:

key - the key

transcoder - the transcoder to use

timeout - the timeout, if the method is not returned in this time, throws TimeoutException

Returns:

value associated with given key or null

Throws:

TimeoutException

CacheException

getAvailableServers

public Collection<SocketAddress> getAvailableServers()

Description copied from interface: CacheClient

Gets available cache servers.

Returns:

collection of cache servers

getBulk

public Map<String,Object> getBulk(Collection<String> keys)
                           throws TimeoutException,
                                  CacheException

Throws:

TimeoutException

CacheException

getBulk

public <T> Map<String,T> getBulk(Collection<String> keys,
                                 CacheTranscoder transcoder)
                          throws TimeoutException,
                                 CacheException

Throws:

TimeoutException

CacheException

incr

public long incr(String key,
                 int by)
          throws TimeoutException,
                 CacheException

Throws:

TimeoutException

CacheException

incr

public long incr(String key,
                 int by,
                 long def)
          throws TimeoutException,
                 CacheException

Throws:

TimeoutException

CacheException

incr

public long incr(String key,
                 int by,
                 long def,
                 int expiration)
          throws TimeoutException,
                 CacheException

Throws:

TimeoutException

CacheException

set

public boolean set(String key,
                   int exp,
                   Object value)
            throws TimeoutException,
                   CacheException

Throws:

TimeoutException

CacheException

set

public <T> boolean set(String key,
                       int exp,
                       T value,
                       CacheTranscoder transcoder)
                throws TimeoutException,
                       CacheException

Description copied from interface: CacheClient

Store key-value item to memcached.

Parameters:

key - stored key

exp - expire time

value - stored data

transcoder - the transcoder to use

Returns:

boolean result

Throws:

TimeoutException

CacheException

shutdown

public void shutdown()

Description copied from interface: CacheClient

Shutdowns memcached client.

getTranscoder

public CacheTranscoder getTranscoder()

Description copied from interface: CacheClient

Gets default transcoder.

Returns:

default transcoder

getNativeClient

public Object getNativeClient()

Description copied from interface: CacheClient

Expose native memcached client. Do not store reference to this client because it can change in runtime when using some feature (like runtime memcached nodes switching).

Returns:

current instance of native memcached client