Package org.apereo.cas.authentication.attribute

Class AbstractQueryPersonAttributeDao<QB>

java.lang.Object

org.apereo.cas.authentication.attribute.BasePersonAttributeDao

org.apereo.cas.authentication.attribute.AbstractFlatteningPersonAttributeDao

org.apereo.cas.authentication.attribute.AbstractDefaultAttributePersonAttributeDao

org.apereo.cas.authentication.attribute.AbstractQueryPersonAttributeDao<QB>

All Implemented Interfaces:

Comparable<org.apereo.cas.authentication.principal.attribute.PersonAttributeDao>, org.apereo.cas.authentication.principal.attribute.PersonAttributeDao, org.springframework.core.Ordered

Direct Known Subclasses:

ComplexPersonAttributeDao

public abstract class AbstractQueryPersonAttributeDao<QB>
extends AbstractDefaultAttributePersonAttributeDao

Provides common functionality for DAOs using a set of attribute values from the seed to perform a query. Ensures the necessary attributes to run the query exist on the seed and organizes the values into an argument array.

Since:

7.1.0

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Fields inherited from interface org.apereo.cas.authentication.principal.attribute.PersonAttributeDao

WILDCARD, WILDCARD_PATTERN

Constructor Summary

Constructors

Constructor	Description
AbstractQueryPersonAttributeDao()

Method Summary

Modifier and Type	Method	Description
Map<String,CaseCanonicalizationMode>	getCaseInsensitiveQueryAttributes()
Map<String,CaseCanonicalizationMode>	getCaseInsensitiveResultAttributes()
CaseCanonicalizationMode	getDefaultCaseCanonicalizationMode()
final Set<org.apereo.cas.authentication.principal.attribute.PersonAttributes>	getPeopleWithMultivaluedAttributes(Map<String,List<Object>> query, org.apereo.cas.authentication.principal.attribute.PersonAttributeDaoFilter filter, Set<org.apereo.cas.authentication.principal.attribute.PersonAttributes> resultPeople)
Set<String>	getPossibleUserAttributeNames(org.apereo.cas.authentication.principal.attribute.PersonAttributeDaoFilter filter)
Map<String,Set<String>>	getQueryAttributeMapping()
Map<String,Set<String>>	getResultAttributeMapping()
String	getUnmappedUsernameAttribute()
CaseCanonicalizationMode	getUsernameCaseCanonicalizationMode()
boolean	isRequireAllQueryAttributes()
boolean	isUseAllQueryAttributes()
void	setCaseInsensitiveQueryAttributes(Map<String,CaseCanonicalizationMode> caseInsensitiveQueryAttributes)
void	setCaseInsensitiveResultAttributes(Map<String,CaseCanonicalizationMode> caseInsensitiveResultAttributes)
void	setDefaultCaseCanonicalizationMode(CaseCanonicalizationMode defaultCaseCanonicalizationMode)
void	setQueryAttributeMapping(Map<String,?> queryAttributeMapping)	Map from query attribute names to data-layer attribute names to use when building the query.
void	setRequireAllQueryAttributes(boolean requireAllQueryAttributes)
void	setResultAttributeMapping(Map<String,?> resultAttributeMapping)	Sets result attribute mapping.
void	setUnmappedUsernameAttribute(String unmappedUsernameAttribute)
void	setUseAllQueryAttributes(boolean useAllQueryAttributes)
void	setUsernameCaseCanonicalizationMode(CaseCanonicalizationMode usernameCaseCanonicalizationMode)

Methods inherited from class org.apereo.cas.authentication.attribute.AbstractDefaultAttributePersonAttributeDao

getPerson, getUsernameAttributeProvider, setUsernameAttributeProvider

Methods inherited from class org.apereo.cas.authentication.attribute.AbstractFlatteningPersonAttributeDao

getPeople

Methods inherited from class org.apereo.cas.authentication.attribute.BasePersonAttributeDao

compareTo, equals, getId, getOrder, getTags, hashCode, isEnabled, parseAttributeToAttributeMapping, putTag, setEnabled, setId, setOrder, setTags, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apereo.cas.authentication.principal.attribute.PersonAttributeDao

getAvailableQueryAttributes, getPeople, getPeople, getPeople, getPeopleWithMultivaluedAttributes, getPeopleWithMultivaluedAttributes, getPeopleWithMultivaluedAttributes, getPerson, getPerson, stuffAttributesIntoList

Constructor Details

AbstractQueryPersonAttributeDao

public AbstractQueryPersonAttributeDao()

Method Details

setResultAttributeMapping

public void setResultAttributeMapping(Map<String,?> resultAttributeMapping)

Sets result attribute mapping.

Parameters:

resultAttributeMapping - the result attribute mapping

getPeopleWithMultivaluedAttributes

public final Set<org.apereo.cas.authentication.principal.attribute.PersonAttributes> getPeopleWithMultivaluedAttributes(Map<String,List<Object>> query,
 org.apereo.cas.authentication.principal.attribute.PersonAttributeDaoFilter filter,
 Set<org.apereo.cas.authentication.principal.attribute.PersonAttributes> resultPeople)

setQueryAttributeMapping

public void setQueryAttributeMapping(Map<String,?> queryAttributeMapping)

Map from query attribute names to data-layer attribute names to use when building the query. If an ordered Map is passed in the order of the attributes will be honored when building the query. If not set query attributes will be used directly from the query Map.

Parameters:

queryAttributeMapping - the queryAttributeMapping to set

getPossibleUserAttributeNames

public Set<String> getPossibleUserAttributeNames(org.apereo.cas.authentication.principal.attribute.PersonAttributeDaoFilter filter)

getQueryAttributeMapping

public Map<String,Set<String>> getQueryAttributeMapping()

getResultAttributeMapping

public Map<String,Set<String>> getResultAttributeMapping()

getCaseInsensitiveResultAttributes

public Map<String,CaseCanonicalizationMode> getCaseInsensitiveResultAttributes()

setCaseInsensitiveResultAttributes

public void setCaseInsensitiveResultAttributes(Map<String,CaseCanonicalizationMode> caseInsensitiveResultAttributes)

getCaseInsensitiveQueryAttributes

public Map<String,CaseCanonicalizationMode> getCaseInsensitiveQueryAttributes()

setCaseInsensitiveQueryAttributes

public void setCaseInsensitiveQueryAttributes(Map<String,CaseCanonicalizationMode> caseInsensitiveQueryAttributes)

getDefaultCaseCanonicalizationMode

public CaseCanonicalizationMode getDefaultCaseCanonicalizationMode()

setDefaultCaseCanonicalizationMode

public void setDefaultCaseCanonicalizationMode(CaseCanonicalizationMode defaultCaseCanonicalizationMode)

getUsernameCaseCanonicalizationMode

public CaseCanonicalizationMode getUsernameCaseCanonicalizationMode()

setUsernameCaseCanonicalizationMode

public void setUsernameCaseCanonicalizationMode(CaseCanonicalizationMode usernameCaseCanonicalizationMode)

isRequireAllQueryAttributes

public boolean isRequireAllQueryAttributes()

setRequireAllQueryAttributes

public void setRequireAllQueryAttributes(boolean requireAllQueryAttributes)

isUseAllQueryAttributes

public boolean isUseAllQueryAttributes()

setUseAllQueryAttributes

public void setUseAllQueryAttributes(boolean useAllQueryAttributes)

getUnmappedUsernameAttribute

public String getUnmappedUsernameAttribute()

setUnmappedUsernameAttribute

public void setUnmappedUsernameAttribute(String unmappedUsernameAttribute)