com.bankframe.services.cache
Interface Cache

All Superinterfaces:

Map

All Known Subinterfaces:

JMSCache, PersistentCache

All Known Implementing Classes:

GenericCache, JMSCacheImpl, MergedDataPacketsCache, NullCache, ThreadCleanedCache, ThreadCleanedJMSCache

public interface Cache
extends Map

This interface defines the the caching in MCA services

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

void	addCacheListener(Object key, CacheListener listener) Adds a CacheListener for a specified key.
void	cleanup() This method cleans up the cache by removing un-needed entries
void	enableCaching(boolean enableCache) This method enables or disables caching.
CachePolicy	getCachePolicy() This method gets the CachePolicy object for this Cache
void	remove(Set keySet) This method removes the specified keys from the cache and the data store
void	removeAll() Removes all objects from the cache and from the data store.
void	removeCacheListener(Object key, CacheListener listener) Removes a CacheListener for a specified key.
void	setCachePolicy(CachePolicy policy) This method sets the CachePolicy object for this Cache

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

cleanup

void cleanup()

This method cleans up the cache by removing un-needed entries

enableCaching

void enableCaching(boolean enableCache)

This method enables or disables caching. When caching is disabled the cache passes all operations on to the persistent map instance

Parameters:

enableCache - true to enable, false to disable

getCachePolicy

CachePolicy getCachePolicy()

This method gets the CachePolicy object for this Cache

Returns:

CachePolicy instance or null if there is no CachePolicy

remove

void remove(Set keySet)

This method removes the specified keys from the cache and the data store

Parameters:

keySet - the keys to remove from the cache

removeAll

void removeAll()

Removes all objects from the cache and from the data store. Use this method with caution!

setCachePolicy

void setCachePolicy(CachePolicy policy)

This method sets the CachePolicy object for this Cache

Parameters:

policy - The new cache policy

addCacheListener

void addCacheListener(Object key,
                      CacheListener listener)

Adds a CacheListener for a specified key. Listeners will be notified of actions on the cache for that key only.

removeCacheListener

void removeCacheListener(Object key,
                         CacheListener listener)

Removes a CacheListener for a specified key.