org.apereo.cas.authentication.principal.cache

Class CachingPrincipalAttributesRepository

java.lang.Object

org.apereo.cas.authentication.principal.cache.AbstractPrincipalAttributesRepository

org.apereo.cas.authentication.principal.cache.CachingPrincipalAttributesRepository

All Implemented Interfaces:

java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable, org.apereo.cas.authentication.principal.PrincipalAttributesRepository

public class CachingPrincipalAttributesRepository
extends AbstractPrincipalAttributesRepository

Wrapper around an attribute repository where attributes cached for a configurable period based on google guava's caching library.

Since:

4.2

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apereo.cas.authentication.principal.cache.AbstractPrincipalAttributesRepository

AbstractPrincipalAttributesRepository.MergingStrategy

Field Summary

Fields inherited from class org.apereo.cas.authentication.principal.cache.AbstractPrincipalAttributesRepository

expiration, mergingStrategy, timeUnit

Constructor Summary

Constructors

Constructor and Description
CachingPrincipalAttributesRepository(long maxCacheSize, java.lang.String timeUnit, long expiryDuration) Instantiates a new caching attributes principal factory.
CachingPrincipalAttributesRepository(java.lang.String timeUnit, long expiryDuration) Instantiates a new caching attributes principal factory.

Method Summary

Modifier and Type	Method and Description
protected void	addPrincipalAttributes(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> attributes) Add principal attributes into the underlying cache instance.
void	close()
protected java.util.Map<java.lang.String,java.lang.Object>	getPrincipalAttributes(org.apereo.cas.authentication.principal.Principal p) Gets principal attributes from cache.

Methods inherited from class org.apereo.cas.authentication.principal.cache.AbstractPrincipalAttributesRepository

convertPersonAttributesToPrincipalAttributes, equals, getAttributes, getExpiration, getMergingStrategy, getTimeUnit, hashCode, retrievePersonAttributesToPrincipalAttributes, setAttributeRepository, setExpiration, setMergingStrategy, setTimeUnit, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CachingPrincipalAttributesRepository

public CachingPrincipalAttributesRepository(java.lang.String timeUnit,
                                            long expiryDuration)

Instantiates a new caching attributes principal factory. Sets the default cache size to DEFAULT_MAXIMUM_CACHE_SIZE.

Parameters:

timeUnit - the time unit

expiryDuration - the expiry duration

CachingPrincipalAttributesRepository

public CachingPrincipalAttributesRepository(long maxCacheSize,
                                            java.lang.String timeUnit,
                                            long expiryDuration)

Instantiates a new caching attributes principal factory.

Parameters:

maxCacheSize - the max cache size

timeUnit - the time unit

expiryDuration - the expiry duration

Method Detail

addPrincipalAttributes

protected void addPrincipalAttributes(java.lang.String id,
                                      java.util.Map<java.lang.String,java.lang.Object> attributes)

Description copied from class: AbstractPrincipalAttributesRepository

Add principal attributes into the underlying cache instance.

Specified by:

addPrincipalAttributes in class AbstractPrincipalAttributesRepository

Parameters:

id - identifier used by the cache as key.

attributes - attributes to cache

getPrincipalAttributes

protected java.util.Map<java.lang.String,java.lang.Object> getPrincipalAttributes(org.apereo.cas.authentication.principal.Principal p)

Description copied from class: AbstractPrincipalAttributesRepository

Gets principal attributes from cache.

Specified by:

getPrincipalAttributes in class AbstractPrincipalAttributesRepository

Parameters:

p - the principal

Returns:

the principal attributes from cache

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException