org.apereo.services.persondir.support

Class AdditionalDescriptorsPersonAttributeDao

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.AdditionalDescriptorsPersonAttributeDao

All Implemented Interfaces:

java.lang.Comparable<IPersonAttributeDao>, IPersonAttributeDao

public class AdditionalDescriptorsPersonAttributeDao
extends AbstractDefaultAttributePersonAttributeDao

Implementation of IPersonAttributeDao that allows other subsystems and components to push attributes to the IPersonAttributeDao stack. The collection of pushed attributes is represented by the descriptors property and backed by an instance of AdditionalDescriptors. In most cases this property should be configured as a Session-Scoped Proxy Bean.

Configuration:

Property	Description	Required	Default
descriptors	The IPersonAttributes object that models the collection of pushed attributes. In most cases this property should be configured as a Session-Scoped Proxy Bean.	Yes	null

Author:

awills

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
AdditionalDescriptorsPersonAttributeDao()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAvailableQueryAttributes() Returns a Set containing only the configured username attribute.
ICurrentUserProvider	getCurrentUserProvider()
java.util.Set<IPersonAttributes>	getPeopleWithMultivaluedAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> query)
java.util.Set<java.lang.String>	getPossibleUserAttributeNames()
java.util.Locale	getUsernameCaseCanonicalizationLocale()
CaseCanonicalizationMode	getUsernameCaseCanonicalizationMode()
void	setCurrentUserProvider(ICurrentUserProvider currentUserProvider) Sets the ICurrentUserProvider to use when determining if the additional attributes should be returned.
void	setDescriptors(IPersonAttributes descriptors) Called by Spring DI to inject the collection of additional descriptors.
void	setPossibleUserAttributeNames(java.util.Set<java.lang.String> possibleUserAttributeNames) Allows the developer to configure the set of possible attribute names in the Spring application context.
void	setUsernameCaseCanonicalizationLocale(java.util.Locale usernameCaseCanonicalizationLocale)
void	setUsernameCaseCanonicalizationMode(CaseCanonicalizationMode usernameCaseCanonicalizationMode)

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

AdditionalDescriptorsPersonAttributeDao

public AdditionalDescriptorsPersonAttributeDao()

Method Detail

setDescriptors

public void setDescriptors(IPersonAttributes descriptors)

Called by Spring DI to inject the collection of additional descriptors. Descriptors are user specific, and (therefore) the Map must be a session-scoped bean.

Parameters:

descriptors - Additional descriptors

getCurrentUserProvider

public ICurrentUserProvider getCurrentUserProvider()

setCurrentUserProvider

public void setCurrentUserProvider(ICurrentUserProvider currentUserProvider)

Sets the ICurrentUserProvider to use when determining if the additional attributes should be returned.

Parameters:

currentUserProvider - current user provider

getAvailableQueryAttributes

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

Returns a Set containing only the configured username attribute.

getPeopleWithMultivaluedAttributes

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

getPossibleUserAttributeNames

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

setPossibleUserAttributeNames

public void setPossibleUserAttributeNames(java.util.Set<java.lang.String> possibleUserAttributeNames)

Allows the developer to configure the set of possible attribute names in the Spring application context. Some downstream clients of person-directory need to know what attributes _may_ be present. The only way for this bean to know that is to tell it in config.

Parameters:

possibleUserAttributeNames - Set of possible attribute names.

Since:

1.6.2

getUsernameCaseCanonicalizationMode

public CaseCanonicalizationMode getUsernameCaseCanonicalizationMode()

setUsernameCaseCanonicalizationMode

public void setUsernameCaseCanonicalizationMode(CaseCanonicalizationMode usernameCaseCanonicalizationMode)

getUsernameCaseCanonicalizationLocale

public java.util.Locale getUsernameCaseCanonicalizationLocale()

setUsernameCaseCanonicalizationLocale

public void setUsernameCaseCanonicalizationLocale(java.util.Locale usernameCaseCanonicalizationLocale)