org.apereo.services.persondir.support.jdbc

Class AbstractJdbcPersonAttributeDao<R>

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<R>

All Implemented Interfaces:

java.lang.Comparable<IPersonAttributeDao>, IPersonAttributeDao

Direct Known Subclasses:

MultiRowJdbcPersonAttributeDao, SingleRowJdbcPersonAttributeDao

public abstract class AbstractJdbcPersonAttributeDao<R>
extends AbstractQueryPersonAttributeDao<org.apereo.services.persondir.support.jdbc.PartialWhereClause>

Provides common logic for executing a JDBC based query including building the WHERE clause SQL string.

Configuration:

Property	Description	Required	Default
queryType	How multiple attributes in a query should be concatenated together. The other option is OR.	No	AND

Author:

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
AbstractJdbcPersonAttributeDao()
AbstractJdbcPersonAttributeDao(javax.sql.DataSource ds, java.lang.String queryTemplate)

Method Summary

Modifier and Type	Method and Description
protected org.apereo.services.persondir.support.jdbc.PartialWhereClause	appendAttributeToQuery(org.apereo.services.persondir.support.jdbc.PartialWhereClause queryBuilder, java.lang.String dataAttribute, java.util.List<java.lang.Object> queryValues) Append the attribute and value to the queryBuilder.
protected java.lang.String	canonicalizeDataAttributeForSql(java.lang.String dataAttribute) Canonicalize the data-layer attribute column with the given name via SQL function.
java.util.Map<java.lang.String,CaseCanonicalizationMode>	getCaseInsensitiveDataAttributes()
java.util.Map<CaseCanonicalizationMode,java.text.MessageFormat>	getDataAttributeCaseCanonicalizationFunctions()
protected java.util.List<IPersonAttributes>	getPeopleForQuery(org.apereo.services.persondir.support.jdbc.PartialWhereClause queryBuilder, 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.lang.String	getQueryTemplate()
QueryType	getQueryType()
protected abstract org.springframework.jdbc.core.RowMapper<R>	getRowMapper()
protected abstract java.util.List<IPersonAttributes>	parseAttributeMapFromResults(java.util.List<R> queryResults, java.lang.String queryUserName) Takes the List from the query and parses it into the List of IPersonAttributes attributes to be returned.
void	setCaseInsensitiveDataAttributes(java.util.Map<java.lang.String,CaseCanonicalizationMode> caseInsensitiveDataAttributes)
void	setCaseInsensitiveDataAttributesAsCollection(java.util.Collection<java.lang.String> caseInsensitiveDataAttributes)
void	setDataAttributeCaseCanonicalizationFunctions(java.util.Map<CaseCanonicalizationMode,java.text.MessageFormat> dataAttributeCaseCanonicalizationFunctions) Assign MessageFormats describing how to wrap a JDBC/SQL column reference in a function corresponding to a given CaseCanonicalizationMode.
void	setQueryType(QueryType queryType) Type of logical operator to use when joining WHERE clause components

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

AbstractJdbcPersonAttributeDao

public AbstractJdbcPersonAttributeDao()

AbstractJdbcPersonAttributeDao

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

Parameters:

ds - The DataSource to use for queries

queryTemplate - Template to use for SQL query generation. Use {0} as the placeholder for where the generated portion of the WHERE clause should be inserted.

Method Detail

getQueryTemplate

public java.lang.String getQueryTemplate()

Returns:

the queryTemplate

getQueryType

public QueryType getQueryType()

Returns:

the queryType

setQueryType

public void setQueryType(QueryType queryType)

Type of logical operator to use when joining WHERE clause components

Parameters:

queryType - the queryType to set

parseAttributeMapFromResults

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

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

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

getRowMapper

protected abstract org.springframework.jdbc.core.RowMapper<R> getRowMapper()

Returns:

The ParameterizedRowMapper to handle the results of the SQL query.

appendAttributeToQuery

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

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

canonicalizeDataAttributeForSql

protected java.lang.String canonicalizeDataAttributeForSql(java.lang.String dataAttribute)

Canonicalize the data-layer attribute column with the given name via SQL function. This is as opposed to canonicalizing query attributes or application attributes passed into or mapped out of the data layer. Canonicalization of a data-layer column should only be necessary if the data layer if you require case-insensitive searching on a mixed-case column in a case-sensitive data layer. Careful, though, as this can result in table scanning if the data layer does not support function-based indices.

Parameters:

dataAttribute - Name of the data attribute column

Returns:

Canonicalized data attribute column name

getPeopleForQuery

protected java.util.List<IPersonAttributes> getPeopleForQuery(org.apereo.services.persondir.support.jdbc.PartialWhereClause queryBuilder,
                                                              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<org.apereo.services.persondir.support.jdbc.PartialWhereClause>

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.

getCaseInsensitiveDataAttributes

public java.util.Map<java.lang.String,CaseCanonicalizationMode> getCaseInsensitiveDataAttributes()

setCaseInsensitiveDataAttributes

public void setCaseInsensitiveDataAttributes(java.util.Map<java.lang.String,CaseCanonicalizationMode> caseInsensitiveDataAttributes)

setCaseInsensitiveDataAttributesAsCollection

public void setCaseInsensitiveDataAttributesAsCollection(java.util.Collection<java.lang.String> caseInsensitiveDataAttributes)

setDataAttributeCaseCanonicalizationFunctions

public void setDataAttributeCaseCanonicalizationFunctions(java.util.Map<CaseCanonicalizationMode,java.text.MessageFormat> dataAttributeCaseCanonicalizationFunctions)

Assign MessageFormats describing how to wrap a JDBC/SQL column reference in a function corresponding to a given CaseCanonicalizationMode. For example, a typical mapping for CaseCanonicalizationMode.LOWER would be "lower({0})". The defaults are just what you'd expect ("lower({0})" and "upper({0})").

Setting null or an empty map has the effect of never wrapping any columns in canonicalizing functions, even if they are referenced by setCaseInsensitiveDataAttributes(java.util.Map).

Parameters:

dataAttributeCaseCanonicalizationFunctions - Map of Canonicalization Mode to Message Formatters

getDataAttributeCaseCanonicalizationFunctions

public java.util.Map<CaseCanonicalizationMode,java.text.MessageFormat> getDataAttributeCaseCanonicalizationFunctions()