org.osgl.cache

Interface CacheService

public interface CacheService

Defines a cache service

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEF_CACHE_NAME

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all cached items
int	decr(String key) Decrease an number type value associated with key key by 1
int	decr(String key, int ttl) Decrease an number type value associated with key key by 1 with expires specified
void	evict(String key) Remove an item from the cache service by key
<T> T	get(String key) Return an item from the cache service by key
int	incr(String key) Increase an number type value associated with key key by 1
int	incr(String key, int ttl) Increase an number type value associated with key key with expires specified
void	put(String key, Object value) Store an item into the cache by key and use default ttl
void	put(String key, Object value, int ttl) Store an item into the cache service by key and set ttl value
void	setDefaultTTL(int ttl) Set default ttl value which will be used if user pass 0 as ttl or not specified ttl Note some service might not favor this method after the internal cache service is initialized.
void	shutdown() Shutdown the cache service
void	startup() Restart the cache service after shutdown

Field Detail

DEF_CACHE_NAME

static final String DEF_CACHE_NAME

See Also:

Constant Field Values

Method Detail

put

void put(String key,
         Object value,
         int ttl)

Store an item into the cache service by key and set ttl value

Parameters:

key - the cache key

value - the object to be cached

ttl - time to live of the cached item. Time unit is second. If set to negative number, then it will never expire. If set to zero then the default ttl value will be used

put

void put(String key,
         Object value)

Store an item into the cache by key and use default ttl

Parameters:

key - the cache key

value - the object to be cached

evict

void evict(String key)

Remove an item from the cache service by key

Parameters:

key - the cache key

get

<T> T get(String key)

Return an item from the cache service by key

Type Parameters:

T - the generic type of the return value

Parameters:

key - the cache key

Returns:

the value associated with the key

incr

int incr(String key)

Increase an number type value associated with key key by 1

If no value is associated with the key, then it will associate number 1 to key and return 0.

Parameters:

key - the key index the numeric value

Returns:

the int value before increment operation happening.

incr

int incr(String key,
         int ttl)

Increase an number type value associated with key key with expires specified

If no value is associated with the key, then it will associate number 1 to key and return 0.

Parameters:

key - the key index the numeric value

ttl - the number of seconds the key to expire

Returns:

the int value before increment operation happening.

decr

int decr(String key)

Decrease an number type value associated with key key by 1

If no value is associated with the key, then it will associate number -1 to key and return 0.

Parameters:

key - the key index the numeric value

Returns:

the int value before decrement operation happening.

decr

int decr(String key,
         int ttl)

Decrease an number type value associated with key key by 1 with expires specified

If no value is associated with the key, then it will associate number -1 to key and return 0.

Parameters:

key - the key index the numeric value

ttl - the number of seconds the key to expire

Returns:

the int value before decrement operation happening.

clear

void clear()

Remove all cached items

setDefaultTTL

void setDefaultTTL(int ttl)

Set default ttl value which will be used if user pass 0 as ttl or not specified ttl Note some service might not favor this method after the internal cache service is initialized. E.g. memcached and ehcaches

Parameters:

ttl - the default ttl value in seconds

shutdown

void shutdown()

Shutdown the cache service

startup

void startup()

Restart the cache service after shutdown

Note, by default the cache service should be started after initialized