org.sakaiproject.service.framework.memory
Interface MultiRefCache

All Superinterfaces:
Cache, Cacher
All Known Implementing Classes:
MultiRefCacheImpl

public interface MultiRefCache
extends Cache

MultiRefCache is a cache that holds objects and a set of references that the cached entry are dependent on - if any change, the entry is invalidated.

Author:
Sakai Software Development Team

Method Summary
 void put(Object key, Object payload, int duration, String ref, Collection azgIds)
          Cache an object
 
Methods inherited from interface org.sakaiproject.service.framework.memory.Cache
clear, containsKey, containsKeyExpiredOrNot, destroy, disable, disabled, enable, expire, get, getAll, getAll, getExpiredOrNot, getIds, getKeys, holdEvents, isComplete, isComplete, processEvents, put, put, remove, setComplete, setComplete
 
Methods inherited from interface org.sakaiproject.service.framework.memory.Cacher
getDescription, getSize, resetCache
 

Method Detail

put

public void put(Object key,
                Object payload,
                int duration,
                String ref,
                Collection azgIds)
Cache an object

Parameters:
key - The key with which to find the object.
payload - The object to cache.
duration - The time to cache the object (seconds).
ref - One entity reference that, if changed, will invalidate this entry.
azgIds - AuthzGroup ids that, if the changed, will invalidate this entry.