net.itrixlabs.cache.auth

Class SerializableAuthCache<V>

java.lang.Object

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

net.itrixlabs.cache.auth.SerializableAuthCache<V>

All Implemented Interfaces:

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

public class SerializableAuthCache<V>
extends AbstractFileSystemCache<V>

Simple implementation of ApplicationCache for authorization sub-systems.

Authorization providers can simply invoke an instance of this class in order to utilize its caching capabilities. Authorization specific customizations can be added in future. Anyways, the API is closed for modification (to prevent harm you might cause to your application) but open for extension.

Since:

November 11^th, 2015

Author:

Abhinav Rai

See Also:

AbstractFileSystemCache, Serialized Form

Field Summary

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

cache, ttl, ttlUnit

Constructor Summary

Constructors

Constructor and Description
SerializableAuthCache() Constructs a SerializableAuthCache.
SerializableAuthCache(String cacheDir, String cacheFile) Constructs a SerializableAuthCache with the given type of auth token, the cache storage directory and cache file name.

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.core.AbstractFileSystemCache

afterPropertiesSet, destroy, flush, generate, getTtl, getTtlUnit, initialize, isPresentInCache, setCacheDir, setCacheFile, setTtl

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializableAuthCache

public SerializableAuthCache()

Constructs a SerializableAuthCache. Sensible defaults will be used for required parameters unless explicitly set. An application can typically have several instances of auth cache to store different types of auth tokens (for example, a scenario with multiple authentication/authorization providers using different user details services).

SerializableAuthCache

public SerializableAuthCache(String cacheDir,
                             String cacheFile)

Constructs a SerializableAuthCache with the given type of auth token, the cache storage directory and cache file name. Provides better control on caching strategy out of the box. An application can typically have several instances of auth cache to store different types of auth tokens (for example, a scenario with multiple authentication/authorization providers using different user details services).

Parameters:

cacheDir - the cache directory location to use

cacheFile - the cache file name

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.

Important: Note that you may use any well known java type as key like Long or String or a custom type as long as it abides by the contract defined by the Key interface, i.e., the key should be uniquely identifiable using its value and not the Key instance as whole. In short, you must override the Object.equals(Object) and Object.hashCode() methods of that particular key type to make sure your identifier can be uniquely distinguished from with-in the cache.

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.

Important: Note that you may use any well known java type as key like Long or String or a custom type as long as it abides by the contract defined by the Key interface, i.e., the key should be uniquely identifiable using its value and not the Key instance as whole. In short, you must override the Object.equals(Object) and Object.hashCode() methods of that particular key type to make sure your identifier can be uniquely distinguished from with-in the cache.

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.

Important: Note that you may use any well known java type as key like Long or String or a custom type as long as it abides by the contract defined by the Key interface, i.e., the key should be uniquely identifiable using its value and not the Key instance as whole. In short, you must override the Object.equals(Object) and Object.hashCode() methods of that particular key type to make sure your identifier can be uniquely distinguished from with-in the cache.

Parameters:

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