org.apereo.services.persondir.support.jdbc

Class SingleRowJdbcPersonAttributeDao

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<org.apereo.services.persondir.support.jdbc.PartialWhereClause>

org.apereo.services.persondir.support.jdbc.AbstractJdbcPersonAttributeDao<java.util.Map<java.lang.String,java.lang.Object>>

org.apereo.services.persondir.support.jdbc.SingleRowJdbcPersonAttributeDao

All Implemented Interfaces:

java.lang.Comparable<IPersonAttributeDao>, IPersonAttributeDao

public class SingleRowJdbcPersonAttributeDao
extends AbstractJdbcPersonAttributeDao<java.util.Map<java.lang.String,java.lang.Object>>

An IPersonAttributeDao implementation that maps from column names in the result of a SQL query to attribute names.
You must set a Map from column names to attribute names and only column names appearing as keys in that map will be used.

Configuration:

Property	Description	Required	Default
columnsToAttributes	The Map of String columns names to String or Sets of Strings to use as attribute names in the returned Map. If a column name is not in the map the column name will be used in as the returned attribute name.	No	Collections.EMPTY_MAP

Since:

uPortal 2.5

Author:

andrew.petro@yale.edu, Eric Dalquist

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
SingleRowJdbcPersonAttributeDao()
SingleRowJdbcPersonAttributeDao(javax.sql.DataSource ds, java.lang.String sql) Creates a new MultiRowJdbcPersonAttributeDao specifying the DataSource and SQL to use.

Method Summary

Modifier and Type	Method and Description
protected org.springframework.jdbc.core.RowMapper<java.util.Map<java.lang.String,java.lang.Object>>	getRowMapper()
protected java.util.List<IPersonAttributes>	parseAttributeMapFromResults(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> queryResults, java.lang.String queryUserName) Takes the List from the query and parses it into the List of IPersonAttributes attributes to be returned.

Methods inherited from class org.apereo.services.persondir.support.jdbc.AbstractJdbcPersonAttributeDao

appendAttributeToQuery, canonicalizeDataAttributeForSql, getCaseInsensitiveDataAttributes, getDataAttributeCaseCanonicalizationFunctions, getPeopleForQuery, getQueryTemplate, getQueryType, setCaseInsensitiveDataAttributes, setCaseInsensitiveDataAttributesAsCollection, setDataAttributeCaseCanonicalizationFunctions, setQueryType

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

SingleRowJdbcPersonAttributeDao

public SingleRowJdbcPersonAttributeDao()

SingleRowJdbcPersonAttributeDao

public SingleRowJdbcPersonAttributeDao(javax.sql.DataSource ds,
                                       java.lang.String sql)

Creates a new MultiRowJdbcPersonAttributeDao specifying the DataSource and SQL to use.

Parameters:

ds - The DataSource to get connections from for executing queries, may not be null.

sql - The SQL to execute for user attributes, may not be null.

Method Detail

getRowMapper

protected org.springframework.jdbc.core.RowMapper<java.util.Map<java.lang.String,java.lang.Object>> getRowMapper()

Specified by:

getRowMapper in class AbstractJdbcPersonAttributeDao<java.util.Map<java.lang.String,java.lang.Object>>

Returns:

The ParameterizedRowMapper to handle the results of the SQL query.

parseAttributeMapFromResults

protected java.util.List<IPersonAttributes> parseAttributeMapFromResults(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> queryResults,
                                                                         java.lang.String queryUserName)

Description copied from class: AbstractJdbcPersonAttributeDao

Takes the List from the query and parses it into the List of IPersonAttributes attributes to be returned.

Specified by:

parseAttributeMapFromResults in class AbstractJdbcPersonAttributeDao<java.util.Map<java.lang.String,java.lang.Object>>

Parameters:

queryResults - Results from the query.

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

Returns:

The results of the query