org.kuali.student.common.cache

Class KSCacheUtils

java.lang.Object

org.kuali.student.common.cache.KSCacheUtils

public final class KSCacheUtils
extends Object

Author:

Kuali Student Team (ks.collab@kuali.org) Helper methods for retrieving single and bulk elements from a cache.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KSCacheUtils.BulkCacheElementLoader<T extends HasPrimaryKey> A mechanism to load multiple elements from its data source (non-cached) to be used within the helper to acquire those that are not presently in the cache.
static interface	KSCacheUtils.CacheElementCopier<T>
static interface	KSCacheUtils.SingleCacheElementLoader<T extends HasPrimaryKey> A mechanism to load a single element using its key when it is not available in the cache.

Method Summary

Methods

Modifier and Type	Method and Description
static <T extends HasPrimaryKey> List<T>	cacheAwareBulkLoad(net.sf.ehcache.Cache cache, List<String> elementKeys, KSCacheUtils.CacheElementCopier<T> copier, KSCacheUtils.BulkCacheElementLoader<T> loader) A helper to be used in bulk load scenarios within caching decorator's.
static <T extends HasPrimaryKey> T	cacheAwareLoad(net.sf.ehcache.Cache cache, String key, KSCacheUtils.CacheElementCopier<T> copier, KSCacheUtils.SingleCacheElementLoader<T> loader) A helper to be used in single element load scenarios.
static <T extends HasPrimaryKey> T	cacheAwareLoad(net.sf.ehcache.Cache cache, String key, org.apache.commons.collections.keyvalue.MultiKey multiKey, KSCacheUtils.CacheElementCopier<T> copier, KSCacheUtils.SingleCacheElementLoader<T> loader) Helper that load using the multikey if it is not null.
static <T extends HasPrimaryKey> void	updateCacheElement(net.sf.ehcache.Cache cache, String cacheKey, T cacheElement, KSCacheUtils.CacheElementCopier<T> cacheElementCopier)

Methods inherited from class java.lang.Object

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

Method Detail

cacheAwareLoad

public static <T extends HasPrimaryKey> T cacheAwareLoad(net.sf.ehcache.Cache cache,
                                         String key,
                                         KSCacheUtils.CacheElementCopier<T> copier,
                                         KSCacheUtils.SingleCacheElementLoader<T> loader)
                                              throws DoesNotExistException,
                                                     OperationFailedException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     PermissionDeniedException

A helper to be used in single element load scenarios. If not in the cache the loader is used to load it at which point it is added to the cache.

Parameters:

cache -

key -

loader -

Returns:

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

cacheAwareLoad

public static <T extends HasPrimaryKey> T cacheAwareLoad(net.sf.ehcache.Cache cache,
                                         String key,
                                         org.apache.commons.collections.keyvalue.MultiKey multiKey,
                                         KSCacheUtils.CacheElementCopier<T> copier,
                                         KSCacheUtils.SingleCacheElementLoader<T> loader)
                                              throws DoesNotExistException,
                                                     OperationFailedException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     PermissionDeniedException

Helper that load using the multikey if it is not null. Otherwise it loads and stores using the key.

Parameters:

cache -

key -

multiKey -

loader -

Returns:

the element that matches the key and multikey provided

Throws:

DoesNotExistException

OperationFailedException

InvalidParameterException

MissingParameterException

PermissionDeniedException

cacheAwareBulkLoad

public static <T extends HasPrimaryKey> List<T> cacheAwareBulkLoad(net.sf.ehcache.Cache cache,
                                                   List<String> elementKeys,
                                                   KSCacheUtils.CacheElementCopier<T> copier,
                                                   KSCacheUtils.BulkCacheElementLoader<T> loader)
                                                        throws OperationFailedException,
                                                               InvalidParameterException,
                                                               MissingParameterException,
                                                               PermissionDeniedException

A helper to be used in bulk load scenarios within caching decorator's. This will find elements using the cache if they exist otherwise bring them in using the loader. The loaded elements will then be added to the cache.

Parameters:

cache -

elementIds -

loader -

Returns:

the list of elements that match the elementKeys provided.

Throws:

OperationFailedException

PermissionDeniedException

MissingParameterException

InvalidParameterException

updateCacheElement

public static <T extends HasPrimaryKey> void updateCacheElement(net.sf.ehcache.Cache cache,
                                                String cacheKey,
                                                T cacheElement,
                                                KSCacheUtils.CacheElementCopier<T> cacheElementCopier)