org.apereo.cas.authentication.principal.cache

Class AbstractPrincipalAttributesRepository

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CachingPrincipalAttributesRepository, DefaultPrincipalAttributesRepository

public abstract class AbstractPrincipalAttributesRepository
extends java.lang.Object
implements org.apereo.cas.authentication.principal.PrincipalAttributesRepository, java.io.Closeable

Parent class for retrieval principals attributes, provides operations around caching, merging of attributes.

Since:

4.2

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractPrincipalAttributesRepository.MergingStrategy Defines the merging strategy options.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	expiration The expiration time.
protected AbstractPrincipalAttributesRepository.MergingStrategy	mergingStrategy The merging strategy that deals with existing principal attributes and those that are retrieved from the source.
protected java.lang.String	timeUnit Expiration time unit.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPrincipalAttributesRepository() Instantiates a new principal attributes repository.
	AbstractPrincipalAttributesRepository(long expiration, java.lang.String timeUnit) Instantiates a new principal attributes repository.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addPrincipalAttributes(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> attributes) Add principal attributes into the underlying cache instance.
protected java.util.Map<java.lang.String,java.lang.Object>	convertPersonAttributesToPrincipalAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> attributes) Convert person attributes to principal attributes.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.Object>	getAttributes(org.apereo.cas.authentication.principal.Principal p)
long	getExpiration()
AbstractPrincipalAttributesRepository.MergingStrategy	getMergingStrategy()
protected abstract java.util.Map<java.lang.String,java.lang.Object>	getPrincipalAttributes(org.apereo.cas.authentication.principal.Principal p) Gets principal attributes from cache.
java.lang.String	getTimeUnit()
int	hashCode()
protected java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	retrievePersonAttributesToPrincipalAttributes(java.lang.String id) Obtains attributes first from the repository by calling IPersonAttributeDao.getPerson(String).
void	setAttributeRepository(org.apereo.services.persondir.IPersonAttributeDao attributeRepository)
void	setExpiration(long expiration)
void	setMergingStrategy(AbstractPrincipalAttributesRepository.MergingStrategy mergingStrategy) The merging strategy that deals with existing principal attributes and those that are retrieved from the source.
void	setTimeUnit(java.lang.String unit)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Field Detail

expiration

protected long expiration

The expiration time.

timeUnit

protected java.lang.String timeUnit

Expiration time unit.

mergingStrategy

protected AbstractPrincipalAttributesRepository.MergingStrategy mergingStrategy

The merging strategy that deals with existing principal attributes and those that are retrieved from the source. By default, existing attributes are ignored and the source is always consulted.

Constructor Detail

AbstractPrincipalAttributesRepository

protected AbstractPrincipalAttributesRepository()

Instantiates a new principal attributes repository. Simply used buy

AbstractPrincipalAttributesRepository

public AbstractPrincipalAttributesRepository(long expiration,
                                             java.lang.String timeUnit)

Instantiates a new principal attributes repository.

Parameters:

expiration - the expiration

timeUnit - the time unit

Method Detail

setMergingStrategy

public void setMergingStrategy(AbstractPrincipalAttributesRepository.MergingStrategy mergingStrategy)

The merging strategy that deals with existing principal attributes and those that are retrieved from the source. By default, existing attributes are ignored and the source is always consulted.

Parameters:

mergingStrategy - the strategy to use for conflicts

getMergingStrategy

public AbstractPrincipalAttributesRepository.MergingStrategy getMergingStrategy()

convertPersonAttributesToPrincipalAttributes

protected java.util.Map<java.lang.String,java.lang.Object> convertPersonAttributesToPrincipalAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> attributes)

Convert person attributes to principal attributes.

Parameters:

attributes - person attributes

Returns:

principal attributes

retrievePersonAttributesToPrincipalAttributes

protected java.util.Map<java.lang.String,java.util.List<java.lang.Object>> retrievePersonAttributesToPrincipalAttributes(java.lang.String id)

Obtains attributes first from the repository by calling IPersonAttributeDao.getPerson(String).

Parameters:

id - the person id to locate in the attribute repository

Returns:

the map of attributes

getAttributes

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

Specified by:

getAttributes in interface org.apereo.cas.authentication.principal.PrincipalAttributesRepository

addPrincipalAttributes

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

Add principal attributes into the underlying cache instance.

Parameters:

id - identifier used by the cache as key.

attributes - attributes to cache

Since:

4.2

getPrincipalAttributes

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

Gets principal attributes from cache.

Parameters:

p - the principal

Returns:

the principal attributes from cache

setAttributeRepository

public void setAttributeRepository(org.apereo.services.persondir.IPersonAttributeDao attributeRepository)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getExpiration

public long getExpiration()

getTimeUnit

public java.lang.String getTimeUnit()

setTimeUnit

public void setTimeUnit(java.lang.String unit)

setExpiration

public void setExpiration(long expiration)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object