net.itrixlabs.cache.user

Class SerializableUserCache<V>

java.lang.Object

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

net.itrixlabs.cache.user.SerializableUserCache<V>

All Implemented Interfaces:

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

public class SerializableUserCache<V>
extends AbstractFileSystemCache<V>

Efficient implementation of ApplicationCache for authentication sub-systems.

Since:

November 11^th, 2015

Author:

Abhinav Rai

See Also:

Serialized Form

Field Summary

Fields inherited from class net.itrixlabs.cache.ext.AbstractFileSystemCache

cache

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	evictFromCache(Object key) Removes the specified entry from the cache.
V	getFromCache(Object key) Obtains a stored entry from the cache.
void	putInCache(Object key, V entry) Places an entry in the cache.

Methods inherited from class net.itrixlabs.cache.ext.AbstractFileSystemCache

afterPropertiesSet, destroy, flush, generate, initialize, setCacheDir, setCacheFile, setTtl, setTtlUnit

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializableUserCache

public SerializableUserCache(CacheType type)

SerializableUserCache

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

Method Detail

getFromCache

public V getFromCache(Object key)

Description copied from interface: ApplicationCache

Obtains a stored entry from the cache. Implementations must make sure not to throw an exception even if one occurs here.

Parameters:

key - the unique identifier to use for fetching the entry; be advised that the same identifier must be used for saving the details into the cache

Returns:

a populated entry object containing enough information to facilitate the function it is required for; if none is found

putInCache

public void putInCache(Object key,
                       V entry)

Description copied from interface: ApplicationCache

Places an entry in the cache. The key is the identifier used to subsequently retrieve the entry.

Parameters:

key - the key corresponding to which entry must be stored in the cache

entry - the object entry to place into the cache

evictFromCache

public void evictFromCache(Object key)

Description copied from interface: ApplicationCache

Removes the specified entry from the cache. The key is the identifier used to remove the entry. If the entry is not found, the method should simply return (not throw an exception).

Some cache implementations may not support eviction from the cache, in which case they should provide appropriate behavior to alter the token in either its documentation, via an exception, or through a log message.

Parameters:

key - the predefined key/identifier for evicting an entry from the cache