com.google.code.ssm

Interface Cache

All Known Implementing Classes:

CacheImpl, PrefixedCacheImpl

public interface Cache

Since:

2.0.0

Author:

Jakub Białek

Method Summary

Modifier and Type	Method and Description
<T> boolean	add(String key, int expiration, Object value, SerializationType serializationType) Add object to cache if it doesn't exist.
<T> boolean	addSilently(String key, 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 key) 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 expiration) Increments counter in cache by given value.
boolean	isEnabled()
<T> void	set(String key, int expiration, Object value, SerializationType serializationType) Store key-value item to memcached.
void	setCounter(String key, int expiration, long value) Sets initial value of counter.
<T> void	setSilently(String key, int expiration, Object value, SerializationType serializationType) Store key-value item to memcached.
void	shutdown() Shutdowns cache.

Method Detail

getAvailableServers

Collection<SocketAddress> getAvailableServers()

Gets available cache servers.

Returns:

collection of cache servers

getName

String getName()

Gets name of the cache.

Returns:

the name of cache

getAliases

Collection<String> getAliases()

Gets optional cache's aliases.

Returns:

the optional aliases of cache

getProperties

CacheProperties getProperties()

Returns:

the properties of cache

Since:

3.3.0

isEnabled

boolean isEnabled()

Returns:

true if cache is enabled

Since:

3.5.0

add

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

Add object to cache if it doesn't exist.

Parameters:

key - the key

expiration - 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

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

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

Parameters:

key - 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

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

Decrement counter in cache by given value.

Parameters:

key - the key

by - decrement value

Returns:

current counter's value

Throws:

TimeoutException

CacheException

delete

boolean delete(String key)
        throws TimeoutException,
               CacheException

Deletes value under given key.

Parameters:

key - the key

Throws:

TimeoutException

CacheException

delete

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

Deletes values under given keys.

Parameters:

keys -

Throws:

TimeoutException

CacheException

flush

void flush()
    throws TimeoutException,
           CacheException

Flushes all data.

Throws:

TimeoutException

CacheException

get

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

Get value by key.

Type Parameters:

T -

Parameters:

key - the key

serializationType - the type of serialization to use

Returns:

value associated with given key or null

Throws:

TimeoutException

CacheException

getBulk

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

Throws:

TimeoutException

CacheException

incr

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

Increments counter in cache by given value.

Parameters:

key - the key

by - increment value

def - initial value

Returns:

Throws:

TimeoutException

CacheException

incr

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

Increments counter in cache by given value.

Parameters:

key - the key

by - increment value

def - initial value

expiration - expiration time in seconds as defined in memcached specification

Returns:

Throws:

TimeoutException

CacheException

set

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

Store key-value item to memcached.

Type Parameters:

T -

Parameters:

key - stored key

expiration - expiration time in seconds as defined in memcached specification

value - stored data

serializationType - the type of serialization to use

Throws:

TimeoutException

CacheException

setSilently

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

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

Type Parameters:

T -

Parameters:

key - stored key

expiration - expiration time in seconds as defined in memcached specification

value - stored data

serializationType - the type of serialization to use

Throws:

TimeoutException

CacheException

getCounter

Long getCounter(String key)
         throws TimeoutException,
                CacheException

Gets counter from cache without incrementing.

Parameters:

key -

Returns:

the value of counter

Throws:

CacheException

TimeoutException

setCounter

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

Sets initial value of counter.

Parameters:

key - the key

expiration - expiration time in seconds as defined in memcached specification

value - the value

Throws:

CacheException

TimeoutException

shutdown

void shutdown()

Shutdowns cache.

getNativeClient

Object getNativeClient()

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

Since:

3.5.0