org.apereo.services.persondir.support

Class SimpleUsernameAttributeProvider

java.lang.Object

org.apereo.services.persondir.support.SimpleUsernameAttributeProvider

All Implemented Interfaces:

IUsernameAttributeProvider

public class SimpleUsernameAttributeProvider
extends java.lang.Object
implements IUsernameAttributeProvider

Provides the username attribute based on a pre-configured string. Determines the username from a query Map based on the configured attribute, StringUtils.trimToNull(String), and if the username value does not contain a wildcard.

Author:

Eric Dalquist

Constructor Summary

Constructors

Constructor and Description
SimpleUsernameAttributeProvider()
SimpleUsernameAttributeProvider(java.lang.String usernameAttribute)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getUsernameAttribute()
java.lang.String	getUsernameFromQuery(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> query)
void	setUsernameAttribute(java.lang.String usernameAttribute) The usernameAttribute to use .

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleUsernameAttributeProvider

public SimpleUsernameAttributeProvider()

SimpleUsernameAttributeProvider

public SimpleUsernameAttributeProvider(java.lang.String usernameAttribute)

Method Detail

setUsernameAttribute

public void setUsernameAttribute(java.lang.String usernameAttribute)

The usernameAttribute to use .

Parameters:

usernameAttribute - name of the username attribute

getUsernameAttribute

public java.lang.String getUsernameAttribute()

Specified by:

getUsernameAttribute in interface IUsernameAttributeProvider

Returns:

The username attribute to use when one is not otherwise provided, will never return null.

getUsernameFromQuery

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

Specified by:

getUsernameFromQuery in interface IUsernameAttributeProvider

Parameters:

query - The query map of attributes

Returns:

The username included in the query, determined using the username attribute. Returns null if no username attribute is included in the query.