org.jasig.services.persondir.support

Class AttributeBasedCacheKeyGenerator

java.lang.Object

org.jasig.services.persondir.support.AttributeBasedCacheKeyGenerator

All Implemented Interfaces:

org.springmodules.cache.key.CacheKeyGenerator

public class AttributeBasedCacheKeyGenerator
extends Object
implements org.springmodules.cache.key.CacheKeyGenerator

Generates a cache key using a hash of the Method being called and for IPersonAttributeDao.getMultivaluedUserAttributes(String) and IPersonAttributeDao.getUserAttributes(String) the String uid or for IPersonAttributeDao.getMultivaluedUserAttributes(Map) and IPersonAttributeDao.getUserAttributes(Map) attributes from the seed Map as specified by the cacheKeyAttributes Set

Version:

$Revision$

Author:

Eric Dalquist

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AttributeBasedCacheKeyGenerator.CachableMethod Methods on IPersonAttributeDao that are cachable

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Constructor and Description
AttributeBasedCacheKeyGenerator()

Method Summary

Modifier and Type	Method and Description
Serializable	generateKey(org.aopalliance.intercept.MethodInvocation methodInvocation)
Set<String>	getCacheKeyAttributes()
String	getDefaultAttributeName()
protected Integer	getKeyHash(Map<String,Object> seed) Gets the hash of the key elements from the seed Map.
protected Map<String,Object>	getSeed(Object[] methodArguments, AttributeBasedCacheKeyGenerator.CachableMethod cachableMethod) Get the see Map that was passed to the AttributeBasedCacheKeyGenerator.CachableMethod.
boolean	isIgnoreEmptyAttributes() Returns boolean indicating whether seed attributes with empty values (null, empty string or empty list values) should be ignored when generating the cache key
boolean	isUseAllAttributes()
protected AttributeBasedCacheKeyGenerator.CachableMethod	resolveCacheableMethod(org.aopalliance.intercept.MethodInvocation methodInvocation) Iterates over the AttributeBasedCacheKeyGenerator.CachableMethod instances to determine which instance the passed MethodInvocation applies to.
void	setCacheKeyAttributes(Set<String> cacheKeyAttributes)
void	setDefaultAttributeName(String defaultAttributeName)
void	setIgnoreEmptyAttributes(boolean ignoreEmptyAttributes) If seed attributes with empty values (null, empty string or empty list values) should be ignored when generating the cache key.
void	setUseAllAttributes(boolean useAllAttributes) If all seed attributes should be used.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

AttributeBasedCacheKeyGenerator

public AttributeBasedCacheKeyGenerator()

Method Detail

getCacheKeyAttributes

public Set<String> getCacheKeyAttributes()

Returns:

the cacheKeyAttributes

setCacheKeyAttributes

public void setCacheKeyAttributes(Set<String> cacheKeyAttributes)

Parameters:

cacheKeyAttributes - the cacheKeyAttributes to set

getDefaultAttributeName

public String getDefaultAttributeName()

Returns:

the defaultAttributeName

setDefaultAttributeName

public void setDefaultAttributeName(String defaultAttributeName)

Parameters:

defaultAttributeName - the defaultAttributeName to set

isUseAllAttributes

public boolean isUseAllAttributes()

setUseAllAttributes

public void setUseAllAttributes(boolean useAllAttributes)

If all seed attributes should be used. If true cacheKeyAttributes and defaultAttributeName are ignored. Defaults to false.

Parameters:

useAllAttributes - True to use all attributes

isIgnoreEmptyAttributes

public boolean isIgnoreEmptyAttributes()

Returns boolean indicating whether seed attributes with empty values (null, empty string or empty list values) should be ignored when generating the cache key

Returns:

True if seed attributes should ignore empty values

setIgnoreEmptyAttributes

public void setIgnoreEmptyAttributes(boolean ignoreEmptyAttributes)

If seed attributes with empty values (null, empty string or empty list values) should be ignored when generating the cache key. Defaults to false.

Parameters:

ignoreEmptyAttributes - True to ignore attributes with empty values

generateKey

public Serializable generateKey(org.aopalliance.intercept.MethodInvocation methodInvocation)

Specified by:

generateKey in interface org.springmodules.cache.key.CacheKeyGenerator

getSeed

protected Map<String,Object> getSeed(Object[] methodArguments,
                                     AttributeBasedCacheKeyGenerator.CachableMethod cachableMethod)

Get the see Map that was passed to the AttributeBasedCacheKeyGenerator.CachableMethod. For AttributeBasedCacheKeyGenerator.CachableMethods that take String arguments this method is responsible for converting it into a Map using the defaultAttributeName.

Parameters:

methodArguments - The method arguments

cachableMethod - The targeted cachable method

Returns:

The seed Map for the method call

getKeyHash

protected Integer getKeyHash(Map<String,Object> seed)

Gets the hash of the key elements from the seed Map. The key elements are specified by the cacheKeyAttributes Set or if it is null the defaultAttributeName is used as the key attribute.

Parameters:

seed - Seed

Returns:

Hash of key elements from the seed

resolveCacheableMethod

protected AttributeBasedCacheKeyGenerator.CachableMethod resolveCacheableMethod(org.aopalliance.intercept.MethodInvocation methodInvocation)

Iterates over the AttributeBasedCacheKeyGenerator.CachableMethod instances to determine which instance the passed MethodInvocation applies to.

Parameters:

methodInvocation - method invocation

Returns:

Cachable method