com.google.code.ssm

Class PrefixedCacheImpl

java.lang.Object

com.google.code.ssm.PrefixedCacheImpl

All Implemented Interfaces:

Cache

public class PrefixedCacheImpl
extends Object
implements Cache

Since:

3.3.0

Author:

Jakub Białek

Constructor Summary

Constructors

Constructor and Description
PrefixedCacheImpl(Cache cache, String requestedName, String namePrefixSeparator)

Method Summary

Modifier and Type	Method and Description
<T> boolean	add(String key, int exp, Object value, SerializationType serializationType) Add object to cache if it doesn't exist.
<T> boolean	addSilently(String cacheKey, int expiration, Object value, SerializationType serializationType) Add object to cache if it doesn't exist.
long	decr(String key, int by) Decrement counter in cache by given value.
void	delete(Collection<String> keys) Deletes values under given keys.
boolean	delete(String key) Deletes value under given key.
void	flush() Flushes all data.
<T> T	get(String key, SerializationType serializationType) Get value by key.
Collection<String>	getAliases() Gets optional cache's aliases.
Collection<SocketAddress>	getAvailableServers() Gets available cache servers.
Map<String,Object>	getBulk(Collection<String> keys, SerializationType serializationType)
Long	getCounter(String cacheKey) Gets counter from cache without incrementing.
String	getName() Gets name of the cache.
Object	getNativeClient() Expose native memcached client.
CacheProperties	getProperties()
long	incr(String key, int by, long def) Increments counter in cache by given value.
long	incr(String key, int by, long def, int exp) Increments counter in cache by given value.
boolean	isEnabled()
<T> void	set(String key, int exp, Object value, SerializationType serializationType) Store key-value item to memcached.
void	setCounter(String cacheKey, int expiration, long value) Sets initial value of counter.
<T> void	setSilently(String cacheKey, int expiration, Object value, SerializationType serializationType) Store key-value item to memcached.
void	shutdown() Shutdowns cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrefixedCacheImpl

public PrefixedCacheImpl(Cache cache,
                         String requestedName,
                         String namePrefixSeparator)

Method Detail

getAvailableServers

public Collection<SocketAddress> getAvailableServers()

Description copied from interface: Cache

Gets available cache servers.

Specified by:

getAvailableServers in interface Cache

Returns:

collection of cache servers

getName

public String getName()

Description copied from interface: Cache

Gets name of the cache.

Specified by:

getName in interface Cache

Returns:

the name of cache

getAliases

public Collection<String> getAliases()

Description copied from interface: Cache

Gets optional cache's aliases.

Specified by:

getAliases in interface Cache

Returns:

the optional aliases of cache

getProperties

public CacheProperties getProperties()

Specified by:

getProperties in interface Cache

Returns:

the properties of cache

add

public <T> boolean add(String key,
                       int exp,
                       Object value,
                       SerializationType serializationType)
                throws TimeoutException,
                       CacheException

Description copied from interface: Cache

Add object to cache if it doesn't exist.

Specified by:

add in interface Cache

Parameters:

key - the key

exp - expiration time in seconds as defined in memcached specification

value - the value to add

serializationType - type of serialization

Returns:

true if a mutation has occurred (object didn't exist in cache)

Throws:

TimeoutException

CacheException

addSilently

public <T> boolean addSilently(String cacheKey,
                               int expiration,
                               Object value,
                               SerializationType serializationType)

Description copied from interface: Cache

Add object to cache if it doesn't exist. Some exceptions are muted by this method.

Specified by:

addSilently in interface Cache

Parameters:

cacheKey - the cache key

expiration - the expiration time in seconds as defined in memcached specification

value - the value to add

serializationType - the type of serialization

Returns:

decr

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

Description copied from interface: Cache

Decrement counter in cache by given value.

Specified by:

decr in interface Cache

Parameters:

key - the key

by - decrement value

Returns:

current counter's value

Throws:

TimeoutException

CacheException

delete

public boolean delete(String key)
               throws TimeoutException,
                      CacheException

Description copied from interface: Cache

Deletes value under given key.

Specified by:

delete in interface Cache

Parameters:

key - the key

Throws:

TimeoutException

CacheException

delete

public void delete(Collection<String> keys)
            throws TimeoutException,
                   CacheException

Description copied from interface: Cache

Deletes values under given keys.

Specified by:

delete in interface Cache

Throws:

TimeoutException

CacheException

flush

public void flush()
           throws TimeoutException,
                  CacheException

Description copied from interface: Cache

Flushes all data.

Specified by:

flush in interface Cache

Throws:

TimeoutException

CacheException

get

public <T> T get(String key,
                 SerializationType serializationType)
          throws TimeoutException,
                 CacheException

Description copied from interface: Cache

Get value by key.

Specified by:

get in interface Cache

Parameters:

key - the key

serializationType - the type of serialization to use

Returns:

value associated with given key or null

Throws:

TimeoutException

CacheException

getBulk

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

Specified by:

getBulk in interface Cache

Throws:

TimeoutException

CacheException

incr

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

Description copied from interface: Cache

Increments counter in cache by given value.

Specified by:

incr in interface Cache

Parameters:

key - the key

by - increment value

def - initial value

Returns:

Throws:

TimeoutException

CacheException

incr

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

Description copied from interface: Cache

Increments counter in cache by given value.

Specified by:

incr in interface Cache

Parameters:

key - the key

by - increment value

def - initial value

exp - expiration time in seconds as defined in memcached specification

Returns:

Throws:

TimeoutException

CacheException

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Cache

Returns:

true if cache is enabled

set

public <T> void set(String key,
                    int exp,
                    Object value,
                    SerializationType serializationType)
             throws TimeoutException,
                    CacheException

Description copied from interface: Cache

Store key-value item to memcached.

Specified by:

set in interface Cache

Parameters:

key - stored key

exp - expiration time in seconds as defined in memcached specification

value - stored data

serializationType - the type of serialization to use

Throws:

TimeoutException

CacheException

setSilently

public <T> void setSilently(String cacheKey,
                            int expiration,
                            Object value,
                            SerializationType serializationType)

Description copied from interface: Cache

Store key-value item to memcached. Mute some exceptions.

Specified by:

setSilently in interface Cache

Parameters:

cacheKey - stored key

expiration - expiration time in seconds as defined in memcached specification

value - stored data

serializationType - the type of serialization to use

getCounter

public Long getCounter(String cacheKey)
                throws TimeoutException,
                       CacheException

Description copied from interface: Cache

Gets counter from cache without incrementing.

Specified by:

getCounter in interface Cache

Returns:

the value of counter

Throws:

TimeoutException

CacheException

setCounter

public void setCounter(String cacheKey,
                       int expiration,
                       long value)
                throws TimeoutException,
                       CacheException

Description copied from interface: Cache

Sets initial value of counter.

Specified by:

setCounter in interface Cache

Parameters:

cacheKey - the key

expiration - expiration time in seconds as defined in memcached specification

value - the value

Throws:

TimeoutException

CacheException

shutdown

public void shutdown()

Description copied from interface: Cache

Shutdowns cache.

Specified by:

shutdown in interface Cache

getNativeClient

public Object getNativeClient()

Description copied from interface: Cache

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).

Specified by:

getNativeClient in interface Cache

Returns:

current instance of native memcached client