com.deviceatlas.cloud.deviceidentification.cacheprovider

Interface CacheProvider

All Known Implementing Classes:

EhCacheCacheProvider, FileCacheProvider, MemcachedCacheProvider, MockCacheProvider, SimpleCacheProvider

public interface CacheProvider

Cache Provider interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Entirely clear the cache content
<T> T	get(java.lang.String key) Getting an entry on the cache
java.util.List<java.lang.String>	getKeys() Returns all keys from a given cache
void	remove(java.lang.String key) Removes an entry in the cache
<T> void	set(java.lang.String key, T entry) Adding an entry to the cache
void	setExpiry(int expiry) Reconfigure the expiry after
void	shutdown() Shutdown the general cache framework

Method Detail

get

<T> T get(java.lang.String key)
      throws CacheException

Getting an entry on the cache

Type Parameters:

T - cache entry

Parameters:

key - key of the cache entry

Returns:

Object

Throws:

CacheException - when there is cache issues getting by key

set

<T> void set(java.lang.String key,
           T entry)
         throws CacheException

Adding an entry to the cache

Type Parameters:

T - cache entry

Parameters:

key - key of the cache entry

entry - cache entry

Throws:

CacheException - when there is cache issues setting an element

remove

void remove(java.lang.String key)
            throws CacheException

Removes an entry in the cache

Parameters:

key - key of the cache entry

Throws:

CacheException - when there is cache issues removing an entry

clear

void clear()

Entirely clear the cache content

shutdown

void shutdown()

Shutdown the general cache framework

getKeys

java.util.List<java.lang.String> getKeys()

Returns all keys from a given cache

Returns:

List

setExpiry

void setExpiry(int expiry)

Reconfigure the expiry after

Parameters:

expiry - cache time life in minutes