net.itrixlabs.cache.ext

Class AbstractFileSystemCache<V>

java.lang.Object

net.itrixlabs.cache.ext.AbstractFileSystemCache<V>

All Implemented Interfaces:

Serializable, ApplicationCache<Key,V>, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

SerializableAuthCache, SerializableCsrfCache, SerializableUserCache

public abstract class AbstractFileSystemCache<V>
extends Object
implements ApplicationCache<Key,V>, Serializable

Extends the ApplicationCache contract providing base for using file system as storage for the cache.

Since:

November 11^th, 2015

Author:

Abhinav Rai

See Also:

ApplicationCache, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ConcurrentMap<Key,V>	cache

Constructor Summary

Constructors

Constructor and Description
AbstractFileSystemCache()
AbstractFileSystemCache(CacheType type)
AbstractFileSystemCache(CacheType type, String cacheDir, String cacheFile)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	destroy()
void	flush() Flushes the application cache (doesn't destroy it).
protected Key	generate(Object identifier)
void	initialize() Initializes the application cache (doesn't create it).
AbstractFileSystemCache<V>	setCacheDir(String cacheDir) Sets the cache directory location to use with the particular type of cache in focus.
AbstractFileSystemCache<V>	setCacheFile(String cacheFile) Sets the cache filename to use with the particular type of cache in focus.
AbstractFileSystemCache<V>	setTtl(Long ttl) Sets the time-to-live for an entry in cache.
AbstractFileSystemCache<V>	setTtlUnit(TimeUnit ttlUnit) Sets the time unit for cache entry time-to-live strategy.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.itrixlabs.cache.core.ApplicationCache

evictFromCache, getFromCache, putInCache

Field Detail

cache

protected final ConcurrentMap<Key,V> cache

Constructor Detail

AbstractFileSystemCache

public AbstractFileSystemCache()

AbstractFileSystemCache

public AbstractFileSystemCache(CacheType type)

AbstractFileSystemCache

public AbstractFileSystemCache(CacheType type,
                               String cacheDir,
                               String cacheFile)

Method Detail

initialize

public void initialize()

Description copied from interface: ApplicationCache

Initializes the application cache (doesn't create it). Can make use of a data-store for pre-fetching already stored application data (if required) typically upon container restart.

Each type of application cache is initialized separately in order to maintain sanity and usage simplicity. Thus, please be advised that a cache type must be instantiated & initialized manually before use (manually just means that extra code is required for the same).

Specified by:

initialize in interface ApplicationCache<Key,V>

generate

protected Key generate(Object identifier)

flush

public void flush()

Description copied from interface: ApplicationCache

Flushes the application cache (doesn't destroy it). Note that flushing an application cache doesn't mean it is destroyed. It may just be reduced in size or cleared in order to re-claim memory.

Each type of application cache is flushed separately in order to maintain sanity and usage simplicity. Thus, please be advised that a cache type must be flushed & manually whenever required (manually just means that extra code is required for the same).

Specified by:

flush in interface ApplicationCache<Key,V>

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

setTtl

public AbstractFileSystemCache<V> setTtl(Long ttl)

Sets the time-to-live for an entry in cache.

Parameters:

ttl - the ttl to set

Returns:

AbstractFileSystemCache for further customization

setTtlUnit

public AbstractFileSystemCache<V> setTtlUnit(TimeUnit ttlUnit)

Sets the time unit for cache entry time-to-live strategy.

Parameters:

ttlUnit - the ttl time unit to set

Returns:

AbstractFileSystemCache for further customization

setCacheDir

public AbstractFileSystemCache<V> setCacheDir(String cacheDir)

Sets the cache directory location to use with the particular type of cache in focus.

Parameters:

cacheDir - the cache directory location to use

Returns:

AbstractFileSystemCache for further customization

setCacheFile

public AbstractFileSystemCache<V> setCacheFile(String cacheFile)

Sets the cache filename to use with the particular type of cache in focus.

Parameters:

cacheFile - the cache filename to use

Returns:

AbstractFileSystemCache for further customization