org.apereo.services.persondir.support.rule

Class DeclaredRulePersonAttributeDao

java.lang.Object

org.apereo.services.persondir.support.BasePersonAttributeDao

org.apereo.services.persondir.support.AbstractFlatteningPersonAttributeDao

org.apereo.services.persondir.support.AbstractDefaultAttributePersonAttributeDao

org.apereo.services.persondir.support.rule.DeclaredRulePersonAttributeDao

All Implemented Interfaces:

java.lang.Comparable<IPersonAttributeDao>, IPersonAttributeDao

public final class DeclaredRulePersonAttributeDao
extends AbstractDefaultAttributePersonAttributeDao

Implementation of uPortal's IPersonAttributeDao that evaluates person directory information based on configurable rules. You may chain as many rules as you like, but this DAO will apply at most one rule, the first that triggers.

Configuration:

Property	Description	Required	Default
rules	The array of AttributeRules to use when	Yes	null

Field Summary

Fields inherited from class org.apereo.services.persondir.support.BasePersonAttributeDao

logger

Fields inherited from interface org.apereo.services.persondir.IPersonAttributeDao

WILDCARD, WILDCARD_PATTERN

Constructor Summary

Constructors

Constructor and Description
DeclaredRulePersonAttributeDao()
DeclaredRulePersonAttributeDao(java.lang.String attributeName, java.util.List<AttributeRule> rules) Creates a new DeclaredRulePersonAttributeDao specifying the attributeName to pass to AbstractDefaultAttributePersonAttributeDao.getUsernameAttributeProvider() and the List of AttributeRules to pass to setRules(List)

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAvailableQueryAttributes()
java.util.Set<IPersonAttributes>	getPeopleWithMultivaluedAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> seed)
java.util.Set<java.lang.String>	getPossibleUserAttributeNames() Aggregates the results of calling AttributeRule.getPossibleUserAttributeNames() on each AttributeRule instance in the rules array.
java.util.List<AttributeRule>	getRules()
void	setRules(java.util.List<AttributeRule> rules)

Methods inherited from class org.apereo.services.persondir.support.AbstractDefaultAttributePersonAttributeDao

getPerson, getUsernameAttributeProvider, setUsernameAttributeProvider, toSeedMap

Methods inherited from class org.apereo.services.persondir.support.AbstractFlatteningPersonAttributeDao

getPeople, toMultivaluedSeed

Methods inherited from class org.apereo.services.persondir.support.BasePersonAttributeDao

compareTo, flattenResults, getMultivaluedUserAttributes, getMultivaluedUserAttributes, getOrder, getUserAttributes, getUserAttributes, setOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

DeclaredRulePersonAttributeDao

public DeclaredRulePersonAttributeDao()

DeclaredRulePersonAttributeDao

public DeclaredRulePersonAttributeDao(java.lang.String attributeName,
                                      java.util.List<AttributeRule> rules)

Creates a new DeclaredRulePersonAttributeDao specifying the attributeName to pass to AbstractDefaultAttributePersonAttributeDao.getUsernameAttributeProvider() and the List of AttributeRules to pass to setRules(List)

Parameters:

attributeName - attribute name

rules - rules

Method Detail

getRules

public java.util.List<AttributeRule> getRules()

Returns:

the rules

setRules

public void setRules(java.util.List<AttributeRule> rules)

Parameters:

rules - the rules to set

getPeopleWithMultivaluedAttributes

public java.util.Set<IPersonAttributes> getPeopleWithMultivaluedAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> seed)

getPossibleUserAttributeNames

public java.util.Set<java.lang.String> getPossibleUserAttributeNames()

Aggregates the results of calling AttributeRule.getPossibleUserAttributeNames() on each AttributeRule instance in the rules array.

See Also:

IPersonAttributeDao.getPossibleUserAttributeNames()

getAvailableQueryAttributes

public java.util.Set<java.lang.String> getAvailableQueryAttributes()