org.jasig.services.persondir.support
Class AdditionalDescriptorsPersonAttributeDao

java.lang.Object
  org.jasig.services.persondir.support.BasePersonAttributeDao
      org.jasig.services.persondir.support.AbstractFlatteningPersonAttributeDao
          org.jasig.services.persondir.support.AbstractDefaultAttributePersonAttributeDao
              org.jasig.services.persondir.support.AdditionalDescriptorsPersonAttributeDao

All Implemented Interfaces:

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.jasig.services.persondir.support.BasePersonAttributeDao

logger

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

WILDCARD, WILDCARD_PATTERN

Constructor Summary

AdditionalDescriptorsPersonAttributeDao()

Method Summary

Set<String>	getAvailableQueryAttributes() Returns an empty Set, per the API documentation, because we don't use any attributes in queries.
ICurrentUserProvider	getCurrentUserProvider()
Set<IPersonAttributes>	getPeopleWithMultivaluedAttributes(Map<String,List<Object>> query)
Set<String>	getPossibleUserAttributeNames() Returns null, per the API documentation, because we don't know what attributes may be available.
void	setCurrentUserProvider(ICurrentUserProvider currentUserProvider) Sets the ICurrentUserProvider to use when determining if the additional attributes should be returned, this is an optional property.
void	setDescriptors(IPersonAttributes descriptors) Called by Spring DI to inject the collection of additional descriptors.

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

getPerson, getUsernameAttributeProvider, setUsernameAttributeProvider, toSeedMap

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

getPeople, toMultivaluedSeed

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

flattenResults, getMultivaluedUserAttributes, getMultivaluedUserAttributes, getUserAttributes, getUserAttributes

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.

getCurrentUserProvider

public ICurrentUserProvider getCurrentUserProvider()

setCurrentUserProvider

public void setCurrentUserProvider(ICurrentUserProvider currentUserProvider)

Sets the ICurrentUserProvider to use when determining if the additional attributes should be returned, this is an optional property.

getAvailableQueryAttributes

public Set<String> getAvailableQueryAttributes()

Returns an empty Set, per the API documentation, because we don't use any attributes in queries.

getPeopleWithMultivaluedAttributes

public Set<IPersonAttributes> getPeopleWithMultivaluedAttributes(Map<String,List<Object>> query)

getPossibleUserAttributeNames

public Set<String> getPossibleUserAttributeNames()

Returns null, per the API documentation, because we don't know what attributes may be available.