com.google.code.ssm.providers

Interface CacheClient

All Known Implementing Classes:

AbstractMemcacheClientWrapper, MemcacheClientWrapper, MemcacheClientWrapper, MemcacheClientWrapper

public interface CacheClient

Since:

2.0.0

Author:

Jakub Białek

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)
void	delete(Collection<String> keys) Deletes values under given keys.
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 exp)
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.

Method Detail

add

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

Throws:

TimeoutException

CacheException

add

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

Throws:

TimeoutException

CacheException

decr

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

Throws:

TimeoutException

CacheException

decr

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

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

Object get(String key)
    throws TimeoutException,
           CacheException

Get value by key.

Parameters:

key - the key

Returns:

value associated with given key or null

Throws:

TimeoutException

CacheException

get

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

Get value by key.

Type Parameters:

T -

Parameters:

key - the key

transcoder - the transcoder to use

Returns:

value associated with given key or null

Throws:

TimeoutException

CacheException

get

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

Get value by key.

Type Parameters:

T -

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

Collection<SocketAddress> getAvailableServers()

Gets available cache servers.

Returns:

collection of cache servers

getBulk

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

Throws:

TimeoutException

CacheException

getBulk

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

Throws:

TimeoutException

CacheException

getTranscoder

CacheTranscoder getTranscoder()

Gets default transcoder.

Returns:

default transcoder

incr

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

Throws:

TimeoutException

CacheException

incr

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

Throws:

TimeoutException

CacheException

incr

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

Throws:

TimeoutException

CacheException

set

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

Throws:

TimeoutException

CacheException

set

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

Store key-value item to memcached.

Type Parameters:

T -

Parameters:

key - stored key

exp - expire time

value - stored data

transcoder - the transcoder to use

Returns:

boolean result

Throws:

TimeoutException

CacheException

shutdown

void shutdown()

Shutdowns memcached client.

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