org.apereo.services.persondir.support

Class SAMLCredentialPersonAttributeDao

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<SAMLCredentialPersonAttributeDao.QueryBuilder>

org.apereo.services.persondir.support.SAMLCredentialPersonAttributeDao

All Implemented Interfaces:

java.lang.Comparable<IPersonAttributeDao>, IPersonAttributeDao

public class SAMLCredentialPersonAttributeDao
extends AbstractQueryPersonAttributeDao<SAMLCredentialPersonAttributeDao.QueryBuilder>

Captures user attributes via the SAMLCredential for applications that use Spring Security. Supports the standard attribute mapping paradigm implemented by AbstractQueryPersonAttributeDao. This implementation of IPersonAttributeDao is similar to AdditionalDescriptorsPersonAttributeDao in that attributes are provided for the current logged in user or not at all.

Since:

1.7.1

Author:

drewwills

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SAMLCredentialPersonAttributeDao.QueryBuilder Only extending AbstractQueryPersonAttributeDao for the resultAttributeMapping behavior; for the present we don't need to build queries.

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

Method Summary

Modifier and Type	Method and Description
protected SAMLCredentialPersonAttributeDao.QueryBuilder	appendAttributeToQuery(SAMLCredentialPersonAttributeDao.QueryBuilder queryBuilder, java.lang.String dataAttribute, java.util.List<java.lang.Object> queryValues) Append the attribute and value to the queryBuilder.
protected java.util.List<IPersonAttributes>	getPeopleForQuery(SAMLCredentialPersonAttributeDao.QueryBuilder queryBuilder, java.lang.String queryUserName) Per AbstractQueryPersonAttributeDao, this method returns "unmapped attributes" which are transformed using the resultAttributeMapping collection.
void	setCurrentUserProvider(ICurrentUserProvider currentUserProvider) Sets the ICurrentUserProvider to use when determining if the additional attributes (from the SAMLCredential) should be returned.

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

appendCanonicalizedAttributeToQuery, canonicalizeAttribute, generateQuery, getAvailableQueryAttributes, getCaseCanonicalizationLocale, getCaseInsensitiveQueryAttributes, getCaseInsensitiveResultAttributes, getConfiguredUserNameAttribute, getDefaultCaseCanonicalizationMode, getPeopleWithMultivaluedAttributes, getPossibleUserAttributeNames, 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

SAMLCredentialPersonAttributeDao

public SAMLCredentialPersonAttributeDao()

Method Detail

setCurrentUserProvider

public void setCurrentUserProvider(ICurrentUserProvider currentUserProvider)

Sets the ICurrentUserProvider to use when determining if the additional attributes (from the SAMLCredential) should be returned. They will only be added if the user for whom attributes are requested is also the current logged in user (making the request).

Parameters:

currentUserProvider - current user provider

getPeopleForQuery

protected java.util.List<IPersonAttributes> getPeopleForQuery(SAMLCredentialPersonAttributeDao.QueryBuilder queryBuilder,
                                                              java.lang.String queryUserName)

Per AbstractQueryPersonAttributeDao, this method returns "unmapped attributes" which are transformed using the resultAttributeMapping collection. Use Attribute.name (rather than Attribute.friendlyName) in these mapping definitions.

Specified by:

getPeopleForQuery in class AbstractQueryPersonAttributeDao<SAMLCredentialPersonAttributeDao.QueryBuilder>

Parameters:

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

appendAttributeToQuery

protected SAMLCredentialPersonAttributeDao.QueryBuilder appendAttributeToQuery(SAMLCredentialPersonAttributeDao.QueryBuilder 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<SAMLCredentialPersonAttributeDao.QueryBuilder>

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