org.apereo.services.persondir.support

Class ComplexStubPersonAttributeDao

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.AbstractQueryPersonAttributeDao<java.lang.String>

org.apereo.services.persondir.support.ComplexStubPersonAttributeDao

All Implemented Interfaces:

java.lang.Comparable<IPersonAttributeDao>, IPersonAttributeDao

Direct Known Subclasses:

JsonBackedComplexStubPersonAttributeDao

public class ComplexStubPersonAttributeDao
extends AbstractQueryPersonAttributeDao<java.lang.String>

Looks up the user's attribute Map in the backingMap. If using the IPersonAttributeDao.getUserAttributes(Map) method the attribute value returned for the key AbstractDefaultAttributePersonAttributeDao.getUsernameAttributeProvider() will be used as the key for the backingMap.

Configuration:

Property	Description	Required	Default
backingMap	Sets the backing map to use to return user attributes from. The backing map should have keys of type String which are the uid for the user. The values should be of type Map which follow the Map restrictions decribed by IPersonAttributeDao.getUserAttributes(Map).	No	Collections.EMPTY_MAP

Field Summary

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

DEFAULT_CASE_CANONICALIZATION_MODE, DEFAULT_USERNAME_CASE_CANONICALIZATION_MODE

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
ComplexStubPersonAttributeDao() Creates a new, empty, dao.
ComplexStubPersonAttributeDao(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> backingMap) Creates a new DAO with the specified backing map.
ComplexStubPersonAttributeDao(java.lang.String queryAttributeName, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> backingMap) Creates a new DAO with the specified backing map and query attribute.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	appendAttributeToQuery(java.lang.String queryBuilder, java.lang.String dataAttribute, java.util.List<java.lang.Object> queryValues) Append the attribute and value to the queryBuilder.
java.util.Set<java.lang.String>	getAvailableQueryAttributes()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.Object>>>	getBackingMap()
protected java.util.List<IPersonAttributes>	getPeopleForQuery(java.lang.String seedValue, java.lang.String queryUserName) Executes the query for the generated queryBuilder object and returns a list where each entry is a Map of attributes for a single IPersonAttributes.
java.util.Set<java.lang.String>	getPossibleUserAttributeNames()
java.lang.String	getQueryAttributeName()
void	setBackingMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> backingMap) The backing Map to use for queries, the outer map is keyed on the query attribute.
void	setQueryAttributeName(java.lang.String queryAttributeName) Name of the attribute to look for as key into the backing map.

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

appendCanonicalizedAttributeToQuery, canonicalizeAttribute, generateQuery, getCaseCanonicalizationLocale, getCaseInsensitiveQueryAttributes, getCaseInsensitiveResultAttributes, getConfiguredUserNameAttribute, getDefaultCaseCanonicalizationMode, getPeopleWithMultivaluedAttributes, getQueryAttributeMapping, getResultAttributeMapping, getUnmappedUsernameAttribute, getUsernameCaseCanonicalizationMode, isRequireAllQueryAttributes, isUseAllQueryAttributes, isUserNameAttributeConfigured, mapPersonAttributes, setCaseCanonicalizationLocale, setCaseInsensitiveQueryAttributes, setCaseInsensitiveQueryAttributesAsCollection, setCaseInsensitiveResultAttributes, setCaseInsensitiveResultAttributesAsCollection, setDefaultCaseCanonicalizationMode, setQueryAttributeMapping, setRequireAllQueryAttributes, setResultAttributeMapping, setUnmappedUsernameAttribute, setUseAllQueryAttributes, setUsernameCaseCanonicalizationMode

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

ComplexStubPersonAttributeDao

public ComplexStubPersonAttributeDao()

Creates a new, empty, dao.

ComplexStubPersonAttributeDao

public ComplexStubPersonAttributeDao(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> backingMap)

Creates a new DAO with the specified backing map.

Parameters:

backingMap - The backingMap to call setBackingMap(Map) with.

ComplexStubPersonAttributeDao

public ComplexStubPersonAttributeDao(java.lang.String queryAttributeName,
                                     java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> backingMap)

Creates a new DAO with the specified backing map and query attribute.

Parameters:

queryAttributeName - The queryAttributeName to call setQueryAttributeName(String) with.

backingMap - The backingMap to call setBackingMap(Map) with.

Method Detail

getQueryAttributeName

public java.lang.String getQueryAttributeName()

setQueryAttributeName

public void setQueryAttributeName(java.lang.String queryAttributeName)

Name of the attribute to look for as key into the backing map. If not set the value returned by AbstractDefaultAttributePersonAttributeDao.getUsernameAttributeProvider() will be used.

Parameters:

queryAttributeName - query attribute name

getBackingMap

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> getBackingMap()

setBackingMap

public void setBackingMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> backingMap)

The backing Map to use for queries, the outer map is keyed on the query attribute. The inner Map is the set of user attributes to be returned for the query attribute.

Parameters:

backingMap - backing map

getPossibleUserAttributeNames

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

Specified by:

getPossibleUserAttributeNames in interface IPersonAttributeDao

Overrides:

getPossibleUserAttributeNames in class AbstractQueryPersonAttributeDao<java.lang.String>

getAvailableQueryAttributes

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

Specified by:

getAvailableQueryAttributes in interface IPersonAttributeDao

Overrides:

getAvailableQueryAttributes in class AbstractQueryPersonAttributeDao<java.lang.String>

appendAttributeToQuery

protected java.lang.String appendAttributeToQuery(java.lang.String queryBuilder,
                                                  java.lang.String dataAttribute,
                                                  java.util.List<java.lang.Object> queryValues)

Description copied from class: AbstractQueryPersonAttributeDao

Append the attribute and value to the queryBuilder.

Specified by:

appendAttributeToQuery in class AbstractQueryPersonAttributeDao<java.lang.String>

Parameters:

queryBuilder - The sub-class specific query builder object

dataAttribute - The full attribute name to append

queryValues - The values for the data attribute

Returns:

An updated queryBuilder

getPeopleForQuery

protected java.util.List<IPersonAttributes> getPeopleForQuery(java.lang.String seedValue,
                                                              java.lang.String queryUserName)

Description copied from class: AbstractQueryPersonAttributeDao

Executes the query for the generated queryBuilder object and returns a list where each entry is a Map of attributes for a single IPersonAttributes.

Specified by:

getPeopleForQuery in class AbstractQueryPersonAttributeDao<java.lang.String>

Parameters:

seedValue - The query generated by calls to AbstractQueryPersonAttributeDao.appendAttributeToQuery(Object, String, List)

queryUserName - The username passed in the query map, if no username attribute existed in the query Map null is provided.

Returns:

The list of IPersons found by the query. The user attributes should be using the raw names from the data layer.